org.apache.turbine.modules
Class Screen

java.lang.Object
  extended by org.apache.turbine.modules.Assembler
      extended by org.apache.turbine.modules.Screen
Direct Known Subclasses:
Error, InvalidState, RawScreen, TemplateScreen

public abstract class Screen
extends Assembler

This is the base class which defines the Screen modules.

Version:
$Id: Screen.java 717934 2008-11-15 21:48:47Z tv $
Author:
Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
static int CACHE_SIZE_DEFAULT
          The default size for the screen cache
static String CACHE_SIZE_KEY
          Property for the size of the screen cache if caching is on
static String NAME
          Represents Screen Objects
static String PREFIX
          Prefix for screen related classes and templates
 
Constructor Summary
Screen()
           
 
Method Summary
protected  org.apache.ecs.ConcreteElement build(PipelineData pipelineData)
          Subclasses can override this method to add additional functionality.
protected  org.apache.ecs.ConcreteElement build(RunData data)
          Deprecated. Use PipelineData version instead.
protected  org.apache.ecs.ConcreteElement doBuild(PipelineData pipelineData)
          A subclass must override this method to build itself.
protected abstract  org.apache.ecs.ConcreteElement doBuild(RunData data)
          Deprecated. Use PipelineData version instead.
 String getLayout(PipelineData pipelineData)
          If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout".
 String getLayout(RunData data)
          Deprecated. Use PipelineData version instead.
 String getPrefix()
          Abstract method to provide the prefix for module related classes and templates
static String prepareText(String s)
          Deprecated. Use InputFilterUtils.prepareText(String s)
static String prepareTextMinimum(String s)
          Deprecated. Use InputFilterUtils.prepareTextMinimum(String s)
 void setLayout(PipelineData pipelineData, String layout)
          Set the layout for a Screen.
 void setLayout(RunData data, String layout)
          Deprecated. Use PipelineData version instead.
 
Methods inherited from class org.apache.turbine.modules.Assembler
getRunData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PREFIX

public static final String PREFIX
Prefix for screen related classes and templates

See Also:
Constant Field Values

CACHE_SIZE_KEY

public static final String CACHE_SIZE_KEY
Property for the size of the screen cache if caching is on

See Also:
Constant Field Values

CACHE_SIZE_DEFAULT

public static final int CACHE_SIZE_DEFAULT
The default size for the screen cache

See Also:
Constant Field Values

NAME

public static final String NAME
Represents Screen Objects

See Also:
Constant Field Values
Constructor Detail

Screen

public Screen()
Method Detail

getPrefix

public String getPrefix()
Description copied from class: Assembler
Abstract method to provide the prefix for module related classes and templates

Specified by:
getPrefix in class Assembler
Returns:
the prefix
See Also:
Assembler.getPrefix()

doBuild

protected org.apache.ecs.ConcreteElement doBuild(PipelineData pipelineData)
                                          throws 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. Should revert to abstract when RunData has gone.

Parameters:
data - Turbine information.
Throws:
Exception - a generic exception.

build

protected org.apache.ecs.ConcreteElement build(PipelineData pipelineData)
                                        throws 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:
pipelineData - Turbine information.
Throws:
Exception - a generic exception.

getLayout

public String getLayout(PipelineData pipelineData)
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 dynamically change the Layout for the entire site. The information for the request is passed in with the PipelineData object.

Parameters:
pipelineData - Turbine information.
Returns:
A String with the Layout.

setLayout

public void setLayout(PipelineData pipelineData,
                      String layout)
Set the layout for a Screen.

Parameters:
data - Turbine information.
layout - The layout name.

doBuild

protected abstract org.apache.ecs.ConcreteElement doBuild(RunData data)
                                                   throws Exception
Deprecated. Use PipelineData version instead.

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:
Exception - a generic exception.

build

protected org.apache.ecs.ConcreteElement build(RunData data)
                                        throws Exception
Deprecated. Use PipelineData version instead.

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:
Exception - a generic exception.

getLayout

public String getLayout(RunData data)
Deprecated. Use PipelineData version instead.

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 dynamically 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,
                      String layout)
Deprecated. Use PipelineData version instead.

Set the layout for a Screen.

Parameters:
data - Turbine information.
layout - The layout name.

prepareText

public static String prepareText(String s)
Deprecated. Use InputFilterUtils.prepareText(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 ( SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.