com.filenet.wcm.apps.server.ui

Class WcmInfoModule

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
com.filenet.wcm.apps.server.ui.WcmInfoModule

All implemented interfaces:

com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Direct known subclasses:

ComponentRelationshipInfo, MultiTransferElementInfo, PrefBootstrapInfo, PrefSiteInfo, PrefUserInfo, StepInfo, WcmLaunchProcessorInfo, WcmMilestoneInfo, WcmObjectInfo, WcmQueueInfo, WcmSelectedObjectInfo, WcmStepProcessorInfo, WcmWorkflowInfo, WcmWorkflowStepInfo

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

Field Summary

Modifier and Type	Field and Description
protected java.util.List	`actionButtons`
protected WcmPageBanner	`bannerModule`
protected boolean	`collapseInstructions`
protected WcmWorkplaceConfig	`config`
protected com.filenet.wcm.toolkit.server.base.WcmController	`controller`
protected boolean	`displayDefaultButtons`
protected com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar	`footerLinksBarModule`
protected WcmFooter	`footerModule`
protected boolean	`HideApplyButton`
protected WcmInstruction	`instructionsModule`
protected java.lang.String	`instructionsText`
protected boolean	`isPrimaryTitle`
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 WcmSitePrefs	`sitePrefs`
protected java.lang.String	`sObjectTypeLabel`
protected WcmTextLinksBar	`textLinksBarModule`
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 static com.filenet.wcm.toolkit.util.WcmString	`wsClickSelectProperties`

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
`currentModule, currentPanel, currentPanelNumber, panelList`

Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`locale, NAME_DELIMITER`

Constructor Summary

Constructor and Description
`WcmInfoModule()`

Method Summary

Modifier and Type	Method and Description
void	`addActionButton(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor oAnchor)` Adds a button to the toolbar.
void	`addActionButton(com.filenet.wcm.toolkit.util.WcmString wsLabel,java.lang.String sIconURL,java.lang.String eventName,java.lang.String requestParams)` Adds a button to the toolbar.
protected void	`addActionButtons()`
protected void	`addApplyButton()`
protected void	`addDefaultButtons()`
protected void	`addFooterModules(com.filenet.wcm.apps.server.presentation.util.WorkplaceLayout layout)`
protected void	`addPanelSelectionAnchor(int panelNumber)`
protected void	`addSelectPropertiesButton()`
protected void	`addTabBar()`
protected void	`configRootViewsNode()`
protected void	`configureTreeView()` Overwrite this method in your subclass.
boolean	`getDefaultInstructionsMode()`
com.filenet.wcm.apps.server.presentation.ui.PathView	`getPathView()`
void	`initialize()` Initializes the class data.
void	`onCollapse(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Triggers an event when a user collapses the instruction module.
void	`onExpand(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Triggers an event when a 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 button bar.
protected void	`setCurrentPanelSelection(int panelNumber)`
void	`setDefaultInstructionsMode(boolean bCollapsed)` Sets the default instruction module mode as collapsed or expanded.
void	`setDisplayDefaultButtons(boolean on)` Sets whether the default buttons are to be displayed.
protected void	`setExitLinkText(com.filenet.wcm.toolkit.util.WcmString wsLinkText)` Sets the exit link text.
void	`setHideApplyButton(boolean on)`
void	`setInstructionsText(java.lang.String instructions)`
void	`setInstructionsText(com.filenet.wcm.toolkit.util.WcmString instructions)`
void	`setMultiPanelModuleTitle(java.lang.String mainTitle,boolean primaryTitle)`
void	`setMultiPanelModuleTitle(com.filenet.wcm.toolkit.util.WcmString mainTitle,boolean primaryTitle)`
void	`setPath(java.lang.String pathItemLabel)` Configures the contained WcmPathView module to have one non-clickable anchor with the specified label
void	`setPath(java.lang.String sPathItemLabel,java.lang.String pathTitle,java.lang.String sIconURL,java.lang.String url)`
void	`setPath(java.lang.String sPathItemLabel,com.filenet.wcm.toolkit.util.WcmString pathTitle,java.lang.String sIconURL,java.lang.String url)` Configures the contained WcmPathView module to have one non-clickable anchor with the specified label and 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 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

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`

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

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`

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

wsClickSelectProperties

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

textLinksBarModule

protected WcmTextLinksBar textLinksBarModule

topTabBarModule

protected TabsLayoutTitle topTabBarModule

instructionsModule

protected WcmInstruction instructionsModule

pathModule

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

treeModule

protected WcmTreeView treeModule

titleBarModule

protected WcmLayoutTitleBar titleBarModule

bannerModule

protected WcmPageBanner bannerModule

footerModule

protected WcmFooter footerModule

footerLinksBarModule

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

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

viewsNode

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

actionButtons

protected java.util.List actionButtons

isPrimaryTitle

protected boolean isPrimaryTitle

sObjectTypeLabel

protected java.lang.String sObjectTypeLabel

HideApplyButton

protected boolean HideApplyButton

layout

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

config

protected WcmWorkplaceConfig config

sitePrefs

protected WcmSitePrefs sitePrefs

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

Constructor Detail

WcmInfoModule

public WcmInfoModule()

Method Detail

initialize

public void initialize()
throws java.lang.Exception

Initializes the class data.

Specified by:

initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface

Overrides:

initialize in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule

Throws:

java.lang.Exception

onStartPage

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

Description copied from class: com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule

Event that is fired for all UI modules before the page is rendered.

Specified by:

onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

onStartPage in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule

Parameters:

request - HttpServletRequest object

response - HttpServletResponse object

Throws:

java.lang.Exception - If any errors occured

setDefaultInstructionsMode

public void setDefaultInstructionsMode( boolean bCollapsed)

Sets the default instruction module mode as collapsed or expanded.

Parameters:

bCollapsed - true if collapsed, false if expanded

getDefaultInstructionsMode

public boolean getDefaultInstructionsMode( )

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 whether the default buttons are to be displayed. Currently, the Exit button is the only default button.

Parameters:

on - boolean flag to display default buttons

addActionButton

public void addActionButton(com.filenet.wcm.toolkit.server.util.ui.WcmAnchor oAnchor)

Adds a button to the toolbar.

Parameters:

oAnchor - WcmAnchor to add

addActionButton

public void addActionButton(com.filenet.wcm.toolkit.util.WcmString wsLabel,
java.lang.String sIconURL,
java.lang.String eventName,
java.lang.String requestParams)
throws java.lang.Exception

Adds a button to the toolbar.

Parameters:

wsLabel - button label

sIconURL - button icon URL

eventName - eventName for the button

requestParams - additional request parameters

Throws:

java.lang.Exception

setPath

public void setPath(java.lang.String pathItemLabel)

Configures the 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 sPathItemLabel,
com.filenet.wcm.toolkit.util.WcmString pathTitle,
java.lang.String sIconURL,
java.lang.String url)

