org.apache.turbine.modules
Class Layout

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Layout

Direct Known Subclasses:

DirectResponseLayout, JspLayout, VelocityDirectLayout, VelocityOnlyLayout, VelocityXslLayout

public abstract class Layout

extends Assembler

This is the base class that defines what a Layout module is.

Version:

$Id: Layout.java,v 1.5 2004/08/02 08:57:32 epugh Exp $

Author:

Dave Bryson, Peter Courcoux

Constructor Summary

Layout()

Method Summary

protected void	build(PipelineData pipelineData) Subclasses can override this method to add additional functionality.
protected void	build(RunData data) Deprecated. Use PipelineData version instead
protected void	doBuild(PipelineData pipelineData) A subclass must override this method to perform itself.
protected abstract void	doBuild(RunData data) 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

Constructor Detail

Layout

public Layout()

Method Detail

doBuild

protected abstract void doBuild(RunData data)
                         throws java.lang.Exception

Deprecated. Use PipelineData version instead

A subclass must override this method to build itself. Subclasses override this method to store the layout in RunData or to write the layout to the output stream referenced in RunData.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

build

protected void build(RunData data)
              throws java.lang.Exception

Deprecated. Use PipelineData version instead

Subclasses can override this method to add additional functionality. This method is protected to force clients to use LayoutLoader to build a Layout.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

doBuild

protected void doBuild(PipelineData pipelineData)
                throws java.lang.Exception

A subclass must override this method to perform itself. The Action can also set the screen that is associated with RunData. Should revert to abstract when RunData is gone.

Throws:

java.lang.Exception - a generic exception.

build

protected void build(PipelineData pipelineData)
              throws java.lang.Exception

Subclasses can override this method to add additional functionality. This method is protected to force clients to use ActionLoader to perform an Action.

Throws:

java.lang.Exception - a generic exception.