com.filenet.wcm.apps.server.ui.layout
Class WcmWorkplaceLayoutModule

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.WcmJSPModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmLayoutModule
                          extended bycom.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
AccessRoleSelect, AddApplicationOperation, AddGranteeOperation, BrowseFilePlanOperation, CancelCheckoutOperation, CheckoutListOperation, CheckoutOperation, CompoundDocumentChildrenPage, ConvertForWeb, DeclareRecordsSelectOperation, DeleteContentOperation, DeleteLocalFileOperation, DeleteVersionOperation, DemoteVersionOperation, DownloadContentOperation, ExceptionPage, FileOperation, GranteeSelect, MultiCancelCheckoutOperation, MultiCheckoutOperation, MultiDeleteOperation, MultiDownloadOperation, MultiFileOperation, MultiMailOperation, MultiSelectOperation, MultiSetSecurityPolicyOperation, MultiTransferElementDownloadOperation, OrganizePropertiesOperation, PrefAddPalleteFileOperation, PrefEditAuthorLinkOperation, PrefEditExternalServiceOperation, PrefEditPaletteOperation, PrefGroupPageDesignOperation, PrefGroupPageSettingsOperation, PrefMultiHomePageDesignerOperation, PrefOrganizePagesOperation, PrefOutlookFileTypes, PrefPortalPageLayoutOperation, PrefPortalPagePreviewOperation, PrefPortletAliasOperation, PrefPortletSettingsOperation, PrefRolePropertiesOperation, ProfileCreate, RemoveChildrenOperation, RenameShortcutOperation, RMSelectClassificationOperation, RMSelectStartingClassificationOperation, SelectCategories, SelectChoices, SelectOperation, SendMailOperation, SetPasswordOperation, ShortcutsPage, SubscribedEventSelect, SystemPropertiesFilterOperation, UnfileOperation, UploadStatusOperation, VersionSelect, WcmBatchAction, WcmConfirmOperation, WcmCreateWorkflowOperation, WcmDeleteElementOperation, WcmDeleteSecurityPolicyOperation, WcmDeleteSubscriptionOperation, WcmFieldSelect, WcmLaunchOperation, WcmMultiValueDataInput, WcmMultiValueHierSelect, WcmMultiValueParameterSelect, WcmMultiValueSelect, WcmPromoteVersionOperation, WcmPropertyOperation, WcmRemoveFromWebOperation, WcmSaveOperation, WcmSecurityAccessSelect, WcmSelectClassOperation, WcmSelectEntryOperation, WcmSelectEntryTypeOperation, WcmSelectFileOperation, WcmSelectPolicyOperation, WcmWarningOperation, WcmWorkflowAttachmentSelect, WcmWorkflowFieldSelect, WcmWorkflowPromptOperation, WcmWorkflowTransferOperation

public class WcmWorkplaceLayoutModule
extends com.filenet.wcm.toolkit.server.ui.WcmLayoutModule


Field Summary
protected  WcmPageBanner bannerModule
           
protected  com.filenet.wcm.apps.server.presentation.ui.ContextMenu contextMenu
           
protected  com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar footerLinksBarModule
           
protected  WcmFooter footerModule
           
protected  java.lang.String leftCSSClass
           
static int MAIN_MODE
           
protected  MultiSelectMenu multiSelectMenu
           
static int OPERATION_MODE
           
protected  boolean renderLeftBar
           
protected  boolean showFooterLinksBar
           
protected  com.filenet.wcm.apps.server.presentation.ui.TabBar tabBarModule
           
protected  WcmTreeView treeModule
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
jspMode, layout
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmWorkplaceLayoutModule()
           
 
Method Summary
 void addModule(com.filenet.wcm.toolkit.server.base.WcmUiModule module)
           
 void addModule(com.filenet.wcm.toolkit.server.base.WcmUiModule module, java.lang.String moduleName)
           