Configures the contained WcmPathView module to have one non-clickable anchor with the specified label and icon.

Parameters:

sPathItemLabel - label displayed in the WcmPathView module

pathTitle - Title displayed in the WcmPathView module

sIconURL - icon to be displayed in the WcmPathView module

url - The URL for the icon.

setPath

public void setPath(java.lang.String sPathItemLabel,
java.lang.String pathTitle,
java.lang.String sIconURL,
java.lang.String url)

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

Description copied from class: com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule

Implements to construct any panel selection anchors needed to select panels.

Specified by:

addPanelSelectionAnchor in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule

Parameters:

panelNumber - The panel number of the current panel.

Throws:

java.lang.Exception - All errors.

setCurrentPanelSelection

protected void setCurrentPanelSelection( int panelNumber)

Description copied from class: com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule

Implements the behavior of the panel selection anchors.

Specified by:

setCurrentPanelSelection in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule

Parameters:

panelNumber - The panel number of the current panel.

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 button bar.

Specified by:

render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

render in class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule

Parameters:

w - Writer object

Throws:

java.lang.Exception

addFooterModules

protected void addFooterModules( com.filenet.wcm.apps.server.presentation.util.WorkplaceLayout layout)
throws java.lang.Exception

Throws:

java.lang.Exception

onCollapse

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

Triggers an event when a 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

Triggers an event when a 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

addSelectPropertiesButton

protected void addSelectPropertiesButton( )
throws java.lang.Exception

Throws:

java.lang.Exception

setExitLinkText

protected void setExitLinkText( com.filenet.wcm.toolkit.util.WcmString wsLinkText)

Sets 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 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( java.lang.String mainTitle,
boolean primaryTitle)

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

configureTreeView

protected void configureTreeView( )
throws java.lang.Exception

Overwrite this method in your subclass.

Throws:

java.lang.Exception

setHideApplyButton

public void setHideApplyButton( boolean on)
throws java.lang.Exception

Throws:

java.lang.Exception

configRootViewsNode

protected void configRootViewsNode( )