org.apache.turbine.modules
Class Screen

java.lang.Object
  |
  +--org.apache.turbine.modules.Assembler
        |
        +--org.apache.turbine.modules.Screen
Direct Known Subclasses:
Error, InvalidState, RawScreen, TemplateScreen

public abstract class Screen
extends Assembler

This is an interface that defines the Screen modules.

Version:
$Id: Screen.java,v 1.1.1.1 2001/08/16 05:08:30 jvanzyl Exp $
Author:
Dave Bryson

Field Summary
private static org.apache.ecs.filter.CharacterFilter filter
           
private static org.apache.ecs.filter.CharacterFilter minFilter
           
 
Constructor Summary
Screen()
           
 
Method Summary
protected  org.apache.ecs.ConcreteElement build(RunData data)
          Subclasses can override this method to add additional functionality.
protected abstract  org.apache.ecs.ConcreteElement doBuild(RunData data)
          A subclass must override this method to build itself.
 java.lang.String getLayout(RunData data)
          If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout".
private static org.apache.ecs.filter.CharacterFilter htmlFilter()
          These attributes are supposed to be the default, but they are not, at least in ECS 1.2.
private static org.apache.ecs.filter.CharacterFilter htmlMinFilter()
           
static java.lang.String prepareText(java.lang.String s)
          This function can/should be used in any screen that will output User entered text.
static java.lang.String prepareTextMinimum(java.lang.String s)
          This function can/should be used in any screen that will output User entered text.
 void setLayout(RunData data, java.lang.String layout)
          Set the layout for a Screen.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

filter

private static final org.apache.ecs.filter.CharacterFilter filter

minFilter

private static final org.apache.ecs.filter.CharacterFilter minFilter
Constructor Detail

Screen

public Screen()
Method Detail

doBuild

protected abstract org.apache.ecs.ConcreteElement doBuild(RunData data)
                                                   throws java.lang.Exception
A subclass must override this method to build itself. Subclasses override this method to store the screen in RunData or to write the screen to the output stream referenced in RunData.
Parameters:
data - Turbine information.
Throws:
java.lang.Exception - a generic exception.

build

protected org.apache.ecs.ConcreteElement build(RunData data)
                                        throws java.lang.Exception
Subclasses can override this method to add additional functionality. This method is protected to force clients to use ScreenLoader to build a Screen.
Parameters:
data - Turbine information.
Throws:
java.lang.Exception - a generic exception.

getLayout

public java.lang.String getLayout(RunData data)
If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout". The Screen object can also override this method to provide intelligent determination of the Layout to execute. You can also define that logic here as well if you want it to apply on a global scale. For example, if you wanted to allow someone to define Layout "preferences" where they could dynamicially change the Layout for the entire site. The information for the request is passed in with the RunData object.
Parameters:
data - Turbine information.
Returns:
A String with the Layout.

setLayout

public void setLayout(RunData data,
                      java.lang.String layout)
Set the layout for a Screen.
Parameters:
data - Turbine information.
layout - The layout name.

prepareText

public static java.lang.String prepareText(java.lang.String s)
This function can/should be used in any screen that will output User entered text. This will help prevent users from entering html (