static void addPrimaryPageAnchors(com.filenet.wcm.toolkit.server.ui.WcmAnchorList anchorList, com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
           
protected  com.filenet.wcm.toolkit.server.util.ui.WcmLayout createLayout()
           
 com.filenet.wcm.toolkit.server.ui.WcmAnchorTree getAnchorTree()
           
 WcmBannerBar getBannerBar()
           
 WcmFooter getFooter()
           
 com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar getFooterLinksBar()
           
 java.lang.String getOperationTitle()
           
static java.lang.String getPageTabId(java.lang.String url)
           
static java.util.List getPrimaryPageAnchors(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
           
 com.filenet.wcm.apps.server.presentation.ui.TabBar getTabBar()
           
 void initialize()
           
static boolean isAdminLinkAvailable(AccessRoles roles)
          Admin Link is available if the user is belogs to one of these 3 roles: AccessRoles.ROLE_TYPE_AE_ADMINS, AccessRoles.ROLE_TYPE_PW_ADMINISTRATOR, AccessRoles.ROLE_TYPE_PW_CONFIGURATION
protected  void registerAddedModules()
           
protected  void renderLayout(java.io.Writer w)
           
static void resetPrimaryPageAnchors(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
           
 void setAddContextMenu(boolean addContextMenu)
           
 void setMode(int layoutMode)
           
 void setOperationTitle(java.lang.String title)
           
 void setOperationTitle(java.lang.String title, boolean primaryTitle)
           
 void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title)
           
 void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString wsTitle, boolean primaryTitle)
           
protected  void setRemoveTreeModule(boolean removeTreeModule)
           
 void setShowFooterLinksBar(boolean showFooterLinksBar)
           
 void setTabBarSelection(java.lang.String selection)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
getLayout, render, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
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, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive
 
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

MAIN_MODE

public static final int MAIN_MODE
See Also:
Constant Field Values

OPERATION_MODE

public static final int OPERATION_MODE
See Also:
Constant Field Values

footerLinksBarModule

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

treeModule

protected WcmTreeView treeModule

tabBarModule

protected com.filenet.wcm.apps.server.presentation.ui.TabBar tabBarModule

bannerModule

protected WcmPageBanner bannerModule

footerModule

protected WcmFooter footerModule

contextMenu

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

multiSelectMenu

protected MultiSelectMenu multiSelectMenu

renderLeftBar

protected boolean renderLeftBar

leftCSSClass

protected java.lang.String leftCSSClass

showFooterLinksBar

protected boolean showFooterLinksBar
Constructor Detail

WcmWorkplaceLayoutModule

public WcmWorkplaceLayoutModule()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Throws:
java.lang.Exception

registerAddedModules

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

setRemoveTreeModule

protected void setRemoveTreeModule(boolean removeTreeModule)

setMode

public void setMode(int layoutMode)

setAddContextMenu

public void setAddContextMenu(boolean addContextMenu)

setOperationTitle

public void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title)
                       throws java.lang.Exception
Throws:
java.lang.Exception

setOperationTitle

public void setOperationTitle(java.lang.String title)
                       throws java.lang.Exception
Throws:
java.lang.Exception

setOperationTitle

public void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString wsTitle,
                              boolean primaryTitle)
                       throws java.lang.Exception
Throws:
java.lang.Exception

setOperationTitle

public void setOperationTitle(java.lang.String title,
                              boolean primaryTitle)
                       throws java.lang.Exception
Throws:
java.lang.Exception

getOperationTitle

public java.lang.String getOperationTitle()
                                   throws java.lang.Exception
Throws:
java.lang.Exception

addModule

public void addModule(com.filenet.wcm.toolkit.server.base.WcmUiModule module)
               throws java.lang.Exception
Throws:
java.lang.Exception

addModule

public void addModule(com.filenet.wcm.toolkit.server.base.WcmUiModule module,
                      java.lang.String moduleName)
               throws java.lang.Exception
Throws:
java.lang.Exception

setTabBarSelection

public void setTabBarSelection(java.lang.String selection)

getTabBar

public com.filenet.wcm.apps.server.presentation.ui.TabBar getTabBar()

getFooterLinksBar

public com.filenet.wcm.apps.server.presentation.ui.FooterLinksBar getFooterLinksBar()

getBannerBar

public WcmBannerBar getBannerBar()

getAnchorTree

public com.filenet.wcm.toolkit.server.ui.WcmAnchorTree getAnchorTree()

getFooter

public WcmFooter getFooter()

createLayout

protected com.filenet.wcm.toolkit.server.util.ui.WcmLayout createLayout()

renderLayout

protected void renderLayout(java.io.Writer w)
                     throws java.lang.Exception
Throws:
java.lang.Exception

isAdminLinkAvailable

public static boolean isAdminLinkAvailable(AccessRoles roles)
                                    throws java.lang.Exception
Admin Link is available if the user is belogs to one of these 3 roles: AccessRoles.ROLE_TYPE_AE_ADMINS, AccessRoles.ROLE_TYPE_PW_ADMINISTRATOR, AccessRoles.ROLE_TYPE_PW_CONFIGURATION

Parameters:
roles -
Returns:
Throws:
java.lang.Exception

getPageTabId

public static java.lang.String getPageTabId(java.lang.String url)

setShowFooterLinksBar

public void setShowFooterLinksBar(boolean showFooterLinksBar)

resetPrimaryPageAnchors

public static void resetPrimaryPageAnchors(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)

getPrimaryPageAnchors

public static java.util.List getPrimaryPageAnchors(com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
                                            throws java.lang.Exception
Throws:
java.lang.Exception

addPrimaryPageAnchors

public static void addPrimaryPageAnchors(com.filenet.wcm.toolkit.server.ui.WcmAnchorList anchorList,
                                         com.filenet.wcm.toolkit.server.util.WcmDataStore ds)
                                  throws java.lang.Exception
Throws:
java.lang.Exception


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