|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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
This is the framework multi panel base class. It is abstract, therefore it must be subclassed and have the required methods implemented in order to be useful.
Field Summary | |
protected WcmController |
controller
A controller class that registers ui modules and handles events. |
protected WcmUiModule |
currentModule
The ui module of the currently selected panel. |
protected WcmPanel |
currentPanel
The current panel. |
protected int |
currentPanelNumber
The panel number of the currenly selected panel. |
protected java.util.List |
panelList
A list that contains all panels added to the WcmMultiPanelModule module. |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmMultiPanelModule()
|
Method Summary | |
int |
addPanel(java.lang.Class moduleClass,
WcmString wsTitle)
Adds a new module to the container. |
int |
addPanel(WcmPanel panel)
Adds a new panel to the WcmMultiPanelModule. |
int |
addPanel(WcmUiModule module,
WcmString wsTitle)
Adds a new module to the container. |
int |
addPanel(WcmUiModule module,
WcmString wsTitle,
WcmString wsToolTip)
Adds a new module to the container. |
protected abstract void |
addPanelSelectionAnchor(int panelNumber)
Implements to construct any panel selection anchors needed to select panels. |
WcmUiModule |
getCurrentModule()
Returns the currently selected ui module. |
WcmPanel |
getCurrentPanel()
Returns the currently selected panel. |
java.lang.String |
getFormName()
Returns the value of the formName of the currently selected panel. |
WcmUiModule |
getModule(int panelNumber)
Returns the ui module by panel number. |
WcmString |
getMultiPanelModuleTitle()
Gets the panel title. |
java.lang.String |
getMultiPanelModuleTitleString()
Gets the panel title. |
WcmPanel |
getPanel(int panelNumber)
Returns a panel by panel number. |
void |
initialize()
Initializes the WcmMultiPanelModule by setting the current panel and the current panel module. |
void |
onExit(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Handles the onExit event. |
void |
onSelectPanel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event the occurs when user clicks on a panel switch link. |
void |
render(java.io.Writer w)
Renders the WcmMultiPanelModule HTML. |
void |
selectPanel(int panelNumber)
Does the work of onSelectTab. |
void |
selectPanel(int panelNumber,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Does the work of onSelectTab. |
protected abstract void |
setCurrentPanelSelection(int panelNumber)
Implements the behavior of the panel selection anchors. |
void |
setMultiPanelModuleTitle(java.lang.String mainTitle)
|
void |
setMultiPanelModuleTitle(WcmString mainTitle)
Sets the panel title. |
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.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, 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, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
protected WcmUiModule currentModule
protected WcmPanel currentPanel
protected int currentPanelNumber
protected java.util.List panelList
protected WcmController controller
Constructor Detail |
public WcmMultiPanelModule()
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
- All Exceptionspublic WcmPanel getPanel(int panelNumber) throws java.lang.Exception
panelNumber
- The panel number being used to get the panel.
java.lang.Exception
- All Exceptionspublic int addPanel(WcmPanel panel) throws java.lang.Exception
panel
- A new panel to add.
java.lang.Exception
- All Exceptionspublic int addPanel(WcmUiModule module, WcmString wsTitle) throws java.lang.Exception
module
- a module to add.wsTitle
- The label for the module that will be displayed in the tab bar.
java.lang.Exception
- All Exceptions.public int addPanel(java.lang.Class moduleClass, WcmString wsTitle) throws java.lang.Exception
moduleClass
- Class object of a module to add.wsTitle
- The label for the module that will be displayed in the tab bar.
java.lang.Exception
- All Exceptions.public int addPanel(WcmUiModule module, WcmString wsTitle, WcmString wsToolTip) throws java.lang.Exception
module
- a module to add.wsTitle
- a label for the module that will be displayed in the tab bar.wsToolTip
- tooltip for the tab label.
java.lang.Exception
- All Exceptions.public WcmUiModule getCurrentModule() throws java.lang.Exception
java.lang.Exception
- All Exceptions.public WcmPanel getCurrentPanel() throws java.lang.Exception
java.lang.Exception
- All Exceptions.public WcmUiModule getModule(int panelNumber) throws java.lang.Exception
panelNumber
- The panel number of the panel.
java.lang.Exception
- All Exceptions.public java.lang.String getFormName()
getFormName
in interface WcmUiModuleInterface
getFormName
in class WcmUiModule
public void selectPanel(int panelNumber, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
panelNumber
- value representing the zero-based index of the panel to select.request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void selectPanel(int panelNumber) throws java.lang.Exception
panelNumber
- Value representing the zero-based index of the panel to select.
java.lang.Exception
- All Exceptions.public void onSelectPanel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest object.response
- HttpServletResponse object.
java.lang.Exception
- All Exceptions.public void setMultiPanelModuleTitle(WcmString mainTitle)
mainTitle
- The title to use as the title of the WcmMultiPanelModule module.public void setMultiPanelModuleTitle(java.lang.String mainTitle)
public WcmString getMultiPanelModuleTitle()
public java.lang.String getMultiPanelModuleTitleString()
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface WcmUiModuleInterface
render
in class WcmUiModule
w
- Writer object to write the output to.
java.lang.Exception
- All errors.protected abstract void addPanelSelectionAnchor(int panelNumber) throws java.lang.Exception
panelNumber
- The panel number of the current panel.
java.lang.Exception
- All errors.protected abstract void setCurrentPanelSelection(int panelNumber) throws java.lang.Exception
panelNumber
- The panel number of the current panel.
java.lang.Exception
- All errors.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |