Package org.eclnt.workplace

Interface IWorkpageStartInfo

All Superinterfaces:
Serializable
All Known Implementing Classes:
WorkpageStartInfo, WorkplaceFunctionTree.FunctionNode
public interface IWorkpageStartInfo extends Serializable
Basic Information that is required to start a certain workpage within the workplace management. Objects implementing this interface are typically attached to other objects e.g. workplace function tree nodes, favorite icons, etc.

The default implementation is WorkpageStartInfo. In case of defining own implementations: please sub-class from WorkpageStartInfo.

The "most important definition" is the page that you want to open within the workplace. There are two possibilities to define the page: either by defining the page name (setJspPage(String)) or by defining the name of the page bean (setPageBeanName(String)).

  • Method Details

    • setJspPage

      void setJspPage(String value)

    • getJspPage

      String getJspPage()

    • setPageBeanName

      void setPageBeanName(String pageBeanName)

    • getPageBeanName

      String getPageBeanName()

    • setFunctionClassName

      void setFunctionClassName(String functionClassName)

    • getFunctionClassName

      String getFunctionClassName()

    • setImage

      void setImage(String value)

    • getImage

      String getImage()

    • setText

      void setText(String value)

    • getText

      String getText()

    • setSelectorTitle

      void setSelectorTitle(String value)
      Explicit different text that is passed into the selector, when the workpage is started. - If null then the title passed via setText(..) is taken.

    • getSelectorTitle

      String getSelectorTitle()

    • setWindowTitle

      void setWindowTitle(String value)
      Explicit different text that is passed into the workpage's title, when the workpage is started. - if null then the title passed via setText(..) is taken.

    • getWindowTitle

      String getWindowTitle()

    • setDecorated

      void setDecorated(boolean decorated)

    • isDecorated

      boolean isDecorated()

    • setOpenMultipleInstances

      void setOpenMultipleInstances(boolean openMultipleInstances)

    • getOpenMultipleInstances

      boolean getOpenMultipleInstances()

    • setId

      void setId(String value)

    • getId

      String getId()

    • setParam

      void setParam(String paramName, String paramValue)

    • getParam

      String getParam(String paramName)

    • removeParam

      void removeParam(String paramName)

    • setPopupSupported

      void setPopupSupported(boolean value)

    • getPopupSuppoted

      boolean getPopupSuppoted()

    • setCloseSupported

      void setCloseSupported(boolean value)

    • getCloseSupported

      boolean getCloseSupported()

    • setOpenAsPopupByDefault

      void setOpenAsPopupByDefault(boolean value)

    • getOpenAsPopupByDefault

      boolean getOpenAsPopupByDefault()

    • setStartSubWorkpageContainerId

      void setStartSubWorkpageContainerId(String value)

    • getStartSubWorkpageContainerId

      String getStartSubWorkpageContainerId()

    • getExcludeFromSavePerspective

      boolean getExcludeFromSavePerspective()

    • setExcludeFromSavePerspective

      void setExcludeFromSavePerspective(boolean excludeFromSavePerspective)

    • getComment

      String getComment()
      Comment that is associated with this instance. The comment e.g. is shown as tooltip.

    • setComment

      void setComment(String comment)

    • getCommentImage

      String getCommentImage()
      Image that serves as additional comment to the image. The comment is currently not directly used in the workplace but may be used in subsequent component like the launchpad (CCLaunchPad).

    • setCommentImage

      void setCommentImage(String commentImage)

    • getCode

      String getCode()
      A short code for this item. The user can call the function from the search screen by just using this code.

    • setCode

      void setCode(String code)

    • getAppReference1

      String getAppReference1()
      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.

    • setAppReference1

      void setAppReference1(String appReference1)

    • getAppReference2

      String getAppReference2()
      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.

    • setAppReference2

      void setAppReference2(String appReference2)

    • getAppReference3

      String getAppReference3()
      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.

    • setAppReference3

      void setAppReference3(String appReference3)

    • getSelectorBgpaint

      String getSelectorBgpaint()

    • setSelectorBgpaint

      void setSelectorBgpaint(String selectorBgpaint)

    • getClientName

      String getClientName()