Package org.eclnt.workplace

Class Workpage

java.lang.Object
org.eclnt.workplace.Workpage
All Implemented Interfaces:
Serializable, IWorkpage
Direct Known Subclasses:
WorkpageByPageBean
public class Workpage extends Object implements Serializable, IWorkpage
Default implementation of IWorkplage interface. Must be used as base for own implementations.
See Also:

  • 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

      public String getDragsend()

    • getMwpDragsend

      public String getMwpDragsend()

    • setWorkpageStartInfo

      public void setWorkpageStartInfo(IWorkpageStartInfo workpageStartInfo)
      Specified by:
      setWorkpageStartInfo in interface IWorkpage

    • getWorkpageStartInfo

      public IWorkpageStartInfo getWorkpageStartInfo()
      Specified by:
      getWorkpageStartInfo in interface IWorkpage

    • getDispatcher

      public IWorkpageDispatcher 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 interface IWorkpage
      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.

    • getUuid

      public String getUuid()
      Tehchnical unique is that is automatically assigned to each workpage instance.

    • setId

      public void setId(String value)
      Description copied from interface: IWorkpage
      The id can be changed during runtime.
      Specified by:
      setId in interface IWorkpage

    • getId

      public String 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.
      Specified by:
      getId in interface IWorkpage

    • setTitle

      public void setTitle(String value)
      Description copied from interface: IWorkpage
      Update title during runtime.
      Specified by:
      setTitle in interface IWorkpage

    • getTitle

      public String getTitle()
      Description copied from interface: IWorkpage
      The title of the workpage.
      Specified by:
      getTitle in interface IWorkpage

    • getSelectorBgpaint

      public String getSelectorBgpaint()
      Description copied from interface: IWorkpage
      Background painting that is applied to the title selector.
      Specified by:
      getSelectorBgpaint in interface IWorkpage

    • setSelectorBgpaint

      public void setSelectorBgpaint(String selectorBgpaint)

    • setSelectorTitle

      public void setSelectorTitle(String value)
      Description copied from interface: IWorkpage
      Update selector title during runtime.
      Specified by:
      setSelectorTitle in interface IWorkpage

    • getSelectorTitle

      public String 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 via IWorkpage.getTitle() is shown.
      Specified by:
      getSelectorTitle in interface IWorkpage

    • getSelectorTitleOriginal

      public String getSelectorTitleOriginal()

    • setJspPage

      public void setJspPage(String value)

    • getJspPage

      public String getJspPage()
      Description copied from interface: IWorkpage
      This is the start page of the workpage.
      Specified by:
      getJspPage in interface IWorkpage

    • setIconURL

      public void setIconURL(String value)
      Description copied from interface: IWorkpage
      Update the icon during runtime.
      Specified by:
      setIconURL in interface IWorkpage

    • getIconURL

      public String getIconURL()
      Description copied from interface: IWorkpage
      The icon of the workpage that is shown in the task overview.
      Specified by:
      getIconURL in interface IWorkpage

    • 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 interface IWorkpage

    • isWpDragSupported

      public boolean isWpDragSupported()
      Description copied from interface: IWorkpage
      Indicates if the workpage can be dragged and dropped into a workplace running on a different browser. This functions is part of the multi workplace management.
      Specified by:
      isWpDragSupported in interface IWorkpage

    • setWpDragSupported

      public void setWpDragSupported(boolean wpDragSupported)

    • getStartSubWorkpageContainerId

      public String getStartSubWorkpageContainerId()
      Specified by:
      getStartSubWorkpageContainerId in interface IWorkpage

    • setStartSubWorkpageContainerId

      public void setStartSubWorkpageContainerId(String startSubWorkpageContainerId)

    • 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.
      Specified by:
      close in interface IWorkpage
      Returns:
      True if the closing was successful, false if not (e.g. if unsaved data would get destroyed).

    • closeAndContinue

      public boolean closeAndContinue(Runnable continueOperation)
      Same processing as with close() - but now passing the continueOperation in addition.
      Specified by:
      closeAndContinue in interface IWorkpage

    • closeForced

      public void closeForced()
      Default behaviour: the dispatcher gets destroyed.
      Specified by:
      closeForced in interface IWorkpage

    • getWorkpageContainer

      public IWorkpageContainer 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 interface IWorkpage

    • 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 interface IWorkpage

    • setPopupDecorated

      public void setPopupDecorated(boolean popupDecorated)
      Controls if the dialog popup that is opened is decorated or not.
      Specified by:
      setPopupDecorated in interface IWorkpage

    • 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 if IWorkpage.isPopupSupported() is set to true.
      Specified by:
      isPopupDecorated in interface IWorkpage

    • 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 interface IWorkpage

    • 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 interface IWorkpage

    • setParam

      public void setParam(String paramName, String paramValue)
      Specified by:
      setParam in interface IWorkpage

    • getParam

      public String getParam(String paramName)
      Specified by:
      getParam in interface IWorkpage

    • getParamMap

      public Map<String,String> getParamMap()
      Specified by:
      getParamMap in interface IWorkpage

    • addLifecycleListener

      public void addLifecycleListener(IWorkpageLifecycleListener listener)
      Specified by:
      addLifecycleListener in interface IWorkpage

    • removeLifecycleListener

      public void removeLifecycleListener(IWorkpageLifecycleListener listener)
      Specified by:
      removeLifecycleListener in interface IWorkpage

    • getLifecycleListeners

      public Set<IWorkpageLifecycleListener> getLifecycleListeners()
      Specified by:
      getLifecycleListeners in interface IWorkpage

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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 interface IWorkpage

    • 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 interface IWorkpage

    • 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 interface IWorkpage

    • 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 interface IWorkpage

    • 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 interface IWorkpage

    • reactOnShownInPopup

      public void reactOnShownInPopup()
      Description copied from interface: IWorkpage
      The page is (re)shown in a modeless popup.
      Specified by:
      reactOnShownInPopup in interface IWorkpage

    • throwWorkpageProcessingEvent

      public void throwWorkpageProcessingEvent(WorkpageProcessingEvent event)
      Description copied from interface: IWorkpage
      Throws an event and triggers the delegation of the event to all other workpage instances.
      Specified by:
      throwWorkpageProcessingEvent in interface IWorkpage

    • processWorkpageProcessingEvent

      public void processWorkpageProcessingEvent(WorkpageProcessingEvent event)
      Description copied from interface: IWorkpage
      Process workpage processing event coming from other workpage.
      Specified by:
      processWorkpageProcessingEvent in interface IWorkpage

    • checkIfWorkpageProcessingEventIsRelevant

      public boolean checkIfWorkpageProcessingEventIsRelevant(WorkpageProcessingEvent event)
      Description copied from interface: IWorkpage
      For event listeners are supporting IMultiWorkplaceWorkpageProcessingEventListener: check if event is relevant.
      Specified by:
      checkIfWorkpageProcessingEventIsRelevant in interface IWorkpage

    • addWorkpageProcessingEventListener

      public void addWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener)
      Specified by:
      addWorkpageProcessingEventListener in interface IWorkpage

    • removeWorkpageProcessingEventListener

      public void removeWorkpageProcessingEventListener(IWorkpageProcessingEventListener listener)
      Specified by:
      removeWorkpageProcessingEventListener in interface IWorkpage

    • createModalPopupInWorkpageContext

      public ModalPopup 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 interface IWorkpage

    • createModelessPopupInWorkpageContext

      public ModelessPopup 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 interface IWorkpage

    • assignIdToModelessPopup

      public void assignIdToModelessPopup(ModelessPopup popup, String id)
      Specified by:
      assignIdToModelessPopup in interface IWorkpage

    • getModelesspopup

      public ModelessPopup getModelesspopup(String assignedId)
      Specified by:
      getModelesspopup in interface IWorkpage

    • getModelessPopupOfWorkpage

      public ModelessPopup 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 interface IWorkpage
      Returns:

    • setModelessPopupOfWorkpage

      public void setModelessPopupOfWorkpage(ModelessPopup popup)
      Description copied from interface: IWorkpage
      Function that allows WorkpageContainer to set ModelessPopup instance.
      Specified by:
      setModelessPopupOfWorkpage in interface IWorkpage

    • getUniqueTechnicalId

      public String 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 interface IWorkpage

    • 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 interface IWorkpage

    • getComment

      public String getComment()
      Description copied from interface: IWorkpage
      Comment - the comment is e.g. shown in tool tips.
      Specified by:
      getComment in interface IWorkpage

    • setComment

      public void setComment(String comment)

    • 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.
      Specified by:
      isBlocked in interface IWorkpage

    • 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 interface IWorkpage
      Returns:

    • closeSemiModalPopup

      public void closeSemiModalPopup(IPageBean callingPageBean, IPageBean popupPageBean)
      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 interface IWorkpage

    • isShown

      public boolean isShown()
      Description copied from interface: IWorkpage
      Checks if workpage is visible to the user.
      Specified by:
      isShown in interface IWorkpage

    • getClientName

      public String getClientName()
      Specified by:
      getClientName in interface IWorkpage

    • getSortIndex

      public int getSortIndex()
      Description copied from interface: IWorkpage
      The sequence of workpages within a container is always sorted after being updated. By default the sorting is not explicitly controlled - the sequence of pages reflects the chronology of adding/removing workpages. But you can explicitly sort pages by assigning an index which is not negative.
      Specified by:
      getSortIndex in interface IWorkpage
      Returns:
      negative value: not explicit sorting; positive value: sorting by this index.