public class Workpage extends java.lang.Object implements java.io.Serializable, IWorkpage
| Constructor and Description |
|---|
Workpage(IWorkpageDispatcher dispatcher,
java.lang.String jspPage,
java.lang.String id,
java.lang.String title,
java.lang.String iconURL,
boolean isDecorated) |
| Modifier and Type | Method and Description |
|---|---|
void |
addLifecycleListener(IWorkpageLifecycleListener listener) |
void |
addWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener) |
void |
assignIdToModelessPopup(ModelessPopup popup,
java.lang.String id) |
boolean |
close()
Asks all life cycle listeners - if one does not want to close
then the whole close is interrupted.
|
boolean |
closeAndContinue(java.lang.Runnable continueOperation)
Same processing as with
close() - but now passing
the continueOperation in addition. |
void |
closeForced()
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). |
ModalPopup |
createModalPopupInWorkpageContext()
Creates a modal popup that runs in the context of the workpage.
|
ModelessPopup |
createModelessPopupInWorkpageContext()
Creates a modeless popup that runs in the context of the workpage.
|
java.lang.String |
getComment()
Comment - the comment is e.g. shown in tool tips.
|
IWorkpageDispatcher |
getDispatcher()
Each workpage is associated with a dispatcher that manages
the managed beans for this workpage.
|
java.lang.String |
getDragsend() |
boolean |
getExcludeFromSavePerspective()
The workplace perspective management allows to store currently opened
workplace arrangements as perspectives.
|
java.lang.String |
getIconURL()
The icon of the workpage that is shown in the task overview.
|
java.lang.String |
getId()
Each workpage specifies an id.
|
java.lang.String |
getJspPage()
This is the start page of the workpage.
|
java.util.Set<IWorkpageLifecycleListener> |
getLifecycleListeners() |
ModelessPopup |
getModelesspopup(java.lang.String assignedId) |
ModelessPopup |
getModelessPopupOfWorkpage()
A workpage may be opened as modeless popup.
|
java.lang.String |
getParam(java.lang.String paramName) |
java.util.Map<java.lang.String,java.lang.String> |
getParamMap() |
java.lang.String |
getSelectorTitle()
The text that is shown inside the selector for the workpage.
|
java.lang.String |
getSelectorTitleOriginal() |
java.lang.String |
getStartSubWorkpageContainerId() |
java.lang.String |
getTitle()
The title of the workpage.
|
java.lang.String |
getUniqueTechnicalId()
Each workpage provides a technical id that is unique across all work
pages.
|
IWorkpageContainer |
getWorkpageContainer()
Returns the container this workpage is living in.
|
IWorkpageStartInfo |
getWorkpageStartInfo() |
boolean |
isBlocked()
Managed at runtime by workplace management: if a page opens up semi modal popup dialogs
then the page need to be blocked.
|
boolean |
isCloseSupported()
Indicates if the workpage can be closed via a close icon.
|
boolean |
isDecorated()
Indicates if the workplace embeds the workpage into a frame
with titlebar etc.
|
boolean |
isPopupSupported()
Indicates if the workpage can be isolated from the workpage container
into a modal popup.
|
ModelessPopup |
openSemiModalPopup(IPageBean callingPageBean,
IPageBean popupPageBean,
java.lang.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 |
processWorkpageProcessingEvent(WorkpageProcessingEvent event)
Process workpage processing event coming from other workpage.
|
boolean |
reactOnBeforeHide()
This method is called before the workpage gets hidden e.g. due to
user selection in the workpage selector.
|
void |
reactOnDisplay()
This method is called whenever the workpage container is pushing this
page to be displayed.
|
void |
reactOnHide()
This method is called whenever a workpage that is currently shown
within in the content area is replaced by another one.
|
void |
reactOnReselectedInContentArea()
This method is called if the workpage is currently shown in its workpage
container - and if the user re-selects the workpage.
|
void |
reactOnShownInContentArea()
The page is (re)shown in the content area of the workplace.
|
void |
reactOnShownInPopup()
The page is (re)shown in a modeless popup.
|
void |
removeLifecycleListener(IWorkpageLifecycleListener listener) |
void |
removeWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener) |
void |
setCloseSupported(boolean closeSupported)
Controls if the workpage provides a close icond within its title area.
|
void |
setComment(java.lang.String comment) |
void |
setDecorated(boolean value) |
void |
setExcludeFromSavePerspective(boolean excludeFromSavePerspective) |
void |
setIconURL(java.lang.String value)
Update the icon during runtime.
|
void |
setId(java.lang.String value)
The id can be changed during runtime.
|
void |
setJspPage(java.lang.String value) |
void |
setModelessPopupOfWorkpage(ModelessPopup popup)
Function that allows WorkpageContainer to set ModelessPopup instance.
|
void |
setParam(java.lang.String paramName,
java.lang.String paramValue) |
void |
setPopupSupported(boolean value)
Controls if the workpage is isolate-able as modeless popup by the user.
|
void |
setSelectorTitle(java.lang.String value)
Update selector title during runtime.
|
void |
setStartSubWorkpageContainerId(java.lang.String startSubWorkpageContainerId) |
void |
setTitle(java.lang.String value)
Update title during runtime.
|
void |
setWorkpageStartInfo(IWorkpageStartInfo workpageStartInfo) |
void |
throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
Throws an event and triggers the delegation of the event to
all other workpage instances.
|
java.lang.String |
toString() |
public Workpage(IWorkpageDispatcher dispatcher, java.lang.String jspPage, java.lang.String id, java.lang.String title, java.lang.String iconURL, boolean isDecorated)
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.public java.lang.String getDragsend()
public void setWorkpageStartInfo(IWorkpageStartInfo workpageStartInfo)
setWorkpageStartInfo in interface IWorkpagepublic IWorkpageStartInfo getWorkpageStartInfo()
getWorkpageStartInfo in interface IWorkpagepublic IWorkpageDispatcher getDispatcher()
IWorkpagegetDispatcher in interface IWorkpagepublic void setId(java.lang.String value)
IWorkpagepublic java.lang.String getId()
IWorkpagepublic void setTitle(java.lang.String value)
IWorkpagepublic java.lang.String getTitle()
IWorkpagepublic void setSelectorTitle(java.lang.String value)
IWorkpagesetSelectorTitle in interface IWorkpagepublic java.lang.String getSelectorTitle()
IWorkpageIWorkpage.getTitle() is shown.getSelectorTitle in interface IWorkpagepublic java.lang.String getSelectorTitleOriginal()
public void setJspPage(java.lang.String value)
public java.lang.String getJspPage()
IWorkpagegetJspPage in interface IWorkpagepublic void setIconURL(java.lang.String value)
IWorkpagesetIconURL in interface IWorkpagepublic java.lang.String getIconURL()
IWorkpagegetIconURL in interface IWorkpagepublic void setDecorated(boolean value)
public boolean isDecorated()
IWorkpageisDecorated in interface IWorkpagepublic java.lang.String getStartSubWorkpageContainerId()
getStartSubWorkpageContainerId in interface IWorkpagepublic void setStartSubWorkpageContainerId(java.lang.String startSubWorkpageContainerId)
public boolean close()
public boolean closeAndContinue(java.lang.Runnable continueOperation)
close() - but now passing
the continueOperation in addition.closeAndContinue in interface IWorkpagepublic void closeForced()
closeForced in interface IWorkpagepublic IWorkpageContainer getWorkpageContainer()
IWorkpagegetWorkpageContainer in interface IWorkpagepublic void setPopupSupported(boolean value)
public boolean isPopupSupported()
IWorkpageisPopupSupported in interface IWorkpagepublic void setCloseSupported(boolean closeSupported)
public boolean isCloseSupported()
IWorkpageisCloseSupported in interface IWorkpagepublic void reactOnDisplay()
IWorkpagereactOnDisplay in interface IWorkpagepublic void setParam(java.lang.String paramName,
java.lang.String paramValue)
public java.lang.String getParam(java.lang.String paramName)
public java.util.Map<java.lang.String,java.lang.String> getParamMap()
getParamMap in interface IWorkpagepublic void addLifecycleListener(IWorkpageLifecycleListener listener)
addLifecycleListener in interface IWorkpagepublic void removeLifecycleListener(IWorkpageLifecycleListener listener)
removeLifecycleListener in interface IWorkpagepublic java.util.Set<IWorkpageLifecycleListener> getLifecycleListeners()
getLifecycleListeners in interface IWorkpagepublic java.lang.String toString()
toString in class java.lang.Objectpublic void reactOnReselectedInContentArea()
IWorkpagereactOnReselectedInContentArea in interface IWorkpagepublic void reactOnShownInContentArea()
IWorkpagereactOnShownInContentArea in interface IWorkpagepublic void reactOnHide()
IWorkpagereactOnHide in interface IWorkpagepublic boolean reactOnBeforeHide()
IWorkpagereactOnBeforeHide in interface IWorkpagepublic void reactOnShownInPopup()
IWorkpagereactOnShownInPopup in interface IWorkpagepublic void throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
IWorkpagethrowWorkpageProcessingEvent in interface IWorkpagepublic void processWorkpageProcessingEvent(WorkpageProcessingEvent event)
IWorkpageprocessWorkpageProcessingEvent in interface IWorkpagepublic void addWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener)
addWorkpageProcessingEventListener in interface IWorkpagepublic void removeWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener)
removeWorkpageProcessingEventListener in interface IWorkpagepublic ModalPopup createModalPopupInWorkpageContext()
IWorkpagecreateModalPopupInWorkpageContext in interface IWorkpagepublic ModelessPopup createModelessPopupInWorkpageContext()
IWorkpagecreateModelessPopupInWorkpageContext in interface IWorkpagepublic void assignIdToModelessPopup(ModelessPopup popup, java.lang.String id)
assignIdToModelessPopup in interface IWorkpagepublic ModelessPopup getModelesspopup(java.lang.String assignedId)
getModelesspopup in interface IWorkpagepublic ModelessPopup getModelessPopupOfWorkpage()
IWorkpagegetModelessPopupOfWorkpage in interface IWorkpagepublic void setModelessPopupOfWorkpage(ModelessPopup popup)
IWorkpagesetModelessPopupOfWorkpage in interface IWorkpagepublic java.lang.String getUniqueTechnicalId()
IWorkpagegetUniqueTechnicalId in interface IWorkpagepublic void setExcludeFromSavePerspective(boolean excludeFromSavePerspective)
public boolean getExcludeFromSavePerspective()
IWorkpagegetExcludeFromSavePerspective in interface IWorkpagepublic java.lang.String getComment()
IWorkpagegetComment in interface IWorkpagepublic void setComment(java.lang.String comment)
public boolean isBlocked()
IWorkpagepublic ModelessPopup openSemiModalPopup(IPageBean callingPageBean, IPageBean popupPageBean, java.lang.String title, int width, int height, ModelessPopup.IModelessPopupListener popupListener)
openSemiModalPopup in interface IWorkpagepublic void closeSemiModalPopup(IPageBean callingPageBean, IPageBean popupPageBean)
IWorkpage#openSemiModalPopup(IPageBean, String, int, int, org.eclnt.jsfserver.defaultscreens.ModelessPopup.IModelessPopupListener).closeSemiModalPopup in interface IWorkpageCopyright © CaptainCasa Gmbh. All Rights Reserved.