com.filenet.wcm.toolkit.server.ui
Class WcmLayoutModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmJSPModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmLayoutModule
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface

public abstract class WcmLayoutModule
extends WcmJSPModule

The WcmLayoutModule abstract class can be subclassed to create a layout UI module.


Field Summary
protected  boolean jspMode
          Boolean that indicates whether Java™Server Pages (JSP) mode rendering is in use.
protected  WcmLayout layout
          WcmLayout class instance being used by this UI layout module.
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmLayoutModule()
           
 
Method Summary
protected abstract  WcmLayout createLayout()
          A layout UI module can be created by subclassing the abstract class, WcmLayoutModule, and using the createLayout() method to construct the layout.
 WcmLayout getLayout()
          Returns the WCMLayout object that was created for this UI module.
 void render(java.io.Writer w)
          The default render method.
protected abstract  void renderLayout(java.io.Writer w)
          When JSP mode rendering is not in use, this method calls renderRegion for each of the region cells in the layout (typically table cells).
 void setJSP(java.lang.String jspModule)
          Captures whether or not JSP is specified, and sets the JSP file that will be used by the render() method.
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
onStartPage, subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
onStartPage
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, initialize, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

layout

protected WcmLayout layout
WcmLayout class instance being used by this UI layout module.


jspMode

protected boolean jspMode
Boolean that indicates whether Java™Server Pages (JSP) mode rendering is in use.

Constructor Detail

WcmLayoutModule

public WcmLayoutModule()
Method Detail

createLayout

protected abstract WcmLayout createLayout()
A layout UI module can be created by subclassing the abstract class, WcmLayoutModule, and using the createLayout() method to construct the layout.


setJSP

public void setJSP(java.lang.String jspModule)
Captures whether or not JSP is specified, and sets the JSP file that will be used by the render() method.

Specified by:
setJSP in interface WcmUiModuleInterface
Overrides:
setJSP in class WcmUiModule
Parameters:
jspModule - String

getLayout

public WcmLayout getLayout()
Returns the WCMLayout object that was created for this UI module.

Returns:
A WcmLayout object.

renderLayout

protected abstract void renderLayout(java.io.Writer w)
                              throws java.lang.Exception
When JSP mode rendering is not in use, this method calls renderRegion for each of the region cells in the layout (typically table cells).

Parameters:
w - Writer object
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
The default render method. Determines whether JSP mode rendering is in use and if so, calls the parent render method, otherwise, calls renderLayout.

Specified by:
render in interface WcmUiModuleInterface
Overrides:
render in class WcmJSPModule
Parameters:
w - Writer object
Throws:
java.lang.Exception


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