Package org.eclnt.workplace

Class WorkpageContainer

java.lang.Object
org.eclnt.workplace.WorkpageContainer
All Implemented Interfaces:
Serializable, IWorkpageContainer
public class WorkpageContainer extends Object implements IWorkpageContainer, Serializable
Container managing multiple workpages. Each workpage either is opened in the content area of the workplace or is shown as modeless popup.
See Also:

  • Field Details

    • s_implicitLoadingOfWorkplaceForCurrentUser

      protected static boolean s_implicitLoadingOfWorkplaceForCurrentUser

    • m_this

      protected WorkpageContainer m_this

    • m_owner

      protected WorkpageContainer m_owner

    • m_tileManager

      protected WorkplaceTileManager m_tileManager

    • m_functionsManager

      protected WorkplaceFunctionsManager m_functionsManager

    • m_perspectiveManager

      protected WorkplacePerspectiveManager m_perspectiveManager

    • m_functionSearchUI

      protected WorkplaceFunctionSearchUI m_functionSearchUI

    • m_history

      protected WorkplaceHistory m_history

    • m_subWorkpageContainers

      protected WorkpageContainer.SubWorkpageContainers m_subWorkpageContainers

    • m_ownSubContainerId

      protected String m_ownSubContainerId

    • m_workpageList

      protected List<IWorkpage> m_workpageList

    • m_workpageInfos

      protected Map<IWorkpage,WorkpageContainer.WorkpageInfo> m_workpageInfos

    • m_workpageInfoMap

      protected WorkpageContainer.WorkpageInfoMap m_workpageInfoMap

    • m_currentWorkpage

      protected IWorkpage m_currentWorkpage

    • m_tabbedLine

      protected org.eclnt.jsfserver.elements.impl.TABBEDLINEComponent m_tabbedLine

    • m_tabbedLineIndex

      protected int m_tabbedLineIndex

    • m_previousTabbedLineIndex

      protected int m_previousTabbedLineIndex

    • m_tabbedLineEnabled

      protected boolean m_tabbedLineEnabled

    • m_emptyPage

      protected String m_emptyPage

    • m_workpageDispatcher

      protected IWorkpageDispatcher m_workpageDispatcher

    • m_focusCounter

      protected int m_focusCounter

    • m_maxNumberOfWorkpages

      protected int m_maxNumberOfWorkpages

    • m_maxNumberOfWorkpagesExceededMessage

      protected String m_maxNumberOfWorkpagesExceededMessage

    • m_defaultPopupWidth

      protected int m_defaultPopupWidth

    • m_defaultPopupHeight

      protected int m_defaultPopupHeight

    • m_updateOnInnerEventOnly

      protected boolean m_updateOnInnerEventOnly

    • m_openWorkpagePopupsAsFrame

      protected boolean m_openWorkpagePopupsAsFrame

    • m_showPopupWorkpagesInSelector

      protected boolean m_showPopupWorkpagesInSelector

    • m_cubeAnimationDirection

      protected String m_cubeAnimationDirection

    • m_animationTrigger

      protected Trigger m_animationTrigger

    • m_workpageContainerListeners

      protected Set<IWorkpageContainerListener> m_workpageContainerListeners

    • m_workplacePrepareWasCalled

      protected boolean m_workplacePrepareWasCalled

    • m_withPreparingWorkplaceForCurrentUser

      protected boolean m_withPreparingWorkplaceForCurrentUser

    • m_withTabSelectorCloseIcons

      protected boolean m_withTabSelectorCloseIcons

    • m_workpagePopupDefaultBgpaint

      protected String m_workpagePopupDefaultBgpaint

    • m_hotkeyisolation

      protected boolean m_hotkeyisolation

    • m_withWorkpageDragDrop

      protected boolean m_withWorkpageDragDrop

    • m_rendererClassName

      protected String m_rendererClassName

    • m_renderer

      protected IWorkpageContainerRenderer m_renderer

    • m_uniqueId

      protected String m_uniqueId

    • m_dynMenuContent

      protected DYNAMICCONTENTBinding m_dynMenuContent

    • m_multiWorkplaceManager

      protected WorkpageContainerMultiWorkplaceManager m_multiWorkplaceManager

    • m_workpageSelector

      protected IWorkpageSelector m_workpageSelector

    • m_withCubeRotation

      protected boolean m_withCubeRotation

  • Constructor Details

    • WorkpageContainer

      public WorkpageContainer(IWorkpageDispatcher dispatcher)
      This constructor is used for the main workpage container.

    • WorkpageContainer

      public WorkpageContainer(IWorkpageDispatcher dispatcher, boolean withPreparingWorkplaceForCurrentUser)
      This constructor may be used if you want to switch off the usage of the default workplace management. The default workplace management reads the runtime configuration for the current user and creates a corresponding workplace perspective.

    • WorkpageContainer

      protected WorkpageContainer(IWorkpageDispatcher dispatcher, WorkpageContainer owner, String subContainerId)
      This constructor is used for sub workpage containers.

  • Method Details

    • initialize

      public static void initialize()
      Called as part of CaptainCasa runtime initialization.

    • initImplicitLoadingForCurrentUser

      public static void initImplicitLoadingForCurrentUser(boolean withPreparingWorkplaceForCurrentUser)
      By default the workplace management initializes it's environment on its own, calling function prepareWorkplaceForCurrentUser() automatically. This function expects the user data (interface IUserAccess to be available, so that certain workplace functions (e.g. building up function tree, loading persisted workplace history, ...) that are user-specific use the right user.

      In certain situations you may avoid this automated initialization and explicitly call the function prepareWorkplaceForCurrentUser() on your own. Example: the user comes from some explicit logon screen, which was not yet processed.

      This method is automatically called during the server start-up - using the value that is defined in system.xml. You may re-call any time later and override the value.

    • prepareWorkplaceForCurrentUser

      public void prepareWorkplaceForCurrentUser()
      Central method for loading all workplace related information within the current workplace. This method needs to be called whenever the user changes (e.g. after logon).
      Specified by:
      prepareWorkplaceForCurrentUser in interface IWorkpageContainer

    • getMultiWorkplaceManager

      public WorkpageContainerMultiWorkplaceManager getMultiWorkplaceManager()
      Specified by:
      getMultiWorkplaceManager in interface IWorkpageContainer

    • setRendererClassName

      public void setRendererClassName(String value)
      Description copied from interface: IWorkpageContainer
      The content renderer of the workpage container can be customized by passing the class name of the renderer. The renderer class must either implement IWorkpageContainerRenderer or IWorkpageContainerPartialRenderer.
      Specified by:
      setRendererClassName in interface IWorkpageContainer

    • getRendererClassName

      public String getRendererClassName()
      Specified by:
      getRendererClassName in interface IWorkpageContainer

    • getDynMenuContent

      public DYNAMICCONTENTBinding getDynMenuContent()

    • getRenderer

      public IWorkpageContainerRenderer getRenderer()
      Specified by:
      getRenderer in interface IWorkpageContainer

    • createRenderer

      protected void createRenderer()

    • getNavigationStack

      public Stack<IWorkpage> getNavigationStack()
      Returns:
      The navigation stack of this workpage container. The container might be the top container or a child container. - This is not some "global" navigation stack!

    • getHistory

      public WorkplaceHistory getHistory()
      Description copied from interface: IWorkpageContainer
      The workplace includes some management of the history of its content. This is the method to access the corresponding functions.
      Specified by:
      getHistory in interface IWorkpageContainer

    • setHistory

      public void setHistory(WorkplaceHistory history)

    • getWorkpagePopupDefaultBgpaint

      public String getWorkpagePopupDefaultBgpaint()

    • setWorkpagePopupDefaultBgpaint

      public void setWorkpagePopupDefaultBgpaint(String workpagePopupDefaultBgpaint)
      Description copied from interface: IWorkpageContainer
      Defines the BGPAINT of isolated workpage popups.
      Specified by:
      setWorkpagePopupDefaultBgpaint in interface IWorkpageContainer

    • getHotKeyIsolation

      public boolean getHotKeyIsolation()
      Specified by:
      getHotKeyIsolation in interface IWorkpageContainer

    • setHotKeyIsolation

      public void setHotKeyIsolation(boolean hotkeyisolation)
      Description copied from interface: IWorkpageContainer
      If set to true then the workpage areas are isolated areas for hotkey processing. THis means that the a hotkey is only processed within the workpage in which it was triggered. There is no double-processing of hotkeys because of two workpages being shown in parallel.
      Specified by:
      setHotKeyIsolation in interface IWorkpageContainer

    • getShowPopupWorkpagesInSelector

      public boolean getShowPopupWorkpagesInSelector()

    • setShowPopupWorkpagesInSelector

      public void setShowPopupWorkpagesInSelector(boolean showPopupWorkpagesInSelector)
      Description copied from interface: IWorkpageContainer
      By default workpages that are isolated into an own popup are not shown in the selector. You can override this behavior by passing the value "true".
      Specified by:
      setShowPopupWorkpagesInSelector in interface IWorkpageContainer

    • getWithTabSelectorCloseIcons

      public boolean getWithTabSelectorCloseIcons()

    • setWithTabSelectorCloseIcons

      public void setWithTabSelectorCloseIcons(boolean withTabSelectorCloseIcons)
      Description copied from interface: IWorkpageContainer
      Defines if close icons are rendered into the selector's tab components. Default is "true".
      Specified by:
      setWithTabSelectorCloseIcons in interface IWorkpageContainer

    • getWorkpageDispatcher

      public IWorkpageDispatcher getWorkpageDispatcher()
      Description copied from interface: IWorkpageContainer
      Get the dispatcher that is responsible for managing/keeping the top level objects within the context of this work page.
      Specified by:
      getWorkpageDispatcher in interface IWorkpageContainer

    • getUniqueId

      public String getUniqueId()
      Description copied from interface: IWorkpageContainer
      A workpage container instance is assigned a unique technical id when it is created. This id is stable during the lifecycle of the workpage container. Please pay attention: this is a technical id "only"! The id that is assigned to the workpage container within the workplace setup is available via IWorkpageContainer.getOwnSubContainerId().
      Specified by:
      getUniqueId in interface IWorkpageContainer

    • updateUniqueId

      public void updateUniqueId()

    • addWorkpageContainerListener

      public void addWorkpageContainerListener(IWorkpageContainerListener workpageContainerListener)
      Specified by:
      addWorkpageContainerListener in interface IWorkpageContainer

    • removeWorkpageContainerListener

      public void removeWorkpageContainerListener(IWorkpageContainerListener workpageContainerListner)
      Specified by:
      removeWorkpageContainerListener in interface IWorkpageContainer

    • getWorkpageContainerListeners

      public Set<IWorkpageContainerListener> getWorkpageContainerListeners()

    • getTileManagerWithoutInitialization

      public WorkplaceTileManager getTileManagerWithoutInitialization()

    • getTileManager

      public WorkplaceTileManager getTileManager()
      Description copied from interface: IWorkpageContainer
      Each workplace has one tile manager - a tile being the graphical representation of a workpage container. The tile manager is a funciton on top of the workpage container and separates the screen into tiles, in each of the tiles a workpage container is started. The user may configure the tiles by dragging and dropping content from one tile to the next.
      Specified by:
      getTileManager in interface IWorkpageContainer

    • getFunctionsManagerWithoutInitialization

      public WorkplaceFunctionsManager getFunctionsManagerWithoutInitialization()
      Description copied from interface: IWorkpageContainer
      Each workpage container has one functions manager - managing the function tree(s).
      Specified by:
      getFunctionsManagerWithoutInitialization in interface IWorkpageContainer

    • getFunctionsManager

      public WorkplaceFunctionsManager getFunctionsManager()
      Description copied from interface: IWorkpageContainer
      Each workpage container has one functions manager - managing the function tree(s). The functions manager is intialized before being passed back. Use IWorkpageContainer.getFunctionsManagerWithoutInitialization() to access the instance before initialization.
      Specified by:
      getFunctionsManager in interface IWorkpageContainer

    • getPerspectiveManagerWithoutInitialization

      public WorkplacePerspectiveManager getPerspectiveManagerWithoutInitialization()

    • getPerspectiveManager

      public WorkplacePerspectiveManager getPerspectiveManager()

    • getFunctionSearchUI

      public WorkplaceFunctionSearchUI getFunctionSearchUI()
      Description copied from interface: IWorkpageContainer
      Page bean for searching functions within the current function tree.
      Specified by:
      getFunctionSearchUI in interface IWorkpageContainer

    • getSubWorkpageContainers

      public WorkpageContainer.SubWorkpageContainers getSubWorkpageContainers()

    • getSubContainers

      public Map<String,? extends IWorkpageContainer> getSubContainers()
      Description copied from interface: IWorkpageContainer
      A workplace may have several workpage containers - each of them holding workpages. Internally there is one top workpage container (the own with IWorkpageContainer.getOwnSubContainerId() returning null), which owns sub containers (each of them returning an explicit id/name in IWorkpageContainer.getOwnSubContainerId().
      Specified by:
      getSubContainers in interface IWorkpageContainer

    • getWorkpageSelector

      public IWorkpageSelector getWorkpageSelector()
      Description copied from interface: IWorkpageContainer
      You may create an own implementation of a workpage selector by implementing interface IWorkpageSelector.
      Specified by:
      getWorkpageSelector in interface IWorkpageContainer
      Returns:
      Only returns instance if some owne workpage selector is defined.

    • getOpenWorkpagePopupsAsFrame

      public boolean getOpenWorkpagePopupsAsFrame()
      Specified by:
      getOpenWorkpagePopupsAsFrame in interface IWorkpageContainer

    • setOpenWorkpagePopupsAsFrame

      public void setOpenWorkpagePopupsAsFrame(boolean value)
      Description copied from interface: IWorkpageContainer
      By default isolated workpages are opened as dialog. Dialogs do not appear within the task bar of the operating system - and do not allow to be pushed behind the workplace page. - If passing "true" as parameter then isolated workpages are opened as frame - i.e. they are a fully featured window that appears in the task bar of the operating system as well and that can be pushed into the background by the user.
      Specified by:
      setOpenWorkpagePopupsAsFrame in interface IWorkpageContainer

    • getOwnSubContainerId

      public String getOwnSubContainerId()
      Description copied from interface: IWorkpageContainer
      A workplace may contain several workpage containers. The main workpage container is started with an id of null. All other ones do own some id. The id is either set in the configuration of the workplace or - if the workpage container is created at runtime - is created by the workplace management internally.
      Specified by:
      getOwnSubContainerId in interface IWorkpageContainer

    • getRootWorkpageContainer

      public WorkpageContainer getRootWorkpageContainer()

    • getDefaultPopupWidth

      public int getDefaultPopupWidth()

    • setDefaultPopupWidth

      public void setDefaultPopupWidth(int defaultPopupWidth)
      Defines the width of the popup when isolating a workpage into a window of its own.
      Specified by:
      setDefaultPopupWidth in interface IWorkpageContainer

    • getDefaultPopupHeight

      public int getDefaultPopupHeight()

    • setDefaultPopupHeight

      public void setDefaultPopupHeight(int defaultPopupHeight)
      Defines the height of the popup when isolating a workpage into a window of its own.
      Specified by:
      setDefaultPopupHeight in interface IWorkpageContainer

    • getUpdateOnInnerEventOnly

      public boolean getUpdateOnInnerEventOnly()

    • setUpdateOnInnerEventOnly

      public void setUpdateOnInnerEventOnly(boolean value)
      Description copied from interface: IWorkpageContainer
      If set to true, then a workpage is only updated on an event that is coming from the workpage itself. This corresponds to ROWINCLUDE-UPDATEONINNEREVENTONLY attribute. - Default is "false". You may set to "true" for performance reasons, but need then to handle cases of cross workpage synchronization on your own. Please check documentation of ROWINCLUDE for more information.
      Specified by:
      setUpdateOnInnerEventOnly in interface IWorkpageContainer

    • setEmptyPage

      public void setEmptyPage(String jspPage)
      Description copied from interface: IWorkpageContainer
      The page that is shown when no workpage is available within the workpage container.
      Specified by:
      setEmptyPage in interface IWorkpageContainer

    • getWpim

      public WorkpageContainer.WorkpageInfoMap getWpim()

    • getSubWorkpageContainerForWorkpage

      public IWorkpageContainer getSubWorkpageContainerForWorkpage(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      A workpage container may be separated into sub-workpage containers. This functions returns back the sub workpage container.
      Specified by:
      getSubWorkpageContainerForWorkpage in interface IWorkpageContainer

    • getSubWorkpageContainerIdForWorkpage

      public String getSubWorkpageContainerIdForWorkpage(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      A workpage container may be separated into sub-workpage containers. This functions returns back the id of the sub workpage container. If the workpage is running in the main workpage container, then null is returned.
      Specified by:
      getSubWorkpageContainerIdForWorkpage in interface IWorkpageContainer

    • setMaxNumberOfWorkpages

      public void setMaxNumberOfWorkpages(int maxNumberOfWorkpages)
      Description copied from interface: IWorkpageContainer
      With this method you may restrict the number of parallelly running workpages to a certain limit. If not set then any number of workpages can be opened.
      Specified by:
      setMaxNumberOfWorkpages in interface IWorkpageContainer

    • setMaxNumberOfWorkpagesExceededMessage

      public void setMaxNumberOfWorkpagesExceededMessage(String message)
      Description copied from interface: IWorkpageContainer
      This is the message that is popped up once a user exceeds the limit of "maxNumberOfWorkpages". By default an own message is shown, but you can define your own one using this method.
      Specified by:
      setMaxNumberOfWorkpagesExceededMessage in interface IWorkpageContainer

    • moveIsolatedWorkpageBackIntoContentArea

      public void moveIsolatedWorkpageBackIntoContentArea(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Brings back a workpage that is isolated as modeless popup back into its content area.
      Specified by:
      moveIsolatedWorkpageBackIntoContentArea in interface IWorkpageContainer

    • moveWorkpageIntoContentArea

      public void moveWorkpageIntoContentArea(IWorkpage workpage)
      Take a page from modeless display back into content area.
      Specified by:
      moveWorkpageIntoContentArea in interface IWorkpageContainer

    • moveWorkpageIntoContentAreaLOCAL

      protected void moveWorkpageIntoContentAreaLOCAL(IWorkpage workpage)

    • maximizeWorkpage

      public void maximizeWorkpage(IWorkpage workpage, boolean value)
      Description copied from interface: IWorkpageContainer
      Maximize size of workpage.
      Specified by:
      maximizeWorkpage in interface IWorkpageContainer

    • maximizeWorkpageLOCAL

      protected void maximizeWorkpageLOCAL(IWorkpage workpage, boolean value)

    • getFocusCounter

      public int getFocusCounter()

    • addWorkpageAsPopup

      public ModelessPopup addWorkpageAsPopup(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Adds the new workpage to the workpage container.
      Specified by:
      addWorkpageAsPopup in interface IWorkpageContainer

    • addWorkpageAsPopupLOCAL

      protected ModelessPopup addWorkpageAsPopupLOCAL(IWorkpage workpage)

    • addWorkpageAndKeepInBackground

      public void addWorkpageAndKeepInBackground(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Adds the new workpage to the workpage container. If there is already one existing workpage then the new workpage is not switched to to the front.
      Specified by:
      addWorkpageAndKeepInBackground in interface IWorkpageContainer

    • addWorkpageAndKeepInBackgroundLOCAL

      public void addWorkpageAndKeepInBackgroundLOCAL(IWorkpage workpage)

    • addWorkpage

      public void addWorkpage(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Adds the new workpage to the workpage container.
      Specified by:
      addWorkpage in interface IWorkpageContainer

    • addWorkpageLOCAL

      protected boolean addWorkpageLOCAL(IWorkpage workpage)

    • addWorkpageLOCAL

      protected boolean addWorkpageLOCAL(IWorkpage workpage, boolean withTrigger, boolean withSwitchToForeground)
      Returns:
      true => workpage was added, false => workpage was NOT added

    • getAnimationValue

      public Trigger getAnimationValue()

    • getCubeAnimationValue

      public Trigger getCubeAnimationValue()

    • getCubeAnimationDirection

      public String getCubeAnimationDirection()

    • getCurrentJspPage

      public String getCurrentJspPage()

    • getEmptyPage

      public String getEmptyPage()
      Specified by:
      getEmptyPage in interface IWorkpageContainer

    • getCurrentClientName

      public String getCurrentClientName()

    • getContentReplaceForWorkpage

      public String getContentReplaceForWorkpage(IWorkpage wp)

    • renderWorkpageNode

      public void renderWorkpageNode(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId)

    • renderOutestNode

      protected ROWDYNAMICCONTENTBinding.ComponentNode renderOutestNode(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId)

    • renderROWTITLEBARNodeForWorkpage

      protected void renderROWTITLEBARNodeForWorkpage(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId)

    • renderROWINCLUDENodeForWorkpage

      protected void renderROWINCLUDENodeForWorkpage(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId)

    • renderPopupMenuIntoNode

      public void renderPopupMenuIntoNode(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode node)

    • getCurrentContentReplace

      public String getCurrentContentReplace()

    • getContentReplaceNoDrillDown

      public String getContentReplaceNoDrillDown(IWorkpage wp)

    • getCurrentContentReplaceNoDrillDown

      public String getCurrentContentReplaceNoDrillDown()

    • getCurrentlySelectedWorkpage

      public IWorkpage getCurrentlySelectedWorkpage()
      Description copied from interface: IWorkpageContainer
      Returns the workpage that is currently selected within the workpage selector. This function must only be called when using the ROWWORKPAGESELECTOR component.
      Specified by:
      getCurrentlySelectedWorkpage in interface IWorkpageContainer

    • getCurrentWorkpage

      public IWorkpage getCurrentWorkpage()
      Description copied from interface: IWorkpageContainer
      Returns the workpage that is currently shown within the content area of the workplace.
      Specified by:
      getCurrentWorkpage in interface IWorkpageContainer

    • isCurrentWorkpageDecorated

      public boolean isCurrentWorkpageDecorated()

    • isCurrentWorkpagePopupSupported

      public boolean isCurrentWorkpagePopupSupported()

    • isCurrentWorkpageWpDragSupported

      public boolean isCurrentWorkpageWpDragSupported()

    • isCurrentWorkpageCloseSupported

      public boolean isCurrentWorkpageCloseSupported()

    • isCurrentWorkpageBlocked

      public boolean isCurrentWorkpageBlocked()

    • getCurrentWorkpageClientNamePopupIcon

      public String getCurrentWorkpageClientNamePopupIcon()

    • getCurrentWorkpageClientNameWpDrag

      public String getCurrentWorkpageClientNameWpDrag()

    • getCurrentWorkpageClientNameCloseIcon

      public String getCurrentWorkpageClientNameCloseIcon()

    • setWithWorkpageDragDrop

      public void setWithWorkpageDragDrop(boolean withWorkpageDragDrop)
      Description copied from interface: IWorkpageContainer
      Defines if the user is able to drag/drop workpages in order to shift workpages from one workpage container to the next.
      Specified by:
      setWithWorkpageDragDrop in interface IWorkpageContainer

    • getWithWorkpageDragDrop

      public boolean getWithWorkpageDragDrop()
      Specified by:
      getWithWorkpageDragDrop in interface IWorkpageContainer

    • getWorkpageForUniqueTechnicalId

      public IWorkpage getWorkpageForUniqueTechnicalId(String techId)
      Description copied from interface: IWorkpageContainer
      Find the workpage with the contained technical id. Each workpage receives a technical id which is stable during its life cycle. The id is available by calling IWorkpage.getUniqueTechnicalId().
      Specified by:
      getWorkpageForUniqueTechnicalId in interface IWorkpageContainer

    • getWorkpageForUniqueTechnicalIdLOCAL

      protected IWorkpage getWorkpageForUniqueTechnicalIdLOCAL(String id)

    • getWorkpageForId

      public IWorkpage getWorkpageForId(String id)
      Description copied from interface: IWorkpageContainer
      Check if a workpage already is available for a passed workpage id. The id is the one that is explicitly assigned by the application processing.
      Specified by:
      getWorkpageForId in interface IWorkpageContainer

    • getWorkpageForIdLOCAL

      protected IWorkpage getWorkpageForIdLOCAL(String id)

    • showAsContentPage

      protected void showAsContentPage(IWorkpage wp)

    • showAsContentPageLOCAL

      protected void showAsContentPageLOCAL(IWorkpage wp)

    • switchToWorkpage

      public void switchToWorkpage(IWorkpage wp)
      Description copied from interface: IWorkpageContainer
      Switches to the workpage that is passed as parameter.
      Specified by:
      switchToWorkpage in interface IWorkpageContainer

    • switchToWorkpageLOCAL

      protected void switchToWorkpageLOCAL(IWorkpage wp)

    • switchToWorkpageLOCAL

      protected void switchToWorkpageLOCAL(IWorkpage wp, boolean withTrigger, boolean withHideSignal)

    • setTabbedLine

      public void setTabbedLine(org.eclnt.jsfserver.elements.impl.TABBEDLINEComponent tabbedLine)
      Internally used.

    • getIndexOfCurrentlySelectedWorkpage

      public int getIndexOfCurrentlySelectedWorkpage()

    • getTabbedLineIndex

      public int getTabbedLineIndex()

    • setTabbedLineIndex

      public void setTabbedLineIndex(int tabbedLineIndex)

    • getRenderedTabbedLine

      public boolean getRenderedTabbedLine()
      Tabbed line is only rendered if there is no specific renderer.

    • getRenderedWorkpageSelector

      public boolean getRenderedWorkpageSelector()

    • getTabbedLineEnabled

      public boolean getTabbedLineEnabled()

    • setWorkpageSelectorEnabled

      public void setWorkpageSelectorEnabled(IWorkpage workpage, boolean tabbedLineEnabled)
      Description copied from interface: IWorkpageContainer
      You may disable/enable the tab-navigation of a workpage's tabbed line.
      Specified by:
      setWorkpageSelectorEnabled in interface IWorkpageContainer

    • getEnabledCloseAll

      public boolean getEnabledCloseAll()

    • getEnabledCloseAllLeft

      public boolean getEnabledCloseAllLeft()

    • getEnabledCloseAllRight

      public boolean getEnabledCloseAllRight()

    • getEnabledCloseOthers

      public boolean getEnabledCloseOthers()

    • onTabbedLineTabAction

      public void onTabbedLineTabAction(ActionEvent ae)

    • onSwitchToLeft

      public void onSwitchToLeft(ActionEvent ae)

    • onSwitchToRight

      public void onSwitchToRight(ActionEvent ae)

    • onCloseAllWorkpages

      public void onCloseAllWorkpages(ActionEvent ae)

    • onTabbedLineAction

      public void onTabbedLineAction(ActionEvent ae)

    • moveWorkpage

      public void moveWorkpage(String wpTechId, String toWorkpageContainerId)
      Moves an existing workpage into an other workpage container.
      Parameters:
      wpTechId - (Technical) id of the workpage.
      workpageContainerId - Workpage container id, into which the workpage needs to be moved.

    • moveWorkpage

      protected void moveWorkpage(String wpTechId, WorkpageContainer toWpc)

    • moveWorkpage

      public void moveWorkpage(IWorkpage wp, WorkpageContainer toWpc)

    • closeAllWorkpages

      public void closeAllWorkpages()
      Description copied from interface: IWorkpageContainer
      Closes all workpages using the forced mode for closing. This means before calling this method you should inform the user that all data changes within the workpaged get lost.
      Specified by:
      closeAllWorkpages in interface IWorkpageContainer

    • closeAllWorkpagesBesidesCurrent

      public void closeAllWorkpagesBesidesCurrent()

    • closeAllWorkpagesLeftOfCurrent

      public void closeAllWorkpagesLeftOfCurrent()

    • findCloseableWorkpages

      protected List<IWorkpage> findCloseableWorkpages()

    • findCloseableWorkpagesBesidesCurrent

      protected List<IWorkpage> findCloseableWorkpagesBesidesCurrent()

    • findCloseableWorkpagesLeftOfCurrent

      protected List<IWorkpage> findCloseableWorkpagesLeftOfCurrent()

    • closeAllWorkpagesRightOfCurrent

      public void closeAllWorkpagesRightOfCurrent()

    • findCloseableWorkpagesRightOfCurrent

      protected List<IWorkpage> findCloseableWorkpagesRightOfCurrent()

    • closeAllWorkpages

      public void closeAllWorkpages(boolean forcedMode, Runnable afterCloseOperation)
      Description copied from interface: IWorkpageContainer
      Closes all workpages. Dependent from the forcedMode the closing will either be done "forced" (i.e. no intervention possible by workpage lifecycle listener) or will be done "normally".
      Specified by:
      closeAllWorkpages in interface IWorkpageContainer
      afterCloseOperation - After closing all workpages you may want a certain operation to be executed - this is the afterCloseOperation. In case of passing parameter "forcedMode" as "true", this operation is immediately run. Otherwise the closing of workpages may be interrupted (e.g. by some workpages asking the user if to save data, or do other things...). In this case the afterCloseOperation is run when all workpages are closed.

    • closeWorkpages

      public void closeWorkpages(List<IWorkpage> workpagesToBeClosed, boolean forcedMode, Runnable afterCloseOperation)

    • closeAllWorkpagesWithContinueOperation

      protected boolean closeAllWorkpagesWithContinueOperation(Runnable continueOperation)

    • closeWorkpagesWithContinueOperation

      protected boolean closeWorkpagesWithContinueOperation(List<IWorkpage> workpagesToBeClosed, Runnable continueOperation)

    • onCloseWorkpage

      public void onCloseWorkpage(ActionEvent ae)

    • onCloseCurrentWorkpage

      public void onCloseCurrentWorkpage(ActionEvent ae)

    • onPageAction

      public void onPageAction(ActionEvent ae)

    • onOpenCurrentPageAsModelessPopup

      public void onOpenCurrentPageAsModelessPopup(ActionEvent ae)

    • openCurrentPageAsModelessPopup

      public void openCurrentPageAsModelessPopup()

    • isolateWorkpageIntoModelessPopup

      public ModelessPopup isolateWorkpageIntoModelessPopup(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Isolate workpage as modeless popup.
      Specified by:
      isolateWorkpageIntoModelessPopup in interface IWorkpageContainer

    • destroy

      public void destroy()
      Specified by:
      destroy in interface IWorkpageContainer

    • openCurrentPageAsModelessPopupLOCAL

      protected ModelessPopup openCurrentPageAsModelessPopupLOCAL()

    • closeWorkpage

      public boolean closeWorkpage(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)
      Description copied from interface: IWorkpageContainer
      Same as IWorkpageContainer.closeWorkpage(IWorkpage) with additional parameter to check what to do with workpages that are defined to be without support of closing (i.e. inteface IWorkpage.isCloseSupported() returns false.
      Specified by:
      closeWorkpage in interface IWorkpageContainer
      Returns:
      result if workpage was really closed

    • closeWorkpage

      public boolean closeWorkpage(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Closes a workpage. This is the official way to close a workpage - going through the workpage container. Do not close a page on workplage level.
      Specified by:
      closeWorkpage in interface IWorkpageContainer
      Returns:
      result if workpage was really closed

    • closeWorkpageLOCAL

      protected boolean closeWorkpageLOCAL(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)

    • closeWorkpageForced

      public void closeWorkpageForced(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)
      Description copied from interface: IWorkpageContainer
      Same as IWorkpageContainer.closeWorkpageForced(IWorkpage) with additional parameter to check what to do with workpages that are defined to be without support of closing (i.e. inteface IWorkpage.isCloseSupported() returns false.
      Specified by:
      closeWorkpageForced in interface IWorkpageContainer

    • closeWorkpageForced

      public void closeWorkpageForced(IWorkpage workpage)
      Description copied from interface: IWorkpageContainer
      Closes a workpage - forced mode. The application must not ask for unsaved data etc. anymore.
      Specified by:
      closeWorkpageForced in interface IWorkpageContainer

    • closeWorkpageForcedLOCAL

      protected void closeWorkpageForcedLOCAL(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)

    • onHideAllPopups

      public void onHideAllPopups(ActionEvent ae)

    • checkIfWorkpageIsOpenedInPopup

      public boolean checkIfWorkpageIsOpenedInPopup(IWorkpage workpage)
      Specified by:
      checkIfWorkpageIsOpenedInPopup in interface IWorkpageContainer

    • checkIfWorkpageIsOpenedInPopupLOCAL

      protected boolean checkIfWorkpageIsOpenedInPopupLOCAL(IWorkpage workpage)

    • getAllWorkpages

      public List<IWorkpage> getAllWorkpages()
      Description copied from interface: IWorkpageContainer
      Returns list of all workpages the user has currently opened in the current workpage container. - Please note: there may be (better: there typically are) mulitple workpage containers, each one holding workpages.
      Specified by:
      getAllWorkpages in interface IWorkpageContainer

    • getAllWorkpagesIncludingSubWorkpageContainers

      public List<IWorkpage> getAllWorkpagesIncludingSubWorkpageContainers()
      Description copied from interface: IWorkpageContainer
      Returns list of all workpages, but now not restricted to "this" container, but to "this" container and the ones that are kept below.
      Specified by:
      getAllWorkpagesIncludingSubWorkpageContainers in interface IWorkpageContainer

    • getWithCubeRotation

      public boolean getWithCubeRotation()
      Switch if cube animations are activated. Default: inactive.
      Specified by:
      getWithCubeRotation in interface IWorkpageContainer

    • setWithCubeRotation

      public void setWithCubeRotation(boolean withCubeRotation)
      Specified by:
      setWithCubeRotation in interface IWorkpageContainer

    • hideAllPopups

      public void hideAllPopups()

    • getWorkpageInfoLOCAL

      protected WorkpageContainer.WorkpageInfo getWorkpageInfoLOCAL(IWorkpage workpage)

    • removeWorkpageInfo

      public void removeWorkpageInfo(IWorkpage workpage)

    • removeWorkpageInfoLOCAL

      protected void removeWorkpageInfoLOCAL(IWorkpage workpage)

    • removeWorkpageOpticallyLOCAL

      protected void removeWorkpageOpticallyLOCAL(IWorkpage workpage)

    • removeWorkpageLOCAL

      protected boolean removeWorkpageLOCAL(IWorkpage workpage, boolean withCloseForced, Runnable continueOperation, boolean alsoCloseWorkpageWithNoCloseSupported)

    • throwWorkpageProcessingEvent

      public void throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
      Internally called by processing of IWorkpage.
      Specified by:
      throwWorkpageProcessingEvent in interface IWorkpageContainer

    • throwWorkpageProcessingEventLOCAL

      protected void throwWorkpageProcessingEventLOCAL(WorkpageProcessingEvent event)

    • removeWorkpageFromNavigationStackLOCAL

      protected void removeWorkpageFromNavigationStackLOCAL(IWorkpage workpage)

    • updateTabbedLineLOCAL

      protected void updateTabbedLineLOCAL()

    • buildOnPopupMenuExpressionLOCAL

      protected String buildOnPopupMenuExpressionLOCAL()

    • getWorkpageContainerForNewWorkpage

      protected WorkpageContainer getWorkpageContainerForNewWorkpage(IWorkpage workpage)

    • getWorkpageContainerForExisitingWorkpage

      protected WorkpageContainer getWorkpageContainerForExisitingWorkpage(IWorkpage workpage)

    • getTopWorkpageContainerLOCAL

      protected WorkpageContainer getTopWorkpageContainerLOCAL()

    • findEmptyPage

      protected String findEmptyPage()

    • exportCurrentWorkpages

      public List<WorkpageStartInfo> exportCurrentWorkpages()
      Exports all workpages that were started via IWorkpageStartInfo into one list. This list can be used for restarting the workpages later on.
      Specified by:
      exportCurrentWorkpages in interface IWorkpageContainer

    • exportCurrentWorkpagesLOCAL

      protected void exportCurrentWorkpagesLOCAL(List<WorkpageStartInfo> result)

    • initiallyPrepareWorkplaceForCurrentUser

      protected void initiallyPrepareWorkplaceForCurrentUser()

    • sortPopupWorkpagesToTheEndLOCAL

      protected void sortPopupWorkpagesToTheEndLOCAL()

    • renderDynMenuContent

      protected void renderDynMenuContent()

    • initWorkpageSelector

      protected void initWorkpageSelector()

    • creatWorkplaceExtractApply

      public IExtractApply creatWorkplaceExtractApply()
      Description copied from interface: IWorkpageContainer
      Creates an instance of IExtractApply that extracts the whole workplace configuration.
      Specified by:
      creatWorkplaceExtractApply in interface IWorkpageContainer