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

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
All Implemented Interfaces:
WcmModuleInterface, WcmUiModuleInterface
Direct Known Subclasses:
WcmLayoutModule

public class WcmJSPModule
extends WcmUiModule

WcmJSPModule is a UI module that includes a Java™Server Pages (JSP) file for its rendering. A subclass of WcmJSPModule would specify the filename of the JSP to render with. From inside the JSP, you can access the module's object reference, which allows you to access data from your UI module for display.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmJSPModule()
           
 
Method Summary
static java.lang.Object getCurrentModule(javax.servlet.http.HttpServletRequest request)
          Returns the instance of the current module from the request object.
 void render(java.io.Writer w)
          Default render method.
 
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, setJSP
 
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
 

Constructor Detail

WcmJSPModule

public WcmJSPModule()
Method Detail

getCurrentModule

public static java.lang.Object getCurrentModule(javax.servlet.http.HttpServletRequest request)
Returns the instance of the current module from the request object. Use this method from the JSP page.

Parameters:
request - HttpServletRequest object

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Description copied from class: WcmUiModule
Default render method. Outputs the string "empty module".

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


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