Package org.eclnt.workplace
Class Workpage
java.lang.Object
org.eclnt.workplace.Workpage
- All Implemented Interfaces:
Serializable
,IWorkpage
- Direct Known Subclasses:
WorkpageByPageBean
Default implementation of IWorkplage interface. Must be used
as base for own implementations.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
assignIdToModelessPopup
(ModelessPopup popup, String id) boolean
For event listeners are supportingIMultiWorkplaceWorkpageProcessingEventListener
: check if event is relevant.boolean
close()
Asks all life cycle listeners - if one does not want to close then the whole close is interrupted.boolean
closeAndContinue
(Runnable continueOperation) Same processing as withclose()
- but now passing the continueOperation in addition.void
Default behaviour: the dispatcher gets destroyed.void
closeSemiModalPopup
(IPageBean callingPageBean, IPageBean popupPageBean) Close popup that was opened via#openSemiModalPopup(IPageBean, String, int, int, org.eclnt.jsfserver.defaultscreens.ModelessPopup.IModelessPopupListener)
.Creates a modal popup that runs in the context of the workpage.Creates a modeless popup that runs in the context of the workpage.Comment - the comment is e.g. shown in tool tips.Each workpage is associated with a dispatcher that manages the managed beans for this workpage.boolean
The workplace perspective management allows to store currently opened workplace arrangements as perspectives.The icon of the workpage that is shown in the task overview.getId()
Each workpage specifies an id.This is the start page of the workpage.getModelesspopup
(String assignedId) A workpage may be opened as modeless popup.Background painting that is applied to the title selector.The text that is shown inside the selector for the workpage.getTitle()
The title of the workpage.Each workpage provides a technical id that is unique across all work pages.Returns the workpage container managing the workplace management.boolean
Managed at runtime by workplace management: if a page opens up semi modal popup dialogs then the page need to be blocked.boolean
Indicates if the workpage can be closed via a close icon.boolean
Indicates if the workplace embeds the workpage into a frame with titlebar etc.boolean
Indicates if the dialog popup into which the workpage is opened has some decoration or not.boolean
Indicates if the workpage can be isolated from the workpage container into a modal popup.boolean
isShown()
Checks if workpage is visible to the user.openSemiModalPopup
(IPageBean callingPageBean, IPageBean popupPageBean, String title, int width, int height, ModelessPopup.IModelessPopupListener popupListener) Opens a modal popup which is only modal in the optical scope of the workpage.void
Process workpage processing event coming from other workpage.boolean
This method is called before the workpage gets hidden e.g. due to user selection in the workpage selector.void
This method is called whenever the workpage container is pushing this page to be displayed.void
This method is called whenever a workpage that is currently shown within in the content area is replaced by another one.void
This method is called if the workpage is currently shown in its workpage container - and if the user re-selects the workpage.void
The page is (re)shown in the content area of the workplace.void
The page is (re)shown in a modeless popup.void
The page is requested to be shown, but is already available - so the workplace management switches to this existing page.void
void
void
setCloseSupported
(boolean closeSupported) Controls if the workpage provides a close icond within its title area.void
setComment
(String comment) void
setDecorated
(boolean value) void
setExcludeFromSavePerspective
(boolean excludeFromSavePerspective) void
setIconURL
(String value) Update the icon during runtime.void
The id can be changed during runtime.void
setJspPage
(String value) void
Function that allows WorkpageContainer to set ModelessPopup instance.void
void
setPopupDecorated
(boolean popupDecorated) Controls if the dialog popup that is opened is decorated or not.void
setPopupSupported
(boolean value) Controls if the workpage is isolate-able as modeless popup by the user.void
setSelectorBgpaint
(String selectorBgpaint) void
setSelectorTitle
(String value) Update selector title during runtime.void
setStartSubWorkpageContainerId
(String startSubWorkpageContainerId) void
Update title during runtime.void
setWorkpageStartInfo
(IWorkpageStartInfo workpageStartInfo) void
Throws an event and triggers the delegation of the event to all other workpage instances.toString()
-
Constructor Details
-
Workpage
public Workpage(IWorkpageDispatcher dispatcher, String jspPage, String id, String title, String iconURL, boolean isDecorated) - Parameters:
dispatcher
- Dispatcher in that the workpage creates its own dispatcher. If the dispatcher passed is "#{d}" then the workpage will create a sub-dispatcher "#{d.d_1}" that will be used for the beans used within this workpage context.
-
-
Method Details
-
getDragsend
-
setWorkpageStartInfo
- Specified by:
setWorkpageStartInfo
in interfaceIWorkpage
-
getWorkpageStartInfo
- Specified by:
getWorkpageStartInfo
in interfaceIWorkpage
-
getDispatcher
Description copied from interface:IWorkpage
Each workpage is associated with a dispatcher that manages the managed beans for this workpage. This is the dispatcher of the workpage.
Please note: there is a dispatcher hierarchy - a top dispatcher ("#{d}") and there are sub-dispatchers, one for each workpage instance ("#{d.d_x}"). The dispatcher that is returned by this method is the workpage instance ("#{d.d_x}").- Specified by:
getDispatcher
in interfaceIWorkpage
- Returns:
- The dispatcher that is associated with this workpage. Pay attentions: this is NOT the dispatcher passed via the constructor but this is a sub-dispatcher of this dispatcher.
-
setId
Description copied from interface:IWorkpage
The id can be changed during runtime. -
getId
Description copied from interface:IWorkpage
Each workpage specifies an id. The id is used to check if a workpage is already included in a workpage container or not. The id needs to uniquely identify the workpage with its content. -
setTitle
Description copied from interface:IWorkpage
Update title during runtime. -
getTitle
Description copied from interface:IWorkpage
The title of the workpage. -
getSelectorBgpaint
Description copied from interface:IWorkpage
Background painting that is applied to the title selector.- Specified by:
getSelectorBgpaint
in interfaceIWorkpage
-
setSelectorBgpaint
-
setSelectorTitle
Description copied from interface:IWorkpage
Update selector title during runtime.- Specified by:
setSelectorTitle
in interfaceIWorkpage
-
getSelectorTitle
Description copied from interface:IWorkpage
The text that is shown inside the selector for the workpage. If returned as null then the normal title viaIWorkpage.getTitle()
is shown.- Specified by:
getSelectorTitle
in interfaceIWorkpage
-
getSelectorTitleOriginal
-
setJspPage
-
getJspPage
Description copied from interface:IWorkpage
This is the start page of the workpage.- Specified by:
getJspPage
in interfaceIWorkpage
-
setIconURL
Description copied from interface:IWorkpage
Update the icon during runtime.- Specified by:
setIconURL
in interfaceIWorkpage
-
getIconURL
Description copied from interface:IWorkpage
The icon of the workpage that is shown in the task overview.- Specified by:
getIconURL
in interfaceIWorkpage
-
setDecorated
public void setDecorated(boolean value) -
isDecorated
public boolean isDecorated()Description copied from interface:IWorkpage
Indicates if the workplace embeds the workpage into a frame with titlebar etc.- Specified by:
isDecorated
in interfaceIWorkpage
-
getStartSubWorkpageContainerId
- Specified by:
getStartSubWorkpageContainerId
in interfaceIWorkpage
-
setStartSubWorkpageContainerId
-
close
public boolean close()Asks all life cycle listeners - if one does not want to close then the whole close is interrupted. Calls closeForced() when all have agreed to close. -
closeAndContinue
Same processing as withclose()
- but now passing the continueOperation in addition.- Specified by:
closeAndContinue
in interfaceIWorkpage
-
closeForced
public void closeForced()Default behaviour: the dispatcher gets destroyed.- Specified by:
closeForced
in interfaceIWorkpage
-
getWorkpageContainer
Returns the workpage container managing the workplace management. This is always the top workpage container and not a child workpage container.- Specified by:
getWorkpageContainer
in interfaceIWorkpage
-
setPopupSupported
public void setPopupSupported(boolean value) Controls if the workpage is isolate-able as modeless popup by the user. -
isPopupSupported
public boolean isPopupSupported()Description copied from interface:IWorkpage
Indicates if the workpage can be isolated from the workpage container into a modal popup.- Specified by:
isPopupSupported
in interfaceIWorkpage
-
setPopupDecorated
public void setPopupDecorated(boolean popupDecorated) Controls if the dialog popup that is opened is decorated or not.- Specified by:
setPopupDecorated
in interfaceIWorkpage
-
isPopupDecorated
public boolean isPopupDecorated()Description copied from interface:IWorkpage
Indicates if the dialog popup into which the workpage is opened has some decoration or not. Only is used ifIWorkpage.isPopupSupported()
is set to true.- Specified by:
isPopupDecorated
in interfaceIWorkpage
-
setCloseSupported
public void setCloseSupported(boolean closeSupported) Controls if the workpage provides a close icond within its title area. -
isCloseSupported
public boolean isCloseSupported()Description copied from interface:IWorkpage
Indicates if the workpage can be closed via a close icon.- Specified by:
isCloseSupported
in interfaceIWorkpage
-
reactOnDisplay
public void reactOnDisplay()Description copied from interface:IWorkpage
This method is called whenever the workpage container is pushing this page to be displayed.- Specified by:
reactOnDisplay
in interfaceIWorkpage
-
setParam
-
getParam
-
getParamMap
- Specified by:
getParamMap
in interfaceIWorkpage
-
addLifecycleListener
- Specified by:
addLifecycleListener
in interfaceIWorkpage
-
removeLifecycleListener
- Specified by:
removeLifecycleListener
in interfaceIWorkpage
-
getLifecycleListeners
- Specified by:
getLifecycleListeners
in interfaceIWorkpage
-
toString
-
reactOnReselectedInContentArea
public void reactOnReselectedInContentArea()Description copied from interface:IWorkpage
This method is called if the workpage is currently shown in its workpage container - and if the user re-selects the workpage.- Specified by:
reactOnReselectedInContentArea
in interfaceIWorkpage
-
reactOnSwitchToPage
public void reactOnSwitchToPage()Description copied from interface:IWorkpage
The page is requested to be shown, but is already available - so the workplace management switches to this existing page.- Specified by:
reactOnSwitchToPage
in interfaceIWorkpage
-
reactOnShownInContentArea
public void reactOnShownInContentArea()Description copied from interface:IWorkpage
The page is (re)shown in the content area of the workplace.- Specified by:
reactOnShownInContentArea
in interfaceIWorkpage
-
reactOnHide
public void reactOnHide()Description copied from interface:IWorkpage
This method is called whenever a workpage that is currently shown within in the content area is replaced by another one.- Specified by:
reactOnHide
in interfaceIWorkpage
-
reactOnBeforeHide
public boolean reactOnBeforeHide()Description copied from interface:IWorkpage
This method is called before the workpage gets hidden e.g. due to user selection in the workpage selector.- Specified by:
reactOnBeforeHide
in interfaceIWorkpage
-
reactOnShownInPopup
public void reactOnShownInPopup()Description copied from interface:IWorkpage
The page is (re)shown in a modeless popup.- Specified by:
reactOnShownInPopup
in interfaceIWorkpage
-
throwWorkpageProcessingEvent
Description copied from interface:IWorkpage
Throws an event and triggers the delegation of the event to all other workpage instances.- Specified by:
throwWorkpageProcessingEvent
in interfaceIWorkpage
-
processWorkpageProcessingEvent
Description copied from interface:IWorkpage
Process workpage processing event coming from other workpage.- Specified by:
processWorkpageProcessingEvent
in interfaceIWorkpage
-
checkIfWorkpageProcessingEventIsRelevant
Description copied from interface:IWorkpage
For event listeners are supportingIMultiWorkplaceWorkpageProcessingEventListener
: check if event is relevant.- Specified by:
checkIfWorkpageProcessingEventIsRelevant
in interfaceIWorkpage
-
addWorkpageProcessingEventListener
- Specified by:
addWorkpageProcessingEventListener
in interfaceIWorkpage
-
removeWorkpageProcessingEventListener
- Specified by:
removeWorkpageProcessingEventListener
in interfaceIWorkpage
-
createModalPopupInWorkpageContext
Description copied from interface:IWorkpage
Creates a modal popup that runs in the context of the workpage.
This method is deprecated because all popup dialog management should be done through page beans. It is still available for compatibility reasons.- Specified by:
createModalPopupInWorkpageContext
in interfaceIWorkpage
-
createModelessPopupInWorkpageContext
Description copied from interface:IWorkpage
Creates a modeless popup that runs in the context of the workpage.
This method is deprecated because all popup dialog management should be done through page beans. It is still available for compatibility reasons.- Specified by:
createModelessPopupInWorkpageContext
in interfaceIWorkpage
-
assignIdToModelessPopup
- Specified by:
assignIdToModelessPopup
in interfaceIWorkpage
-
getModelesspopup
- Specified by:
getModelesspopup
in interfaceIWorkpage
-
getModelessPopupOfWorkpage
Description copied from interface:IWorkpage
A workpage may be opened as modeless popup. This function returns the popup instance the workpage is running in. In case the workplage does not run in a modeless popup, null will be returned.- Specified by:
getModelessPopupOfWorkpage
in interfaceIWorkpage
- Returns:
-
setModelessPopupOfWorkpage
Description copied from interface:IWorkpage
Function that allows WorkpageContainer to set ModelessPopup instance.- Specified by:
setModelessPopupOfWorkpage
in interfaceIWorkpage
-
getUniqueTechnicalId
Description copied from interface:IWorkpage
Each workpage provides a technical id that is unique across all work pages. The technical id is assigned internally and does not provide any application semantics!- Specified by:
getUniqueTechnicalId
in interfaceIWorkpage
-
setExcludeFromSavePerspective
public void setExcludeFromSavePerspective(boolean excludeFromSavePerspective) -
getExcludeFromSavePerspective
public boolean getExcludeFromSavePerspective()Description copied from interface:IWorkpage
The workplace perspective management allows to store currently opened workplace arrangements as perspectives. The perspectives include the arrangement of workplace tiles - and the workpages that are currently started within the tile. - You can exclude the current workpage from being stored as part of a perspective by using this function.- Specified by:
getExcludeFromSavePerspective
in interfaceIWorkpage
-
getComment
Description copied from interface:IWorkpage
Comment - the comment is e.g. shown in tool tips.- Specified by:
getComment
in interfaceIWorkpage
-
setComment
-
isBlocked
public boolean isBlocked()Description copied from interface:IWorkpage
Managed at runtime by workplace management: if a page opens up semi modal popup dialogs then the page need to be blocked. -
openSemiModalPopup
public ModelessPopup openSemiModalPopup(IPageBean callingPageBean, IPageBean popupPageBean, String title, int width, int height, ModelessPopup.IModelessPopupListener popupListener) Opens a modal popup which is only modal in the optical scope of the workpage. Other workpage can still be used.- Specified by:
openSemiModalPopup
in interfaceIWorkpage
- Returns:
-
closeSemiModalPopup
Description copied from interface:IWorkpage
Close popup that was opened via#openSemiModalPopup(IPageBean, String, int, int, org.eclnt.jsfserver.defaultscreens.ModelessPopup.IModelessPopupListener)
.- Specified by:
closeSemiModalPopup
in interfaceIWorkpage
-
isShown
public boolean isShown()Description copied from interface:IWorkpage
Checks if workpage is visible to the user. -
getClientName
- Specified by:
getClientName
in interfaceIWorkpage
-