com.filenet.wcm.toolkit.server.util.ui
Class WcmLayout

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.ui.WcmLayout

public class WcmLayout
extends java.lang.Object

This class is a base implementation of a UI layout.


Field Summary
protected  java.util.Map regionMap
          A Map of all regions in the layout where each region map entry contains a List object that contains the region WcmUiModule modules.
 
Constructor Summary
WcmLayout()
           
 
Method Summary
 void addModule(java.lang.String region, WcmUiModule m)
          Adds a new WcmUiModule object to the layout region.
 java.util.List getModuleList(java.lang.String region)
          Returns the list of all UI modules in the specified region.
 void renderRegion(java.lang.String region, java.io.Writer w)
          Loops through all the modules in a region and calls renderOneRegionItem for each of them.
protected  void renderRegionItem(java.lang.String region, java.io.Writer w, WcmUiModule m)
          Renders the WcmUiModule object in the layout.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

regionMap

protected java.util.Map regionMap
A Map of all regions in the layout where each region map entry contains a List object that contains the region WcmUiModule modules.

Constructor Detail

WcmLayout

public WcmLayout()
Method Detail

addModule

public void addModule(java.lang.String region,
                      WcmUiModule m)
               throws java.lang.Exception
Adds a new WcmUiModule object to the layout region.

Parameters:
region - Region id.
Returns:
m The The WcmUiModule object.
Throws:
java.lang.Exception - when write errors occur.

getModuleList

public java.util.List getModuleList(java.lang.String region)
Returns the list of all UI modules in the specified region.

Parameters:
region - Region id.
Returns:
List The List object that contains the UI modules.

renderRegion

public void renderRegion(java.lang.String region,
                         java.io.Writer w)
                  throws java.lang.Exception
Loops through all the modules in a region and calls renderOneRegionItem for each of them.

Parameters:
region - Region id.
w - Writer object.
Throws:
java.lang.Exception - when write errors occur.

renderRegionItem

protected void renderRegionItem(java.lang.String region,
                                java.io.Writer w,
                                WcmUiModule m)
                         throws java.lang.Exception
Renders the WcmUiModule object in the layout. This call will be a customization point for subclasses. Default implementation calls m.renderJSP(w).

Parameters:
region - Region id
w - Writer object
m - WcmUiModule to render
Throws:
java.lang.Exception - when write errors occur


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.