org.eclnt.workplace

## Class WorkpageStartInfo

- java.lang.Object
- - org.eclnt.util.valuemgmt.BeanWithParent
  - - org.eclnt.workplace.WorkpageStartInfo

- All Implemented Interfaces:
    java.io.Serializable, IWorkpageStartInfo

      public class WorkpageStartInfo
      extends BeanWithParent
      implements IWorkpageStartInfo, java.io.Serializable

  In the workplace management there are a couple of places where information is kept which later on is used to start a workpage. Example: the tree of functions, the favorites square and the favorites area. This class is the collection of data that is associated with a startable function.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `WorkpageStartInfo()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getAppReference1()` Application reference - this field is not used by CaptainCasa processing.
    `java.lang.String` | `getAppReference2()` Application reference - this field is not used by CaptainCasa processing.
    `java.lang.String` | `getAppReference3()` Application reference - this field is not used by CaptainCasa processing.
    `boolean` | `getCloseSupported()` Indicator that controls if a page can be directly closed from the workplace.
    `java.lang.String` | `getCode()` A short code for this item.
    `java.lang.String` | `getComment()` Comment that is associated with this instance.
    `java.lang.String` | `getCommentImage()` Image that serves as additional comment to the image.
    `boolean` | `getExcludeFromSavePerspective()` Defines if the workpage instance is stored as part of a perspective or not.
    `java.lang.String` | `getFunctionClassName()` The name of the class implementing `IWorkpageStartInfo`.
    `java.lang.String` | `getId()` The id of the page.
    `java.lang.String` | `getImage()` The image that is associated.
    `java.lang.String` | `getJspPage()` The name of the page to be started.
    `boolean` | `getOpenAsPopupByDefault()` Indicator that controls if a page is directly started as isolated modeless popup dialog.
    `boolean` | `getOpenMultipleInstances()`
    `java.lang.String` | `getPageBeanName()` Name of the page pean, that is the one to be opened.
    `java.lang.String` | `getParam(java.lang.String paramName)`
    `java.util.Map<java.lang.String,java.lang.String>` | `getParamMap()` Map of String parameters that are passed into the initialization of the page.
    `boolean` | `getPopupSuppoted()` Indicator that controls if a page can be isolated into a modeless popup dialog within the workplace.
    `java.lang.String` | `getSelectorTitle()` Special title that is shown in the selector, if different to the normal "text" attribute.
    `java.lang.String` | `getStartSubWorkpageContainerId()` Id of the wokrpage container in which the page should be started.
    `java.lang.String` | `getText()` The text that is associated with the page.
    `java.lang.String` | `getWindowTitle()` Special title that is shown in the title bar, if different to the normal "text" attribute.
    `boolean` | `isCloseSupported()`
    `boolean` | `isDecorated()`
    `boolean` | `isPopupSupported()`
    `void` | `removeParam(java.lang.String paramName)`
    `void` | `setAppReference1(java.lang.String appReference1)`
    `void` | `setAppReference2(java.lang.String appReference2)`
    `void` | `setAppReference3(java.lang.String appReference3)`
    `void` | `setCloseSupported(boolean closeSupported)`
    `void` | `setCode(java.lang.String code)`
    `void` | `setComment(java.lang.String comment)`
    `void` | `setCommentImage(java.lang.String commentImage)`
    `void` | `setDecorated(boolean decorated)` Indicator if a title bar is positioned above the page.
    `void` | `setExcludeFromSavePerspective(boolean excludeFromSavePerspective)`
    `void` | `setFunctionClassName(java.lang.String functionClassName)`
    `void` | `setId(java.lang.String value)`
    `void` | `setImage(java.lang.String value)`
    `void` | `setJspPage(java.lang.String value)`
    `void` | `setOpenAsPopupByDefault(boolean value)`
    `void` | `setOpenMultipleInstances(boolean openMultipleInstances)` Indicator if this page is opened multiple times within the workplace.
    `void` | `setPageBeanName(java.lang.String pageBeanName)`
    `void` | `setParam(java.lang.String paramName, java.lang.String paramValue)`
    `void` | `setParamMap(java.util.Map<java.lang.String,java.lang.String> value)`
    `void` | `setPopupSupported(boolean value)`
    `void` | `setSelectorTitle(java.lang.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.
    `void` | `setStartSubWorkpageContainerId(java.lang.String startSubWorkpageContainerId)`
    `void` | `setText(java.lang.String value)`
    `void` | `setWindowTitle(java.lang.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.

    - ### Methods inherited from class org.eclnt.util.valuemgmt.BeanWithParent

      `afterUnmarshal, findParent, passParent`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### WorkpageStartInfo

          public WorkpageStartInfo()

  - ### Method Detail

    - #### getJspPage

          public java.lang.String getJspPage()

      The name of the page to be started. The page needs to be defined as absolute address within the web content of the application (i.e. starting with "/"),
      Specified by:
        `getJspPage` in interface `IWorkpageStartInfo`

    - #### setJspPage

          public void setJspPage(java.lang.String value)

      Specified by:
        `setJspPage` in interface `IWorkpageStartInfo`

    - #### getFunctionClassName

          public java.lang.String getFunctionClassName()

      The name of the class implementing `IWorkpageStartInfo`. A new instance of the class will be created and called when the user invokes the workpage item.
      Specified by:
        `getFunctionClassName` in interface `IWorkpageStartInfo`

    - #### setFunctionClassName

          public void setFunctionClassName(java.lang.String functionClassName)

      Specified by:
        `setFunctionClassName` in interface `IWorkpageStartInfo`

    - #### getPageBeanName

          public java.lang.String getPageBeanName()

      Name of the page pean, that is the one to be opened. The page beans is - when opening the page - created within the dispatcher. The name that you define here is the name that is used inside the dispatcher - not the name of the class! Example: if the page bean is "reached" via the expression "#{d.AbcUI}", then the name you define is "AbcUI".
      Specified by:
        `getPageBeanName` in interface `IWorkpageStartInfo`

    - #### setPageBeanName

          public void setPageBeanName(java.lang.String pageBeanName)

      Specified by:
        `setPageBeanName` in interface `IWorkpageStartInfo`

    - #### getImage

          public java.lang.String getImage()

      The image that is associated. The image is shown within the workpage selector.
      Specified by:
        `getImage` in interface `IWorkpageStartInfo`

    - #### setImage

          public void setImage(java.lang.String value)

      Specified by:
        `setImage` in interface `IWorkpageStartInfo`

    - #### getText

          public java.lang.String getText()

      The text that is associated with the page. This is the default text for the selector title and window title - if not other explicit texts are defined by the attributes "windowTitle" and "selectorTitle".
      Specified by:
        `getText` in interface `IWorkpageStartInfo`

    - #### setText

          public void setText(java.lang.String value)

      Specified by:
        `setText` in interface `IWorkpageStartInfo`

    - #### setDecorated

          public void setDecorated(boolean decorated)

      Indicator if a title bar is positioned above the page. By default is "true".
      Specified by:
        `setDecorated` in interface `IWorkpageStartInfo`

    - #### isDecorated

          public boolean isDecorated()

      Specified by:
        `isDecorated` in interface `IWorkpageStartInfo`

    - #### setOpenMultipleInstances

          public void setOpenMultipleInstances(boolean openMultipleInstances)

      Indicator if this page is opened multiple times within the workplace. By default is "false".
      Specified by:
        `setOpenMultipleInstances` in interface `IWorkpageStartInfo`

    - #### getOpenMultipleInstances

          public boolean getOpenMultipleInstances()

      Specified by:
        `getOpenMultipleInstances` in interface `IWorkpageStartInfo`

    - #### getId

          public java.lang.String getId()

      The id of the page. The is is used for recognizing if a page is already available within a workplace. By default (if not specifying an id) the attribute "jspPage" is used as id.
      Specified by:
        `getId` in interface `IWorkpageStartInfo`

    - #### setId

          public void setId(java.lang.String value)

      Specified by:
        `setId` in interface `IWorkpageStartInfo`

    - #### getPopupSuppoted

          public boolean getPopupSuppoted()

      Indicator that controls if a page can be isolated into a modeless popup dialog within the workplace.
      Specified by:
        `getPopupSuppoted` in interface `IWorkpageStartInfo`

    - #### isPopupSupported

          public boolean isPopupSupported()

    - #### setPopupSupported

          public void setPopupSupported(boolean value)

      Specified by:
        `setPopupSupported` in interface `IWorkpageStartInfo`

    - #### getSelectorTitle

          public java.lang.String getSelectorTitle()

      Special title that is shown in the selector, if different to the normal "text" attribute.
      Specified by:
        `getSelectorTitle` in interface `IWorkpageStartInfo`

    - #### setSelectorTitle

          public void setSelectorTitle(java.lang.String value)

      Description copied from interface: `IWorkpageStartInfo`
      Explicit different text that is passed into the selector, when the workpage is started. - If null then the title passed via setText(..) is taken.
      Specified by:
        `setSelectorTitle` in interface `IWorkpageStartInfo`

    - #### getWindowTitle

          public java.lang.String getWindowTitle()

      Special title that is shown in the title bar, if different to the normal "text" attribute.
      Specified by:
        `getWindowTitle` in interface `IWorkpageStartInfo`

    - #### setWindowTitle

          public void setWindowTitle(java.lang.String value)

      Description copied from interface: `IWorkpageStartInfo`
      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.
      Specified by:
        `setWindowTitle` in interface `IWorkpageStartInfo`

    - #### getCloseSupported

          public boolean getCloseSupported()

      Indicator that controls if a page can be directly closed from the workplace. Default is "true".
      Specified by:
        `getCloseSupported` in interface `IWorkpageStartInfo`

    - #### isCloseSupported

          public boolean isCloseSupported()

    - #### setCloseSupported

          public void setCloseSupported(boolean closeSupported)

      Specified by:
        `setCloseSupported` in interface `IWorkpageStartInfo`

    - #### setParam

          public void setParam(java.lang.String paramName,
                               java.lang.String paramValue)

      Specified by:
        `setParam` in interface `IWorkpageStartInfo`

    - #### getParam

          public java.lang.String getParam(java.lang.String paramName)

      Specified by:
        `getParam` in interface `IWorkpageStartInfo`

    - #### removeParam

          public void removeParam(java.lang.String paramName)

      Specified by:
        `removeParam` in interface `IWorkpageStartInfo`

    - #### getParamMap

          public java.util.Map<java.lang.String,java.lang.String> getParamMap()

      Map of String parameters that are passed into the initialization of the page.

    - #### setParamMap

          public void setParamMap(java.util.Map<java.lang.String,java.lang.String> value)

    - #### getOpenAsPopupByDefault

          public boolean getOpenAsPopupByDefault()

      Indicator that controls if a page is directly started as isolated modeless popup dialog.
      Specified by:
        `getOpenAsPopupByDefault` in interface `IWorkpageStartInfo`

    - #### setOpenAsPopupByDefault

          public void setOpenAsPopupByDefault(boolean value)

      Specified by:
        `setOpenAsPopupByDefault` in interface `IWorkpageStartInfo`

    - #### getStartSubWorkpageContainerId

          public java.lang.String getStartSubWorkpageContainerId()

      Id of the wokrpage container in which the page should be started.
      Specified by:
        `getStartSubWorkpageContainerId` in interface `IWorkpageStartInfo`

    - #### setStartSubWorkpageContainerId

          public void setStartSubWorkpageContainerId(java.lang.String startSubWorkpageContainerId)

      Specified by:
        `setStartSubWorkpageContainerId` in interface `IWorkpageStartInfo`

    - #### getExcludeFromSavePerspective

          public boolean getExcludeFromSavePerspective()

      Defines if the workpage instance is stored as part of a perspective or not. See `IWorkpage.getExcludeFromSavePerspective()`.
      Specified by:
        `getExcludeFromSavePerspective` in interface `IWorkpageStartInfo`

    - #### setExcludeFromSavePerspective

          public void setExcludeFromSavePerspective(boolean excludeFromSavePerspective)

      Specified by:
        `setExcludeFromSavePerspective` in interface `IWorkpageStartInfo`

    - #### getComment

          public java.lang.String getComment()

      Comment that is associated with this instance. The comment e.g. is shown as tooltip.
      Specified by:
        `getComment` in interface `IWorkpageStartInfo`

    - #### setComment

          public void setComment(java.lang.String comment)

      Specified by:
        `setComment` in interface `IWorkpageStartInfo`

    - #### getCommentImage

          public java.lang.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).
      Specified by:
        `getCommentImage` in interface `IWorkpageStartInfo`

    - #### setCommentImage

          public void setCommentImage(java.lang.String commentImage)

      Specified by:
        `setCommentImage` in interface `IWorkpageStartInfo`

    - #### getCode

          public java.lang.String getCode()

      A short code for this item. The user can call the function from the search screen by just using this code.
      Specified by:
        `getCode` in interface `IWorkpageStartInfo`

    - #### setCode

          public void setCode(java.lang.String code)

      Specified by:
        `setCode` in interface `IWorkpageStartInfo`

    - #### getAppReference1

          public java.lang.String getAppReference1()

      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.
      Specified by:
        `getAppReference1` in interface `IWorkpageStartInfo`

    - #### setAppReference1

          public void setAppReference1(java.lang.String appReference1)

      Specified by:
        `setAppReference1` in interface `IWorkpageStartInfo`

    - #### getAppReference2

          public java.lang.String getAppReference2()

      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.
      Specified by:
        `getAppReference2` in interface `IWorkpageStartInfo`

    - #### setAppReference2

          public void setAppReference2(java.lang.String appReference2)

      Specified by:
        `setAppReference2` in interface `IWorkpageStartInfo`

    - #### getAppReference3

          public java.lang.String getAppReference3()

      Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.
      Specified by:
        `getAppReference3` in interface `IWorkpageStartInfo`

    - #### setAppReference3

          public void setAppReference3(java.lang.String appReference3)

      Specified by:
        `setAppReference3` in interface `IWorkpageStartInfo`

Copyright © CaptainCasa Gmbh. All Rights Reserved.