org.apache.turbine.modules

## Class Layout

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

- Direct Known Subclasses:
    DirectResponseLayout, JspLayout, VelocityCachedLayout, 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 1706239 2015-10-01 13:18:35Z tv $
  Author:
    Dave Bryson, Peter Courcoux

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `CACHE_SIZE_DEFAULT` The default size for the layout cache
    `static String` | `CACHE_SIZE_KEY` Property for the size of the layout cache if caching is on
    `static String` | `NAME` Represents Layout Objects
    `static String` | `PREFIX` Prefix for layout related classes and templates

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Layout()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `build(PipelineData pipelineData)` Subclasses can override this method to add additional functionality.
    `protected abstract void` | `doBuild(PipelineData pipelineData)` A subclass must override this method to perform itself.
    `String` | `getPrefix()` Abstract method to provide the prefix for module related classes and templates

    - ### 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 layout 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 layout 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 layout cache
      See Also:
        Constant Field Values

    - #### NAME

          public static final String NAME

      Represents Layout Objects
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### Layout

          public Layout()

  - ### 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 abstract void doBuild(PipelineData pipelineData)
                                   throws Exception

      A subclass must override this method to perform itself. The Action can also set the screen that is associated with PipelineData.
      Parameters:
        `pipelineData` - Turbine information.
      Throws:
        `Exception` - a generic exception.

    - #### build

          protected void build(PipelineData pipelineData)
                        throws Exception

      Subclasses can override this method to add additional functionality. This method is protected to force clients to use ActionLoader to perform an Action.
      Parameters:
        `pipelineData` - Turbine information.
      Throws:
        `Exception` - a generic exception.

Copyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.