|
||||||||||
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.WcmMultiPanelViewModule
com.filenet.wcm.apps.server.ui.info.processors.ProcessorModule
The ProcessorModule is intended to be a base module for ootb step processors. It renders a summary module in the lower left portion of the content area.
Field Summary | |
protected java.util.List |
actionButtons
|
protected boolean |
addContextMenu
|
protected WcmPageBanner |
bannerModule
|
protected boolean |
collapseInstructions
|
protected com.filenet.wcm.apps.server.presentation.ui.ContextMenu |
contextMenu
|
protected boolean |
displayDefaultButtons
|
protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar |
footerLinksBarModule
|
protected WcmFooter |
footerModule
|
protected WcmInstruction |
instructionsModule
|
protected java.lang.String |
instructionsText
|
protected com.filenet.wcm.apps.server.presentation.util.WorkplaceLayout |
layout
|
protected com.filenet.wcm.apps.server.presentation.ui.PathView |
pathModule
|
protected boolean |
renderBannerModule
|
protected boolean |
renderFooterLinksBarModule
|
protected boolean |
renderFooterModule
|
protected boolean |
renderTopTabBarModule
|
protected boolean |
renderTreeView
|
protected WcmSummaryModule |
summaryModule
|
protected WcmLayoutTitleBar |
titleBarModule
|
protected TabsLayoutTitle |
topTabBarModule
|
protected WcmTreeView |
treeModule
|
protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode |
viewsNode
|
protected static com.filenet.wcm.toolkit.util.WcmString |
wsClickApply
|
protected com.filenet.wcm.toolkit.util.WcmString |
wsObjectTypeLabel
|
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule |
modified, MODIFIED_FLAGS_KEY |
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
controller, currentModule, currentPanel, currentPanelNumber, panelList |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
ProcessorModule()
|
Method Summary | |
void |
addActionButton(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor anchor)
Adds a button to the tool bar. |
void |
addActionButton(com.filenet.wcm.toolkit.util.WcmString wsLabel,
java.lang.String iconUrl,
java.lang.String eventName,
java.lang.String requestParams)
Adds a button to the tool bar. |
protected void |
addActionButtons()
|
protected void |
addApplyButton()
|
protected void |
addDefaultButtons()
|
protected void |
addPanelSelectionAnchor(int panelNumber)
|
void |
addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading,
java.lang.String text)
Adds item to the summary bar |
protected void |
addTabBar()
|
protected void |
configureTreeView()
Overwrite this method in your subclass |
boolean |
getDefaultInstructionsMode()
|
com.filenet.wcm.apps.server.presentation.ui.PathView |
getPathView()
|
WcmSummaryModule |
getSummaryModule()
Accessor method to return the WcmSummaryModule object. |
WcmTextLinksBar |
getTextLinksBar()
Accessor method to return the WcmTextLinksBar object. |
void |
initialize()
Initializes the class data |
void |
onCollapse(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when user collapses the instruction module. |
void |
onExpand(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Event that occurs when user expands the instruction module. |
void |
onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
render(java.io.Writer w)
Renders the tab bar, instructions text, path view, toolbar, selected panel and the button bar. |
void |
setAddContextMenu(boolean addContextMenu)
Sets the flag for adding the context menu code at render time |
protected void |
setCurrentPanelSelection(int panelNumber)
|
void |
setDefaultInstructionsMode(boolean collapsed)
Sets the default instruction module mode (collapsed/expanded) |
void |
setDisplayDefaultButtons(boolean on)
Sets if the default buttons will be displayed. |
protected void |
setExitLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
Sets to override the exit link text. |
void |
setInstructionsText(java.lang.String instructions)
|
void |
setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)
|
void |
setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle,
boolean primaryTitle)
|
void |
setPath(java.lang.String pathItemLabel)
Configures contained WcmPathView module to have one non-clickable anchor with the specified label |
void |
setPath(java.lang.String pathItemLabel,
com.filenet.wcm.toolkit.util.WcmString pathTitle,
java.lang.String iconUrl,
java.lang.String url)
Configures contained WcmPathView module to have one non-clickable anchor with the specified label, and the icon. |
void |
setRenderBannerModule(boolean on)
|
void |
setRenderFooterLinksBarModule(boolean on)
|
void |
setRenderFooterModule(boolean on)
|
void |
setRenderTopTabBarModule(boolean on)
|
void |
setRenderTreeView(boolean on)
|
protected void |
setRootNodeLabel(com.filenet.wcm.toolkit.util.WcmString wsLabel)
Sets to override the tree module root node label. |
void |
setTopTabBarLinks(java.lang.String currentTab,
com.filenet.wcm.toolkit.util.WcmString title)
|
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule |
getCurrentViewPanel, isPanelModified, onApply, selectPanel, setPanelModified |
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule |
addPanel, addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onExit, onSelectPanel, 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 static final com.filenet.wcm.toolkit.util.WcmString wsClickApply
protected WcmPageBanner bannerModule
protected WcmLayoutTitleBar titleBarModule
protected TabsLayoutTitle topTabBarModule
protected WcmInstruction instructionsModule
protected com.filenet.wcm.apps.server.presentation.ui.PathView pathModule
protected WcmTreeView treeModule
protected WcmSummaryModule summaryModule
protected WcmFooter footerModule
protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule
protected com.filenet.wcm.apps.server.presentation.ui.ContextMenu contextMenu
protected java.lang.String instructionsText
protected boolean collapseInstructions
protected boolean displayDefaultButtons
protected boolean renderTreeView
protected boolean renderBannerModule
protected boolean renderFooterLinksBarModule
protected boolean renderFooterModule
protected boolean renderTopTabBarModule
protected boolean addContextMenu
protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode viewsNode
protected java.util.List actionButtons
protected com.filenet.wcm.toolkit.util.WcmString wsObjectTypeLabel
protected com.filenet.wcm.apps.server.presentation.util.WorkplaceLayout layout
Constructor Detail |
public ProcessorModule()
Method Detail |
public void initialize() throws java.lang.Exception
java.lang.Exception
- If there were problems.public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void setDefaultInstructionsMode(boolean collapsed)
collapsed
- true if collapsed, false if expandedpublic boolean getDefaultInstructionsMode()
public void setAddContextMenu(boolean addContextMenu)
addContextMenu
- true if renderedpublic void setTopTabBarLinks(java.lang.String currentTab, com.filenet.wcm.toolkit.util.WcmString title) throws java.lang.Exception
java.lang.Exception
public void setDisplayDefaultButtons(boolean on)
on
- boolean flag to display default buttonspublic void addActionButton(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor anchor)
anchor
- WcmAnchor to addpublic void addActionButton(com.filenet.wcm.toolkit.util.WcmString wsLabel, java.lang.String iconUrl, java.lang.String eventName, java.lang.String requestParams) throws java.lang.Exception
wsLabel
- button labeliconUrl
- button icon URLeventName
- eventName for the buttonrequestParams
- additional request parameters
java.lang.Exception
public void addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading, java.lang.String text) throws java.lang.Exception
heading
- WcmString holding summary item labeltext
- String holding summary text
java.lang.Exception
public void setPath(java.lang.String pathItemLabel)
pathItemLabel
- label displayed in the WcmPathView modulepublic void setPath(java.lang.String pathItemLabel, com.filenet.wcm.toolkit.util.WcmString pathTitle, java.lang.String iconUrl, java.lang.String url)
pathItemLabel
- label displayed in the WcmPathView modulepathTitle
- Title displayed in the WcmPathView moduleiconUrl
- icon to be displayed in the WcmPathView moduleurl
- The url for the icon.public void setRenderTreeView(boolean on)
public void setRenderTopTabBarModule(boolean on)
public void setRenderBannerModule(boolean on)
public void setRenderFooterLinksBarModule(boolean on)
public void setRenderFooterModule(boolean on)
public com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()
public void setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)
public void setInstructionsText(java.lang.String instructions)
protected void addPanelSelectionAnchor(int panelNumber) throws java.lang.Exception
java.lang.Exception
protected void setCurrentPanelSelection(int panelNumber)
protected void addActionButtons() throws java.lang.Exception
java.lang.Exception
public void render(java.io.Writer w) throws java.lang.Exception
w
- Writer object
java.lang.Exception
- If any errors occurpublic void onCollapse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
public void onExpand(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
java.lang.Exception
protected void addDefaultButtons() throws java.lang.Exception
java.lang.Exception
protected void addApplyButton() throws java.lang.Exception
java.lang.Exception
protected void setExitLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
wsLinkText
- WcmString The new tree module root node labelprotected void setRootNodeLabel(com.filenet.wcm.toolkit.util.WcmString wsLabel)
wsLabel
- WcmString The new tree module root node labelpublic void setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle, boolean primaryTitle)
protected void addTabBar() throws java.lang.Exception
java.lang.Exception
public WcmTextLinksBar getTextLinksBar()
public WcmSummaryModule getSummaryModule()
protected void configureTreeView() throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |