com.filenet.wcm.apps.server.ui.info.processors
Class ProcessorModule

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.WcmMultiPanelModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
                          extended bycom.filenet.wcm.apps.server.ui.info.processors.ProcessorModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
LaunchApprovalInfo, StepApprovalInfo

public class ProcessorModule
extends com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule

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

wsClickApply

protected static final com.filenet.wcm.toolkit.util.WcmString wsClickApply

bannerModule

protected WcmPageBanner bannerModule

titleBarModule

protected WcmLayoutTitleBar titleBarModule

topTabBarModule

protected TabsLayoutTitle topTabBarModule

instructionsModule

protected WcmInstruction instructionsModule

pathModule

protected com.filenet.wcm.apps.server.presentation.ui.PathView pathModule

treeModule

protected WcmTreeView treeModule

summaryModule

protected WcmSummaryModule summaryModule

footerModule

protected WcmFooter footerModule

footerLinksBarModule

protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule

contextMenu

protected com.filenet.wcm.apps.server.presentation.ui.ContextMenu contextMenu

instructionsText

protected java.lang.String instructionsText

collapseInstructions

protected boolean collapseInstructions

displayDefaultButtons

protected boolean displayDefaultButtons

renderTreeView

protected boolean renderTreeView

renderBannerModule

protected boolean renderBannerModule

renderFooterLinksBarModule

protected boolean renderFooterLinksBarModule

renderFooterModule

protected boolean renderFooterModule

renderTopTabBarModule

protected boolean renderTopTabBarModule

addContextMenu

protected boolean addContextMenu

viewsNode

protected com.filenet.wcm.toolkit.server.util.ui.WcmTreeNode viewsNode

actionButtons

protected java.util.List actionButtons

wsObjectTypeLabel

protected com.filenet.wcm.toolkit.util.WcmString wsObjectTypeLabel

layout

protected com.filenet.wcm.apps.server.presentation.util.WorkplaceLayout layout
Constructor Detail

ProcessorModule

public ProcessorModule()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data

Throws:
java.lang.Exception - If there were problems.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Throws:
java.lang.Exception

setDefaultInstructionsMode

public void setDefaultInstructionsMode(boolean collapsed)
Sets the default instruction module mode (collapsed/expanded)

Parameters:
collapsed - true if collapsed, false if expanded

getDefaultInstructionsMode

public boolean getDefaultInstructionsMode()

setAddContextMenu

public void setAddContextMenu(boolean addContextMenu)
Sets the flag for adding the context menu code at render time

Parameters:
addContextMenu - true if rendered

setTopTabBarLinks

public void setTopTabBarLinks(java.lang.String currentTab,
                              com.filenet.wcm.toolkit.util.WcmString title)
                       throws java.lang.Exception
Throws:
java.lang.Exception

setDisplayDefaultButtons

public void setDisplayDefaultButtons(boolean on)
Sets if the default buttons will be displayed. Currently it only includes "Exit" button.

Parameters:
on - boolean flag to display default buttons

addActionButton

public void addActionButton(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor anchor)
Adds a button to the tool bar.

Parameters:
anchor - WcmAnchor to add

addActionButton

public 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
Adds a button to the tool bar.

Parameters:
wsLabel - button label
iconUrl - button icon URL
eventName - eventName for the button
requestParams - additional request parameters
Throws:
java.lang.Exception

addSummaryItem

public void addSummaryItem(com.filenet.wcm.toolkit.util.WcmString heading,
                           java.lang.String text)
                    throws java.lang.Exception
Adds item to the summary bar

Parameters:
heading - WcmString holding summary item label
text - String holding summary text
Throws:
java.lang.Exception

setPath

public void setPath(java.lang.String pathItemLabel)
Configures contained WcmPathView module to have one non-clickable anchor with the specified label

Parameters:
pathItemLabel - label displayed in the WcmPathView module

setPath

public 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.

Parameters:
pathItemLabel - label displayed in the WcmPathView module
pathTitle - Title displayed in the WcmPathView module
iconUrl - icon to be displayed in the WcmPathView module
url - The url for the icon.

setRenderTreeView

public void setRenderTreeView(boolean on)

setRenderTopTabBarModule

public void setRenderTopTabBarModule(boolean on)

setRenderBannerModule

public void setRenderBannerModule(boolean on)

setRenderFooterLinksBarModule

public void setRenderFooterLinksBarModule(boolean on)

setRenderFooterModule

public void setRenderFooterModule(boolean on)

getPathView

public com.filenet.wcm.apps.server.presentation.ui.PathView getPathView()

setInstructionsText

public void setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)

setInstructionsText

public void setInstructionsText(java.lang.String instructions)

addPanelSelectionAnchor

protected void addPanelSelectionAnchor(int panelNumber)
                                throws java.lang.Exception
Throws:
java.lang.Exception

setCurrentPanelSelection

protected void setCurrentPanelSelection(int panelNumber)

addActionButtons

protected void addActionButtons()
                         throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the tab bar, instructions text, path view, toolbar, selected panel and the button bar.

Parameters:
w - Writer object
Throws:
java.lang.Exception - If any errors occur

onCollapse

public void onCollapse(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Event that occurs when user collapses the instruction module.

Throws:
java.lang.Exception

onExpand

public void onExpand(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event that occurs when user expands the instruction module.

Throws:
java.lang.Exception

addDefaultButtons

protected void addDefaultButtons()
                          throws java.lang.Exception
Throws:
java.lang.Exception

addApplyButton

protected void addApplyButton()
                       throws java.lang.Exception
Throws:
java.lang.Exception

setExitLinkText

protected void setExitLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)
Sets to override the exit link text. The default value is Exit.

Parameters:
wsLinkText - WcmString The new tree module root node label

setRootNodeLabel

protected void setRootNodeLabel(com.filenet.wcm.toolkit.util.WcmString wsLabel)
Sets to override the tree module root node label. The default value is Information.

Parameters:
wsLabel - WcmString The new tree module root node label

setMultiPanelModuleTitle

public void setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle,
                                     boolean primaryTitle)

addTabBar

protected void addTabBar()
                  throws java.lang.Exception
Throws:
java.lang.Exception

getTextLinksBar

public WcmTextLinksBar getTextLinksBar()
Accessor method to return the WcmTextLinksBar object.

Returns:
WcmTextLinksBar object.

getSummaryModule

public WcmSummaryModule getSummaryModule()
Accessor method to return the WcmSummaryModule object.

Returns:
WcmSummaryModule object.

configureTreeView

protected void configureTreeView()
                          throws java.lang.Exception
Overwrite this method in your subclass

Throws:
java.lang.Exception


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