|
||||||||||
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
com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule
com.filenet.wcm.apps.server.ui.WcmWizardModule
The WcmWizardModule class implements the base for all wizards, similarly to the way that the WcmInfoModule class implements the base for all Info bars. Derived classes can make calls to addPanel to have them appear in the wizard.
Nested Class Summary | |
protected static class |
WcmWizardModule.WcmWizardPanel
|
Field Summary | |
protected WcmPageBanner |
bannerModule
|
protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar |
footerLinksBarModule
|
protected WcmFooter |
footerModule
|
protected java.lang.String |
leftCSSClass
|
protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode |
stepNode
|
protected WcmTreeView |
stepTreeModule
|
protected WcmSummaryModule |
summaryModule
|
protected WcmLayoutTitleBar |
titleBarModule
|
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule |
controller, sequenceInit |
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
currentModule, currentPanel, currentPanelNumber, panelList |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmWizardModule()
Constructor creates private fields and calls setName. |
Method Summary | |
int |
addPanel(com.filenet.wcm.toolkit.server.base.WcmUiModule module,
com.filenet.wcm.toolkit.util.WcmString wsTitle,
com.filenet.wcm.toolkit.util.WcmString wsToolTip)
Adds a new module to the container. |
protected void |
addPanelSelectionAnchor(int panelNumber)
|
void |
addSummaryItem(java.lang.String heading,
java.lang.String text)
|
void |
addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading,
java.lang.String text)
|
protected void |
configureSummary()
Writes the actual contents of the status bar. |
protected java.lang.String |
getAnchor(java.lang.String eventName,
java.lang.String sFormName,
int nId)
returns the javascript version of the submitForm tag |
protected java.lang.String |
getAnchor(java.lang.String eventName,
java.lang.String sFormName,
int nId,
int nLinkId)
returns the javascript version of the submitForm tag |
WcmFooter |
getFooter()
Get accessor returns WcmFooter |
WcmPageBanner |
getPageBanner()
Get accessor returns WcmPageBanner |
WcmSummaryModule |
getSummaryModule()
Accessor method to return the WcmSummaryModule object. |
WcmLayoutTitleBar |
getTabBar()
Get accessor returns WcmLayoutTitleBar |
WcmTextLinksBar |
getTextLinksBar()
Accessor method to return the WcmTextLinksBar object. |
void |
initialize()
Initializes the wizard state and registers all pages. |
protected boolean |
isBackEnabled(int nId)
Checks the given page number and decides if the back button should be enabled. |
protected boolean |
isFinishEnabled(int nId)
Checks the given page number and decides if the finish button should be enabled. |
protected boolean |
isNextEnabled(int panelNumber)
Checks the given panel number and decides if the next button should be enabled. |
protected boolean |
isPanelEnabled(int panelNumber,
boolean recursive)
|
protected boolean |
okayToProceed(com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface panel)
Deprecated. |
void |
onSelectPanel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
When user selects a panel, calls wizardSave on the previous page and sets the new page to render. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
The default event, calling WcmController.setHelpContext for the current page. |
void |
render(java.io.Writer w)
|
protected void |
setCancelLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
|
protected void |
setCurrentPanelSelection(int panelNumber)
|
protected void |
setFinishLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
|
protected void |
setIsFinished()
Goes through the pages and sets the isFinished member of WcmPage |
void |
setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle,
boolean primaryTitle)
|
protected void |
setNextLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
|
protected void |
setPreviousLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
|
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelSequenceModule |
cancelAll, onCancel, onFinish, onNext, onPrevious, selectPanel, selectPanel |
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, selectPanel, 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.GlobalEventModule |
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.WcmModuleInterface |
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
protected WcmLayoutTitleBar titleBarModule
protected WcmPageBanner bannerModule
protected WcmFooter footerModule
protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule
protected WcmSummaryModule summaryModule
protected WcmTreeView stepTreeModule
protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode stepNode
protected java.lang.String leftCSSClass
Constructor Detail |
public WcmWizardModule()
Method Detail |
public void initialize() throws java.lang.Exception
java.lang.Exception
public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
protected void setIsFinished() throws java.lang.Exception
java.lang.Exception
public void onSelectPanel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest objectresponse
- HttpServletResponse object
java.lang.Exception
protected boolean isBackEnabled(int nId)
nId
- the panel Id.
protected boolean isNextEnabled(int panelNumber) throws java.lang.Exception
panelNumber
- the panel Id.
java.lang.Exception
protected boolean isFinishEnabled(int nId) throws java.lang.Exception
nId
- the page Id.
java.lang.Exception
protected boolean isPanelEnabled(int panelNumber, boolean recursive) throws java.lang.Exception
java.lang.Exception
protected java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId) throws java.lang.Exception
eventName
- The eventName this Anchor should call.sFormName
- The form that should be submitted by this Anchor.nId
- The Page number that this event refers to.
java.lang.Exception
protected java.lang.String getAnchor(java.lang.String eventName, java.lang.String sFormName, int nId, int nLinkId) throws java.lang.Exception
eventName
- The eventName this Anchor should call.sFormName
- The form that should be submitted by this Anchor.nId
- The Page number that this event refers to.nLinkId
- The page number that this event links to.
java.lang.Exception
protected void addPanelSelectionAnchor(int panelNumber) throws java.lang.Exception
java.lang.Exception
protected void setCurrentPanelSelection(int panelNumber)
public int addPanel(com.filenet.wcm.toolkit.server.base.WcmUiModule module, com.filenet.wcm.toolkit.util.WcmString wsTitle, com.filenet.wcm.toolkit.util.WcmString wsToolTip) throws java.lang.Exception
module
- a module to addwsTitle
- a label for the module that will be displayed in the tab barwsToolTip
- tooltip for the tab label
java.lang.Exception
protected boolean okayToProceed(com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface panel) throws java.lang.Exception
java.lang.Exception
public void setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle, boolean primaryTitle)
protected void configureSummary() throws java.lang.Exception
java.lang.Exception
public void addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading, java.lang.String text) throws java.lang.Exception
java.lang.Exception
public void addSummaryItem(java.lang.String heading, java.lang.String text) throws java.lang.Exception
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
java.lang.Exception
public WcmLayoutTitleBar getTabBar() throws java.lang.Exception
java.lang.Exception
public WcmPageBanner getPageBanner() throws java.lang.Exception
java.lang.Exception
public WcmTextLinksBar getTextLinksBar()
public WcmSummaryModule getSummaryModule()
public WcmFooter getFooter() throws java.lang.Exception
java.lang.Exception
protected void setPreviousLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
protected void setNextLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
protected void setCancelLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
protected void setFinishLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |