simple.template.layout
Interface Layout

All Known Implementing Classes:
PlainLayout, TileLayout

public interface Layout

The Layout object is used to perform a layout given a specific target path. The layout is typically performed based on some configuration information that the instance can load on initialization. Such information could be an XML file or even a simple Java properties file. The type and means for configuration is left to the developer to decide.

A simple example of a possible layout configuration scheme would be to use a Java properties file to reference templates that could be insterted into the specified target template. So if the specified target named "index.vm" was referenced, then the Java properties file "index.vm.properties" could contain name path pairs which could be used to insert other documents into the original target. In this the referenced template provides the layout for the inserted template documents.

Author:
Niall Gallagher

Method Summary
 Panel getPanel(java.lang.String name, java.lang.Object data, boolean share)
          This method will retreive a Panel object that implements the layout for the specified target.
 

Method Detail

getPanel

Panel getPanel(java.lang.String name,
               java.lang.Object data,
               boolean share)
               throws java.lang.Exception
This method will retreive a Panel object that implements the layout for the specified target. This document will typically contain other documents referenced within a configuration file. The configuration scheme is independant, and is left for the developer to decide.

Parameters:
name - this is the target template or layout to use
data - this is the data source used by the template
share - should the data be inherited or unmodified
Throws:
java.lang.Exception