Package org.eclnt.workplace
Class WorkpageContainer
java.lang.Object
org.eclnt.workplace.WorkpageContainer
- All Implemented Interfaces:
Serializable
,IWorkpageContainer
Container managing multiple workpages. Each workpage either is opened in the
content area of the workplace or is shown as modeless popup.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
class
class
class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Trigger
protected String
protected IWorkpage
protected int
protected int
protected DYNAMICCONTENTBinding
protected String
protected int
protected WorkplaceFunctionSearchUI
protected WorkplaceFunctionsManager
protected WorkplaceHistory
protected boolean
protected int
protected String
protected WorkpageContainerMultiWorkplaceManager
protected boolean
protected WorkpageContainer
protected String
protected WorkplacePerspectiveManager
protected int
protected IWorkpageContainerRenderer
protected String
protected boolean
protected WorkpageContainer.SubWorkpageContainers
protected org.eclnt.jsfserver.elements.impl.TABBEDLINEComponent
protected boolean
protected int
protected WorkpageContainer
protected WorkplaceTileManager
protected String
protected boolean
protected boolean
protected boolean
protected boolean
protected boolean
protected Set<IWorkpageContainerListener>
protected IWorkpageDispatcher
protected WorkpageContainer.WorkpageInfoMap
protected Map<IWorkpage,
WorkpageContainer.WorkpageInfo> protected String
protected IWorkpageSelector
protected boolean
protected static boolean
-
Constructor Summary
ModifierConstructorDescriptionWorkpageContainer
(IWorkpageDispatcher dispatcher) This constructor is used for the main workpage container.WorkpageContainer
(IWorkpageDispatcher dispatcher, boolean withPreparingWorkplaceForCurrentUser) This constructor may be used if you want to switch off the usage of the default workplace management.protected
WorkpageContainer
(IWorkpageDispatcher dispatcher, WorkpageContainer owner, String subContainerId) This constructor is used for sub workpage containers. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addWorkpage
(IWorkpage workpage) Adds the new workpage to the workpage container.void
addWorkpageAndKeepInBackground
(IWorkpage workpage) Adds the new workpage to the workpage container.void
addWorkpageAndKeepInBackgroundLOCAL
(IWorkpage workpage) addWorkpageAsPopup
(IWorkpage workpage) Adds the new workpage to the workpage container.protected ModelessPopup
addWorkpageAsPopupLOCAL
(IWorkpage workpage) void
addWorkpageContainerListener
(IWorkpageContainerListener workpageContainerListener) protected boolean
addWorkpageLOCAL
(IWorkpage workpage) protected boolean
addWorkpageLOCAL
(IWorkpage workpage, boolean withTrigger, boolean withSwitchToForeground) protected String
boolean
checkIfWorkpageIsOpenedInPopup
(IWorkpage workpage) protected boolean
checkIfWorkpageIsOpenedInPopupLOCAL
(IWorkpage workpage) void
Closes all workpages using the forced mode for closing.void
closeAllWorkpages
(boolean forcedMode, Runnable afterCloseOperation) Closes all workpages.void
void
void
protected boolean
closeAllWorkpagesWithContinueOperation
(Runnable continueOperation) boolean
closeWorkpage
(IWorkpage workpage) Closes a workpage.boolean
closeWorkpage
(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) Same asIWorkpageContainer.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.void
closeWorkpageForced
(IWorkpage workpage) Closes a workpage - forced mode.void
closeWorkpageForced
(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) Same asIWorkpageContainer.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.protected void
closeWorkpageForcedLOCAL
(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) protected boolean
closeWorkpageLOCAL
(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) void
closeWorkpages
(List<IWorkpage> workpagesToBeClosed, boolean forcedMode, Runnable afterCloseOperation) protected boolean
closeWorkpagesWithContinueOperation
(List<IWorkpage> workpagesToBeClosed, Runnable continueOperation) protected void
void
destroy()
Exports all workpages that were started via IWorkpageStartInfo into one list.protected void
protected String
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.Returns list of all workpages, but now not restricted to "this" container, but to "this" container and the ones that are kept below.Returns the workpage that is currently selected within the workpage selector.Returns the workpage that is currently shown within the content area of the workplace.int
int
boolean
boolean
boolean
boolean
int
Page bean for searching functions within the current function tree.Each workpage container has one functions manager - managing the function tree(s).Each workpage container has one functions manager - managing the function tree(s).The workplace includes some management of the history of its content.boolean
boolean
A workplace may contain several workpage containers.boolean
Tabbed line is only rendered if there is no specific renderer.boolean
boolean
Map<String,
? extends IWorkpageContainer> A workplace may have several workpage containers - each of them holding workpages.getSubWorkpageContainerForWorkpage
(IWorkpage workpage) A workpage container may be separated into sub-workpage containers.A workpage container may be separated into sub-workpage containers.boolean
int
Each workplace has one tile manager - a tile being the graphical representation of a workpage container.protected WorkpageContainer
A workpage container instance is assigned a unique technical id when it is created.boolean
boolean
Switch if cube animations are activated.boolean
boolean
protected WorkpageContainer
protected WorkpageContainer
getWorkpageContainerForNewWorkpage
(IWorkpage workpage) Get the dispatcher that is responsible for managing/keeping the top level objects within the context of this work page.Check if a workpage already is available for a passed workpage id.protected IWorkpage
protected IWorkpage
protected WorkpageContainer.WorkpageInfo
getWorkpageInfoLOCAL
(IWorkpage workpage) You may create an own implementation of a workpage selector by implementing interfaceIWorkpageSelector
.getWpim()
void
static void
Called as part of CaptainCasa runtime initialization.protected void
static void
initImplicitLoadingForCurrentUser
(boolean withPreparingWorkplaceForCurrentUser) By default the workplace management initializes it's environment on its own, calling functionprepareWorkplaceForCurrentUser()
automatically.protected void
boolean
boolean
boolean
boolean
isolateWorkpageIntoModelessPopup
(IWorkpage workpage) Isolate workpage as modeless popup.void
maximizeWorkpage
(IWorkpage workpage, boolean value) Maximize size of workpage.protected void
maximizeWorkpageLOCAL
(IWorkpage workpage, boolean value) void
Brings back a workpage that is isolated as modeless popup back into its content area.void
moveWorkpage
(String wpTechId, String toWorkpageContainerId) Moves an existing workpage into an other workpage container.protected void
moveWorkpage
(String wpTechId, WorkpageContainer toWpc) void
moveWorkpage
(IWorkpage wp, WorkpageContainer toWpc) void
moveWorkpageIntoContentArea
(IWorkpage workpage) Take a page from modeless display back into content area.protected void
moveWorkpageIntoContentAreaLOCAL
(IWorkpage workpage) void
onCloseAllWorkpages
(javax.faces.event.ActionEvent ae) void
onCloseCurrentWorkpage
(javax.faces.event.ActionEvent ae) void
onCloseWorkpage
(javax.faces.event.ActionEvent ae) void
onHideAllPopups
(javax.faces.event.ActionEvent ae) void
onOpenCurrentPageAsModelessPopup
(javax.faces.event.ActionEvent ae) void
onPageAction
(javax.faces.event.ActionEvent ae) void
onSwitchToLeft
(javax.faces.event.ActionEvent ae) void
onSwitchToRight
(javax.faces.event.ActionEvent ae) void
onTabbedLineAction
(javax.faces.event.ActionEvent ae) void
onTabbedLineTabAction
(javax.faces.event.ActionEvent ae) void
protected ModelessPopup
void
Central method for loading all workplace related information within the current workplace.void
removeWorkpageContainerListener
(IWorkpageContainerListener workpageContainerListner) protected void
void
removeWorkpageInfo
(IWorkpage workpage) protected void
removeWorkpageInfoLOCAL
(IWorkpage workpage) protected boolean
removeWorkpageLOCAL
(IWorkpage workpage, boolean withCloseForced, Runnable continueOperation, boolean alsoCloseWorkpageWithNoCloseSupported) protected void
removeWorkpageOpticallyLOCAL
(IWorkpage workpage) protected void
protected ROWDYNAMICCONTENTBinding.ComponentNode
renderOutestNode
(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId) void
protected void
renderROWINCLUDENodeForWorkpage
(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId) protected void
renderROWTITLEBARNodeForWorkpage
(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId) void
renderWorkpageNode
(IWorkpage wp, ROWDYNAMICCONTENTBinding.ComponentNode parentNode, String parentNodeId) void
setDefaultPopupHeight
(int defaultPopupHeight) Defines the height of the popup when isolating a workpage into a window of its own.void
setDefaultPopupWidth
(int defaultPopupWidth) Defines the width of the popup when isolating a workpage into a window of its own.void
setEmptyPage
(String jspPage) The page that is shown when no workpage is available within the workpage container.void
setHistory
(WorkplaceHistory history) void
setHotKeyIsolation
(boolean hotkeyisolation) If set to true then the workpage areas are isolated areas for hotkey processing.void
setMaxNumberOfWorkpages
(int maxNumberOfWorkpages) With this method you may restrict the number of parallelly running workpages to a certain limit.void
This is the message that is popped up once a user exceeds the limit of "maxNumberOfWorkpages".void
setOpenWorkpagePopupsAsFrame
(boolean value) By default isolated workpages are opened as dialog.void
setRendererClassName
(String value) The content renderer of the workpage container can be customized by passing the class name of the renderer.void
setShowPopupWorkpagesInSelector
(boolean showPopupWorkpagesInSelector) By default workpages that are isolated into an own popup are not shown in the selector.void
setTabbedLine
(org.eclnt.jsfserver.elements.impl.TABBEDLINEComponent tabbedLine) Internally used.void
setTabbedLineIndex
(int tabbedLineIndex) void
setUpdateOnInnerEventOnly
(boolean value) If set to true, then a workpage is only updated on an event that is coming from the workpage itself.void
setWithCubeRotation
(boolean withCubeRotation) void
setWithTabSelectorCloseIcons
(boolean withTabSelectorCloseIcons) Defines if close icons are rendered into the selector's tab components.void
setWithWorkpageDragDrop
(boolean withWorkpageDragDrop) Defines if the user is able to drag/drop workpages in order to shift workpages from one workpage container to the next.void
setWorkpagePopupDefaultBgpaint
(String workpagePopupDefaultBgpaint) Defines the BGPAINT of isolated workpage popups.void
setWorkpageSelectorEnabled
(IWorkpage workpage, boolean tabbedLineEnabled) You may disable/enable the tab-navigation of a workpage's tabbed line.protected void
protected void
protected void
void
Switches to the workpage that is passed as parameter.protected void
protected void
switchToWorkpageLOCAL
(IWorkpage wp, boolean withTrigger, boolean withHideSignal) void
Internally called by processing ofIWorkpage
.protected void
protected void
-
Field Details
-
s_implicitLoadingOfWorkplaceForCurrentUser
protected static boolean s_implicitLoadingOfWorkplaceForCurrentUser -
m_this
-
m_owner
-
m_tileManager
-
m_functionsManager
-
m_perspectiveManager
-
m_functionSearchUI
-
m_history
-
m_subWorkpageContainers
-
m_ownSubContainerId
-
m_workpageList
-
m_workpageInfos
-
m_workpageInfoMap
-
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
-
m_workpageDispatcher
-
m_focusCounter
protected int m_focusCounter -
m_maxNumberOfWorkpages
protected int m_maxNumberOfWorkpages -
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
-
m_animationTrigger
-
m_workpageContainerListeners
-
m_workplacePrepareWasCalled
protected boolean m_workplacePrepareWasCalled -
m_withPreparingWorkplaceForCurrentUser
protected boolean m_withPreparingWorkplaceForCurrentUser -
m_withTabSelectorCloseIcons
protected boolean m_withTabSelectorCloseIcons -
m_workpagePopupDefaultBgpaint
-
m_hotkeyisolation
protected boolean m_hotkeyisolation -
m_withWorkpageDragDrop
protected boolean m_withWorkpageDragDrop -
m_rendererClassName
-
m_renderer
-
m_uniqueId
-
m_dynMenuContent
-
m_multiWorkplaceManager
-
m_workpageSelector
-
m_withCubeRotation
protected boolean m_withCubeRotation
-
-
Constructor Details
-
WorkpageContainer
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 functionprepareWorkplaceForCurrentUser()
automatically. This function expects the user data (interfaceIUserAccess
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 functionprepareWorkplaceForCurrentUser()
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 interfaceIWorkpageContainer
-
getMultiWorkplaceManager
- Specified by:
getMultiWorkplaceManager
in interfaceIWorkpageContainer
-
setRendererClassName
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 implementIWorkpageContainerRenderer
orIWorkpageContainerPartialRenderer
.- Specified by:
setRendererClassName
in interfaceIWorkpageContainer
-
getRendererClassName
- Specified by:
getRendererClassName
in interfaceIWorkpageContainer
-
getDynMenuContent
-
getRenderer
- Specified by:
getRenderer
in interfaceIWorkpageContainer
-
createRenderer
protected void createRenderer() -
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 interfaceIWorkpageContainer
-
setHistory
-
getWorkpagePopupDefaultBgpaint
-
setWorkpagePopupDefaultBgpaint
Description copied from interface:IWorkpageContainer
Defines the BGPAINT of isolated workpage popups.- Specified by:
setWorkpagePopupDefaultBgpaint
in interfaceIWorkpageContainer
-
getHotKeyIsolation
public boolean getHotKeyIsolation()- Specified by:
getHotKeyIsolation
in interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 viaIWorkpageContainer.getOwnSubContainerId()
.- Specified by:
getUniqueId
in interfaceIWorkpageContainer
-
addWorkpageContainerListener
-
removeWorkpageContainerListener
-
getWorkpageContainerListeners
-
getTileManagerWithoutInitialization
-
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 interfaceIWorkpageContainer
-
getFunctionsManagerWithoutInitialization
Description copied from interface:IWorkpageContainer
Each workpage container has one functions manager - managing the function tree(s).- Specified by:
getFunctionsManagerWithoutInitialization
in interfaceIWorkpageContainer
-
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. UseIWorkpageContainer.getFunctionsManagerWithoutInitialization()
to access the instance before initialization.- Specified by:
getFunctionsManager
in interfaceIWorkpageContainer
-
getPerspectiveManagerWithoutInitialization
-
getPerspectiveManager
-
getFunctionSearchUI
Description copied from interface:IWorkpageContainer
Page bean for searching functions within the current function tree.- Specified by:
getFunctionSearchUI
in interfaceIWorkpageContainer
-
getSubWorkpageContainers
-
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 withIWorkpageContainer.getOwnSubContainerId()
returning null), which owns sub containers (each of them returning an explicit id/name inIWorkpageContainer.getOwnSubContainerId()
.- Specified by:
getSubContainers
in interfaceIWorkpageContainer
-
getWorkpageSelector
Description copied from interface:IWorkpageContainer
You may create an own implementation of a workpage selector by implementing interfaceIWorkpageSelector
.- Specified by:
getWorkpageSelector
in interfaceIWorkpageContainer
- Returns:
- Only returns instance if some owne workpage selector is defined.
-
getOpenWorkpagePopupsAsFrame
public boolean getOpenWorkpagePopupsAsFrame()- Specified by:
getOpenWorkpagePopupsAsFrame
in interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
setEmptyPage
Description copied from interface:IWorkpageContainer
The page that is shown when no workpage is available within the workpage container.- Specified by:
setEmptyPage
in interfaceIWorkpageContainer
-
getWpim
-
getSubWorkpageContainerForWorkpage
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 interfaceIWorkpageContainer
-
getSubWorkpageContainerIdForWorkpage
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
setMaxNumberOfWorkpagesExceededMessage
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 interfaceIWorkpageContainer
-
moveIsolatedWorkpageBackIntoContentArea
Description copied from interface:IWorkpageContainer
Brings back a workpage that is isolated as modeless popup back into its content area.- Specified by:
moveIsolatedWorkpageBackIntoContentArea
in interfaceIWorkpageContainer
-
moveWorkpageIntoContentArea
Take a page from modeless display back into content area.- Specified by:
moveWorkpageIntoContentArea
in interfaceIWorkpageContainer
-
moveWorkpageIntoContentAreaLOCAL
-
maximizeWorkpage
Description copied from interface:IWorkpageContainer
Maximize size of workpage.- Specified by:
maximizeWorkpage
in interfaceIWorkpageContainer
-
maximizeWorkpageLOCAL
-
getFocusCounter
public int getFocusCounter() -
addWorkpageAsPopup
Description copied from interface:IWorkpageContainer
Adds the new workpage to the workpage container.- Specified by:
addWorkpageAsPopup
in interfaceIWorkpageContainer
-
addWorkpageAsPopupLOCAL
-
addWorkpageAndKeepInBackground
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 interfaceIWorkpageContainer
-
addWorkpageAndKeepInBackgroundLOCAL
-
addWorkpage
Description copied from interface:IWorkpageContainer
Adds the new workpage to the workpage container.- Specified by:
addWorkpage
in interfaceIWorkpageContainer
-
addWorkpageLOCAL
-
addWorkpageLOCAL
protected boolean addWorkpageLOCAL(IWorkpage workpage, boolean withTrigger, boolean withSwitchToForeground) - Returns:
- true => workpage was added, false => workpage was NOT added
-
getAnimationValue
-
getCubeAnimationValue
-
getCubeAnimationDirection
-
getCurrentJspPage
-
getEmptyPage
- Specified by:
getEmptyPage
in interfaceIWorkpageContainer
-
getCurrentClientName
-
getContentReplaceForWorkpage
-
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
-
getCurrentContentReplace
-
getContentReplaceNoDrillDown
-
getCurrentContentReplaceNoDrillDown
-
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 interfaceIWorkpageContainer
-
getCurrentWorkpage
Description copied from interface:IWorkpageContainer
Returns the workpage that is currently shown within the content area of the workplace.- Specified by:
getCurrentWorkpage
in interfaceIWorkpageContainer
-
isCurrentWorkpageDecorated
public boolean isCurrentWorkpageDecorated() -
isCurrentWorkpagePopupSupported
public boolean isCurrentWorkpagePopupSupported() -
isCurrentWorkpageCloseSupported
public boolean isCurrentWorkpageCloseSupported() -
isCurrentWorkpageBlocked
public boolean isCurrentWorkpageBlocked() -
getCurrentWorkpageClientNamePopupIcon
-
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 interfaceIWorkpageContainer
-
getWithWorkpageDragDrop
public boolean getWithWorkpageDragDrop()- Specified by:
getWithWorkpageDragDrop
in interfaceIWorkpageContainer
-
getWorkpageForUniqueTechnicalId
-
getWorkpageForUniqueTechnicalIdLOCAL
-
getWorkpageForId
Description copied from interface:IWorkpageContainer
Check if a workpage already is available for a passed workpage id.- Specified by:
getWorkpageForId
in interfaceIWorkpageContainer
-
getWorkpageForIdLOCAL
-
showAsContentPage
-
showAsContentPageLOCAL
-
switchToWorkpage
Description copied from interface:IWorkpageContainer
Switches to the workpage that is passed as parameter.- Specified by:
switchToWorkpage
in interfaceIWorkpageContainer
-
switchToWorkpageLOCAL
-
switchToWorkpageLOCAL
-
setTabbedLine
public void setTabbedLine(org.eclnt.jsfserver.elements.impl.TABBEDLINEComponent tabbedLine) Internally used. -
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
Description copied from interface:IWorkpageContainer
You may disable/enable the tab-navigation of a workpage's tabbed line.- Specified by:
setWorkpageSelectorEnabled
in interfaceIWorkpageContainer
-
getEnabledCloseAll
public boolean getEnabledCloseAll() -
getEnabledCloseAllLeft
public boolean getEnabledCloseAllLeft() -
getEnabledCloseAllRight
public boolean getEnabledCloseAllRight() -
getEnabledCloseOthers
public boolean getEnabledCloseOthers() -
onTabbedLineTabAction
public void onTabbedLineTabAction(javax.faces.event.ActionEvent ae) -
onSwitchToLeft
public void onSwitchToLeft(javax.faces.event.ActionEvent ae) -
onSwitchToRight
public void onSwitchToRight(javax.faces.event.ActionEvent ae) -
onCloseAllWorkpages
public void onCloseAllWorkpages(javax.faces.event.ActionEvent ae) -
onTabbedLineAction
public void onTabbedLineAction(javax.faces.event.ActionEvent ae) -
moveWorkpage
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
-
moveWorkpage
-
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 interfaceIWorkpageContainer
-
closeAllWorkpagesBesidesCurrent
public void closeAllWorkpagesBesidesCurrent() -
closeAllWorkpagesLeftOfCurrent
public void closeAllWorkpagesLeftOfCurrent() -
findCloseableWorkpages
-
findCloseableWorkpagesBesidesCurrent
-
findCloseableWorkpagesLeftOfCurrent
-
closeAllWorkpagesRightOfCurrent
public void closeAllWorkpagesRightOfCurrent() -
findCloseableWorkpagesRightOfCurrent
-
closeAllWorkpages
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 interfaceIWorkpageContainer
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
-
closeAllWorkpagesWithContinueOperation
-
closeWorkpagesWithContinueOperation
-
onCloseWorkpage
public void onCloseWorkpage(javax.faces.event.ActionEvent ae) -
onCloseCurrentWorkpage
public void onCloseCurrentWorkpage(javax.faces.event.ActionEvent ae) -
onPageAction
public void onPageAction(javax.faces.event.ActionEvent ae) -
onOpenCurrentPageAsModelessPopup
public void onOpenCurrentPageAsModelessPopup(javax.faces.event.ActionEvent ae) -
openCurrentPageAsModelessPopup
public void openCurrentPageAsModelessPopup() -
isolateWorkpageIntoModelessPopup
Description copied from interface:IWorkpageContainer
Isolate workpage as modeless popup.- Specified by:
isolateWorkpageIntoModelessPopup
in interfaceIWorkpageContainer
-
destroy
public void destroy()- Specified by:
destroy
in interfaceIWorkpageContainer
-
openCurrentPageAsModelessPopupLOCAL
-
closeWorkpage
Description copied from interface:IWorkpageContainer
Same asIWorkpageContainer.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 interfaceIWorkpageContainer
- Returns:
- result if workpage was really closed
-
closeWorkpage
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 interfaceIWorkpageContainer
- Returns:
- result if workpage was really closed
-
closeWorkpageLOCAL
protected boolean closeWorkpageLOCAL(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) -
closeWorkpageForced
Description copied from interface:IWorkpageContainer
Same asIWorkpageContainer.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 interfaceIWorkpageContainer
-
closeWorkpageForced
Description copied from interface:IWorkpageContainer
Closes a workpage - forced mode. The application must not ask for unsaved data etc. anymore.- Specified by:
closeWorkpageForced
in interfaceIWorkpageContainer
-
closeWorkpageForcedLOCAL
protected void closeWorkpageForcedLOCAL(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported) -
onHideAllPopups
public void onHideAllPopups(javax.faces.event.ActionEvent ae) -
checkIfWorkpageIsOpenedInPopup
- Specified by:
checkIfWorkpageIsOpenedInPopup
in interfaceIWorkpageContainer
-
checkIfWorkpageIsOpenedInPopupLOCAL
-
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 interfaceIWorkpageContainer
-
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 interfaceIWorkpageContainer
-
getWithCubeRotation
public boolean getWithCubeRotation()Switch if cube animations are activated. Default: inactive.- Specified by:
getWithCubeRotation
in interfaceIWorkpageContainer
-
setWithCubeRotation
public void setWithCubeRotation(boolean withCubeRotation) - Specified by:
setWithCubeRotation
in interfaceIWorkpageContainer
-
hideAllPopups
public void hideAllPopups() -
getWorkpageInfoLOCAL
-
removeWorkpageInfo
-
removeWorkpageInfoLOCAL
-
removeWorkpageOpticallyLOCAL
-
removeWorkpageLOCAL
-
throwWorkpageProcessingEvent
Internally called by processing ofIWorkpage
.- Specified by:
throwWorkpageProcessingEvent
in interfaceIWorkpageContainer
-
throwWorkpageProcessingEventLOCAL
-
updateTabbedLineLOCAL
protected void updateTabbedLineLOCAL() -
buildOnPopupMenuExpressionLOCAL
-
getWorkpageContainerForNewWorkpage
-
getWorkpageContainerForExisitingWorkpage
-
getTopWorkpageContainerLOCAL
-
findEmptyPage
-
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 interfaceIWorkpageContainer
-
exportCurrentWorkpagesLOCAL
-
initiallyPrepareWorkplaceForCurrentUser
protected void initiallyPrepareWorkplaceForCurrentUser() -
sortPopupWorkpagesToTheEndLOCAL
protected void sortPopupWorkpagesToTheEndLOCAL() -
renderDynMenuContent
protected void renderDynMenuContent() -
initWorkpageSelector
protected void initWorkpageSelector()
-