|
||||||||||
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
org.apache.turbine.modules.screens.TemplateScreen
public abstract class TemplateScreen
Template Screen. Base Template Screens should extend this class and override the buildTemplate() method. Users of the particular service can then override the doBuildTemplate() for any specific pre-processing. You can also override the doBuild() method in order to add extra functionality to your system, but you need to make sure to at least duplicate the existing functionality in order for things to work. Look at the code for the doBuild() method to get an idea of what is going on there (it is quite simple really).
Field Summary | |
---|---|
protected org.apache.commons.logging.Log |
log
Logging |
Fields inherited from class org.apache.turbine.modules.Screen |
---|
CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX |
Constructor Summary | |
---|---|
TemplateScreen()
Default constructor |
Method Summary | |
---|---|
org.apache.ecs.ConcreteElement |
buildTemplate(PipelineData pipelineData)
This method should be implemented by Base template classes. |
abstract org.apache.ecs.ConcreteElement |
buildTemplate(RunData data)
Deprecated. Use PipelineData version instead. |
protected org.apache.ecs.ConcreteElement |
doBuild(PipelineData pipelineData)
This method is called by the Screenloader to construct the Screen. |
protected org.apache.ecs.ConcreteElement |
doBuild(RunData data)
Deprecated. Use PipelineData version instead. |
protected void |
doBuildTemplate(PipelineData pipelineData)
This method should be overidden by subclasses that wish to add specific business logic. |
protected abstract void |
doBuildTemplate(RunData data)
Deprecated. Use PipelineData version instead. |
protected void |
doPostBuildTemplate(PipelineData pipelineData)
This method can be overridden to write code that executes when the template has been built (called from a finally clause, so executes regardless of whether an exception is thrown or not) |
protected void |
doPostBuildTemplate(RunData data)
Deprecated. Use PipelineData version instead. |
void |
doRedirect(PipelineData pipelineData,
String template)
You can call this within a Screen to cause an internal redirect to happen. |
void |
doRedirect(PipelineData pipelineData,
String screen,
String template)
You can call this within a Screen to cause an internal redirect to happen. |
void |
doRedirect(RunData data,
String template)
Deprecated. Use PipelineData version instead. |
void |
doRedirect(RunData data,
String screen,
String template)
Deprecated. Use PipelineData version instead. |
static void |
setTemplate(PipelineData pipelineData,
String template)
This method is used when you want to short circuit a Screen and change the template that will be executed next. |
static void |
setTemplate(RunData data,
String template)
Deprecated. Use PipelineData version instead. |
Methods inherited from class org.apache.turbine.modules.Screen |
---|
build, build, getLayout, getLayout, getPrefix, prepareText, prepareTextMinimum, setLayout, setLayout |
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 |
---|
protected org.apache.commons.logging.Log log
Constructor Detail |
---|
public TemplateScreen()
Method Detail |
---|
protected abstract void doBuildTemplate(RunData data) throws Exception
data
- Turbine information.
Exception
- A generic exception.protected void doBuildTemplate(PipelineData pipelineData) throws Exception
data
- Turbine information.
Exception
- A generic exception.public abstract org.apache.ecs.ConcreteElement buildTemplate(RunData data) throws Exception
data
- Turbine information.
Exception
- A generic exception.public org.apache.ecs.ConcreteElement buildTemplate(PipelineData pipelineData) throws Exception
data
- Turbine information.
Exception
- A generic exception.protected void doPostBuildTemplate(RunData data)
protected void doPostBuildTemplate(PipelineData pipelineData)
protected org.apache.ecs.ConcreteElement doBuild(RunData data) throws Exception
doBuild
in class Screen
data
- Turbine information.
Exception
- A generic exception.protected org.apache.ecs.ConcreteElement doBuild(PipelineData pipelineData) throws Exception
doBuild
in class Screen
data
- Turbine information.
Exception
- A generic exception.public static void setTemplate(RunData data, String template)
data
- Turbine information.template
- The name of the next template.public static void setTemplate(PipelineData pipelineData, String template)
data
- Turbine information.template
- The name of the next template.public void doRedirect(RunData data, String screen, String template) throws Exception
This class is useful if you have a Screen that submits to another Screen and you want it to do error validation before executing the other Screen. If there is an error, you can doRedirect() back to the original Screen.
data
- Turbine information.screen
- Name of screen to redirect to.template
- Name of template.
Exception
- A generic exception.public void doRedirect(PipelineData pipelineData, String screen, String template) throws Exception
This class is useful if you have a Screen that submits to another Screen and you want it to do error validation before executing the other Screen. If there is an error, you can doRedirect() back to the original Screen.
data
- Turbine information.screen
- Name of screen to redirect to.template
- Name of template.
Exception
- A generic exception.public void doRedirect(RunData data, String template) throws Exception
This class is useful if you have a Screen that submits to another Screen and you want it to do error validation before executing the other Screen. If there is an error, you can doRedirect() back to the original Screen.
data
- Turbine information.template
- Name of template.
Exception
- A generic exception.public void doRedirect(PipelineData pipelineData, String template) throws Exception
This class is useful if you have a Screen that submits to another Screen and you want it to do error validation before executing the other Screen. If there is an error, you can doRedirect() back to the original Screen.
data
- Turbine information.template
- Name of template.
Exception
- A generic exception.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |