com.filenet.wcm.toolkit.server.ui
Class WcmMultiPanelViewModule
java.lang.Object
com.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
- All Implemented Interfaces:
- WcmModuleInterface, WcmUiModuleInterface
- public abstract class WcmMultiPanelViewModule
- extends WcmMultiPanelModule
WcmMultiPanelViewModule acts as a container for one or more UI modules that optionally implement WcmMultiPanelModule
with a way for selecting which module to display.
Method Summary |
WcmViewPanelInterface |
getCurrentViewPanel()
Returns the current view panel when one exists. |
void |
initialize()
Called by WcmController when the module is registered,
and has access to the data store. |
boolean |
isPanelModified(int panel)
Returns the current modified state of the panel. |
void |
onApply(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs the user clicks Apply button. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that is fired for all UI modules before the page is rendered. |
void |
selectPanel(int panelNumber,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Extends the behaviour of WcmMultiPanelModule, and if
the current panel is instance of WcmViewPanelInterface,
calls panelSave method on it. |
void |
setPanelModified(int panel,
boolean value)
Toggles a boolean indicator to track whether the
current panel has been modified. |
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
addPanel, addPanel, addPanel, addPanel, addPanelSelectionAnchor, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, onSelectPanel, render, selectPanel, setCurrentPanelSelection, setMultiPanelModuleTitle, setMultiPanelModuleTitle |
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, 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.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
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.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
MODIFIED_FLAGS_KEY
protected static final java.lang.String MODIFIED_FLAGS_KEY
- See Also:
- Constant Field Values
modified
protected java.util.Map modified
WcmMultiPanelViewModule
public WcmMultiPanelViewModule()
initialize
public void initialize()
throws java.lang.Exception
- Called by WcmController when the module is registered,
and has access to the data store.
- Specified by:
initialize
in interface WcmModuleInterface
- Overrides:
initialize
in class WcmMultiPanelModule
- Throws:
java.lang.Exception
onStartPage
public void onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception
- Event that is fired for all UI modules before the page is rendered.
- Specified by:
onStartPage
in interface WcmUiModuleInterface
- Overrides:
onStartPage
in class GlobalEventModule
- Parameters:
request
- HttpServletRequest objectresponse
- HttpServletResponse object
- Throws:
java.lang.Exception
getCurrentViewPanel
public WcmViewPanelInterface getCurrentViewPanel()
- Returns the current view panel when one exists.
The returned panel is cast as a WcmViewPanelInterface.
- Returns:
- a WcmViewPanelInterface object.
selectPanel
public void selectPanel(int panelNumber,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception
- Extends the behaviour of WcmMultiPanelModule, and if
the current panel is instance of WcmViewPanelInterface,
calls panelSave method on it.
- Overrides:
selectPanel
in class WcmMultiPanelModule
- Parameters:
panelNumber
- Integerrequest
- HttpServletRequest objectresponse
- HttpServletResponse object
- Throws:
java.lang.Exception
- All Exceptions.
onApply
public void onApply(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception
- Event that occurs the user clicks Apply button.
- Parameters:
request
- HttpServletRequest objectresponse
- HttpServletResponse object
- Throws:
java.lang.Exception
setPanelModified
public void setPanelModified(int panel,
boolean value)
- Toggles a boolean indicator to track whether the
current panel has been modified.
- Parameters:
panel
- Integervalue
- Boolean
isPanelModified
public boolean isPanelModified(int panel)
throws java.lang.Exception
- Returns the current modified state of the panel.
- Parameters:
panel
- Integer
- Returns:
- Boolean
- Throws:
java.lang.Exception
© Copyright IBM Corp. 2002, 2007. All Rights Reserved.