org.apache.turbine.modules
Class Layout

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

Direct Known Subclasses:

DefaultLayout, DirectResponseLayout, JspLayout, VelocityDirectLayout, VelocityECSLayout, VelocityOnlyLayout, VelocityXslLayout

public abstract class Layout

extends Assembler

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

Version:

$Id: Layout.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson

Constructor Summary

Layout()

Method Summary

protected void	build(RunData data) Subclasses can override this method to add additional functionality.
protected abstract void	doBuild(RunData data) A subclass must override this method to build itself.

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

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

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.