public interface IWorkpageContainer
extends java.io.Serializable
| Modifier and Type | Method and Description |
|---|---|
void |
addWorkpage(IWorkpage workpage)
Adds the new workpage to the workpage container.
|
void |
addWorkpageAndKeepInBackground(IWorkpage workpage)
Adds the new workpage to the workpage container.
|
ModelessPopup |
addWorkpageAsPopup(IWorkpage workpage)
Adds the new workpage to the workpage container.
|
boolean |
checkIfWorkpageIsOpenedInPopup(IWorkpage workpage) |
void |
closeAllWorkpages()
Closes all workpages using the forced mode for closing.
|
void |
closeAllWorkpages(boolean forcedMode,
java.lang.Runnable afterCloseOperation)
Closes all workpages.
|
void |
closeWorkpage(IWorkpage workpage)
Closes a workpage.
|
void |
closeWorkpage(IWorkpage workpage,
boolean alsoCloseWorkpageWithNoCloseSupported)
Same as
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 as
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. |
java.util.List<WorkpageStartInfo> |
exportCurrentWorkpages()
Export currently opened workpages into a list of workpage-start-info-objects.
|
java.util.List<IWorkpage> |
getAllWorkpages()
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.
|
java.util.List<IWorkpage> |
getAllWorkpagesIncludingSubWorkpageContainers()
Returns list of all workpages, but now not restricted to "this" container,
but to "this" container and the ones that are kept below.
|
IWorkpage |
getCurrentlySelectedWorkpage()
Returns the workpage that is currently selected within the workpage
selector.
|
IWorkpage |
getCurrentWorkpage()
Returns the workpage that is currently shown within the content area
of the workplace.
|
java.lang.String |
getEmptyPage() |
WorkplaceFunctionSearchUI |
getFunctionSearchUI()
Page bean for searching functions within the current function tree.
|
WorkplaceFunctionsManager |
getFunctionsManager()
Each workpage container has one functions manager - managing the function tree(s).
|
WorkplaceHistory |
getHistory()
The workplace includes some management of the history of its content.
|
boolean |
getHotKeyIsolation() |
boolean |
getOpenWorkpagePopupsAsFrame() |
java.lang.String |
getOwnSubContainerId()
A workplace may contain several workpage containers.
|
IWorkpageContainerRenderer |
getRenderer() |
java.lang.String |
getRendererClassName() |
java.util.Map<java.lang.String,? extends IWorkpageContainer> |
getSubContainers()
A workplace may have several workpage containers - each of them holding
workpages.
|
java.lang.String |
getSubWorkpageContainerIdForWorkpage(IWorkpage workpage)
A workpage container may be separated into sub-workpage containers.
|
WorkplaceTileManager |
getTileManager()
Each workplace has one tile manager - a tile being the graphical representation
of a workpage container.
|
java.lang.String |
getUniqueId()
A workpage container instance is assigned a unique technical id when it
is created.
|
boolean |
getWithWorkpageDragDrop() |
IWorkpage |
getWorkpageForId(java.lang.String workpageId)
Check if a workpage already is available for a passed
workpage id.
|
ModelessPopup |
isolateWorkpageIntoModelessPopup(IWorkpage workpage)
Isolate workpage as modeless popup.
|
void |
maximizeWorkpage(IWorkpage workpage,
boolean maximized)
Maximize size of workpage.
|
void |
moveIsolatedWorkpageBackIntoContentArea(IWorkpage workpage)
Brings back a workpage that is isolated as modeless popup back into its
content area.
|
void |
moveWorkpageIntoContentArea(IWorkpage workpage)
Take a page from modeless popup display back into content area.
|
void |
prepareWorkplaceForCurrentUser()
Reads the workplace configuration for the currently logged on user.
|
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(java.lang.String jspPage)
The page that is shown when no workpage is available within the
workpage container.
|
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 |
setMaxNumberOfWorkpagesExceededMessage(java.lang.String message)
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(java.lang.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 |
setUpdateOnInnerEventOnly(boolean value)
If set to true, then a workpage is only updated on an event that is coming
from the workpage itself.
|
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(java.lang.String workpagePopupDefaultBgpaint)
Deprecated.
|
void |
setWorkpageSelectorEnabled(IWorkpage workpage,
boolean value)
You may disable/enable the tab-navigation of a workpage's tabbed line.
|
void |
switchToWorkpage(IWorkpage wp)
Switches to the workpage that is passed as parameter.
|
void |
throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
Throws an event and triggers the delegation of the event to
all other workpage instances.
|
void setOpenWorkpagePopupsAsFrame(boolean value)
boolean getOpenWorkpagePopupsAsFrame()
void setEmptyPage(java.lang.String jspPage)
java.lang.String getEmptyPage()
void addWorkpage(IWorkpage workpage)
void addWorkpageAndKeepInBackground(IWorkpage workpage)
ModelessPopup addWorkpageAsPopup(IWorkpage workpage)
void switchToWorkpage(IWorkpage wp)
IWorkpage getWorkpageForId(java.lang.String workpageId)
void closeWorkpage(IWorkpage workpage)
void closeWorkpage(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)
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)
void closeWorkpageForced(IWorkpage workpage, boolean alsoCloseWorkpageWithNoCloseSupported)
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.void moveWorkpageIntoContentArea(IWorkpage workpage)
void maximizeWorkpage(IWorkpage workpage, boolean maximized)
void closeAllWorkpages()
void closeAllWorkpages(boolean forcedMode,
java.lang.Runnable afterCloseOperation)
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.java.util.List<IWorkpage> getAllWorkpages()
java.util.List<IWorkpage> getAllWorkpagesIncludingSubWorkpageContainers()
boolean checkIfWorkpageIsOpenedInPopup(IWorkpage workpage)
void setMaxNumberOfWorkpages(int maxNumberOfWorkpages)
void setMaxNumberOfWorkpagesExceededMessage(java.lang.String message)
void throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
IWorkpage getCurrentWorkpage()
IWorkpage getCurrentlySelectedWorkpage()
void setDefaultPopupWidth(int defaultPopupWidth)
void setDefaultPopupHeight(int defaultPopupHeight)
java.util.Map<java.lang.String,? extends IWorkpageContainer> getSubContainers()
getOwnSubContainerId() returning null), which owns sub containers
(each of them returning an explicit id/name in getOwnSubContainerId().WorkplaceTileManager getTileManager()
java.lang.String getSubWorkpageContainerIdForWorkpage(IWorkpage workpage)
java.util.List<WorkpageStartInfo> exportCurrentWorkpages()
void prepareWorkplaceForCurrentUser()
WorkplaceFunctionsManager getFunctionsManager()
WorkplaceFunctionSearchUI getFunctionSearchUI()
ModelessPopup isolateWorkpageIntoModelessPopup(IWorkpage workpage)
void moveIsolatedWorkpageBackIntoContentArea(IWorkpage workpage)
void setWithTabSelectorCloseIcons(boolean withTabSelectorCloseIcons)
void setWorkpageSelectorEnabled(IWorkpage workpage, boolean value)
void setShowPopupWorkpagesInSelector(boolean showPopupWorkpagesInSelector)
@Deprecated void setWorkpagePopupDefaultBgpaint(java.lang.String workpagePopupDefaultBgpaint)
void setUpdateOnInnerEventOnly(boolean value)
void setHotKeyIsolation(boolean hotkeyisolation)
boolean getHotKeyIsolation()
void setWithWorkpageDragDrop(boolean withWorkpageDragDrop)
boolean getWithWorkpageDragDrop()
WorkplaceHistory getHistory()
void setRendererClassName(java.lang.String value)
IWorkpageContainerRenderer or IWorkpageContainerPartialRenderer.java.lang.String getRendererClassName()
IWorkpageContainerRenderer getRenderer()
java.lang.String getOwnSubContainerId()
java.lang.String getUniqueId()
getOwnSubContainerId().Copyright © CaptainCasa Gmbh. All Rights Reserved.