|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.turbine.modules.Assembler
org.apache.turbine.modules.Screen
public abstract class Screen
This is the base class which defines the Screen modules.
| Field Summary | |
|---|---|
static int |
CACHE_SIZE_DEFAULT
The default size for the screen cache |
static java.lang.String |
CACHE_SIZE_KEY
Property for the size of the screen cache if caching is on |
static java.lang.String |
NAME
Represents Screen Objects |
static java.lang.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. |
java.lang.String |
getLayout(PipelineData pipelineData)
If the Layout has not been defined by the Screen then set the layout to be "DefaultLayout". |
java.lang.String |
getLayout(RunData data)
Deprecated. Use PipelineData version instead. |
java.lang.String |
getPrefix()
Abstract method to provide the prefix for module related classes and templates |
static java.lang.String |
prepareText(java.lang.String s)
Deprecated. Use InputFilterUtils.prepareText(String s) |
static java.lang.String |
prepareTextMinimum(java.lang.String s)
Deprecated. Use InputFilterUtils.prepareTextMinimum(String s) |
void |
setLayout(PipelineData pipelineData,
java.lang.String layout)
Set the layout for a Screen. |
void |
setLayout(RunData data,
java.lang.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 |
|---|
public static final java.lang.String PREFIX
public static final java.lang.String CACHE_SIZE_KEY
public static final int CACHE_SIZE_DEFAULT
public static final java.lang.String NAME
| Constructor Detail |
|---|
public Screen()
| Method Detail |
|---|
public java.lang.String getPrefix()
Assembler
getPrefix in class AssemblerAssembler.getPrefix()
protected org.apache.ecs.ConcreteElement doBuild(PipelineData pipelineData)
throws java.lang.Exception
data - Turbine information.
java.lang.Exception - a generic exception.
protected org.apache.ecs.ConcreteElement build(PipelineData pipelineData)
throws java.lang.Exception
pipelineData - Turbine information.
java.lang.Exception - a generic exception.public java.lang.String getLayout(PipelineData pipelineData)
pipelineData - Turbine information.
public void setLayout(PipelineData pipelineData,
java.lang.String layout)
data - Turbine information.layout - The layout name.
protected abstract org.apache.ecs.ConcreteElement doBuild(RunData data)
throws java.lang.Exception
data - Turbine information.
java.lang.Exception - a generic exception.
protected org.apache.ecs.ConcreteElement build(RunData data)
throws java.lang.Exception
data - Turbine information.
java.lang.Exception - a generic exception.public java.lang.String getLayout(RunData data)
data - Turbine information.
public void setLayout(RunData data,
java.lang.String layout)
data - Turbine information.layout - The layout name.public static java.lang.String prepareText(java.lang.String s)