Package org.eclnt.workplace
Class WorkpageStartInfo
java.lang.Object
org.eclnt.util.valuemgmt.BeanWithParent
org.eclnt.workplace.WorkpageStartInfo
- All Implemented Interfaces:
Serializable
,Cloneable
,IWorkpageStartInfo
public class WorkpageStartInfo
extends BeanWithParent
implements IWorkpageStartInfo, Serializable, Cloneable
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:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionApplication reference - this field is not used by CaptainCasa processing.Application reference - this field is not used by CaptainCasa processing.Application reference - this field is not used by CaptainCasa processing.When starting the workpage then the following client name is assigned to the ROWINCLUDE-component that internally holds the workpage.boolean
Indicator that controls if a page can be directly closed from the workplace.getCode()
A short code for this item.Comment that is associated with this instance.Image that serves as additional comment to the image.boolean
Defines if the workpage instance is stored as part of a perspective or not.The name of the class implementingIWorkpageStartInfo
.getId()
The id of the page.getImage()
The image that is associated.The name of the page to be started.boolean
Indicator that controls if a page is directly started as isolated modeless popup dialog.boolean
Name of the page pean, that is the one to be opened.Map of String parameters that are passed into the initialization of the page.boolean
Indicator that controls if a page can be isolated into a modeless popup dialog within the workplace.Background painting that is applied to the selector.Special title that is shown in the selector, if different to the normal "text" attribute.Id of the wokrpage container in which the page should be started.getText()
The text that is associated with the page.Special title that is shown in the title bar, if different to the normal "text" attribute.boolean
boolean
boolean
void
removeParam
(String paramName) void
setAppReference1
(String appReference1) void
setAppReference2
(String appReference2) void
setAppReference3
(String appReference3) void
setClientName
(String clientName) void
setCloseSupported
(boolean closeSupported) void
void
setComment
(String comment) void
setCommentImage
(String commentImage) void
setDecorated
(boolean decorated) Indicator if a title bar is positioned above the page.void
setExcludeFromSavePerspective
(boolean excludeFromSavePerspective) void
setFunctionClassName
(String functionClassName) void
void
void
setJspPage
(String value) void
setOpenAsPopupByDefault
(boolean value) void
setOpenMultipleInstances
(boolean openMultipleInstances) Indicator if this page is opened multiple times within the workplace.void
setPageBeanName
(String pageBeanName) void
void
setParamMap
(Map<String, String> value) void
setPopupSupported
(boolean value) void
setSelectorBgpaint
(String selectorBgpaint) 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.void
setStartSubWorkpageContainerId
(String startSubWorkpageContainerId) void
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.Methods inherited from class org.eclnt.util.valuemgmt.BeanWithParent
afterUnmarshal, findParent, passParent
-
Constructor Details
-
WorkpageStartInfo
public WorkpageStartInfo()
-
-
Method Details
-
createClone
-
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 interfaceIWorkpageStartInfo
-
setJspPage
- Specified by:
setJspPage
in interfaceIWorkpageStartInfo
-
getFunctionClassName
The name of the class implementingIWorkpageStartInfo
. A new instance of the class will be created and called when the user invokes the workpage item.- Specified by:
getFunctionClassName
in interfaceIWorkpageStartInfo
-
setFunctionClassName
- Specified by:
setFunctionClassName
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setPageBeanName
- Specified by:
setPageBeanName
in interfaceIWorkpageStartInfo
-
getImage
The image that is associated. The image is shown within the workpage selector.- Specified by:
getImage
in interfaceIWorkpageStartInfo
-
setImage
- Specified by:
setImage
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setText
- Specified by:
setText
in interfaceIWorkpageStartInfo
-
setDecorated
public void setDecorated(boolean decorated) Indicator if a title bar is positioned above the page. By default is "true".- Specified by:
setDecorated
in interfaceIWorkpageStartInfo
-
isDecorated
public boolean isDecorated()- Specified by:
isDecorated
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
getOpenMultipleInstances
public boolean getOpenMultipleInstances()- Specified by:
getOpenMultipleInstances
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setId
- Specified by:
setId
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
isPopupSupported
public boolean isPopupSupported() -
setPopupSupported
public void setPopupSupported(boolean value) - Specified by:
setPopupSupported
in interfaceIWorkpageStartInfo
-
getSelectorTitle
Special title that is shown in the selector, if different to the normal "text" attribute.- Specified by:
getSelectorTitle
in interfaceIWorkpageStartInfo
-
setSelectorTitle
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 interfaceIWorkpageStartInfo
-
getWindowTitle
Special title that is shown in the title bar, if different to the normal "text" attribute.- Specified by:
getWindowTitle
in interfaceIWorkpageStartInfo
-
setWindowTitle
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 interfaceIWorkpageStartInfo
-
getCloseSupported
public boolean getCloseSupported()Indicator that controls if a page can be directly closed from the workplace. Default is "true".- Specified by:
getCloseSupported
in interfaceIWorkpageStartInfo
-
isCloseSupported
public boolean isCloseSupported() -
setCloseSupported
public void setCloseSupported(boolean closeSupported) - Specified by:
setCloseSupported
in interfaceIWorkpageStartInfo
-
setParam
- Specified by:
setParam
in interfaceIWorkpageStartInfo
-
getParam
- Specified by:
getParam
in interfaceIWorkpageStartInfo
-
removeParam
- Specified by:
removeParam
in interfaceIWorkpageStartInfo
-
getParamMap
Map of String parameters that are passed into the initialization of the page. -
setParamMap
-
getOpenAsPopupByDefault
public boolean getOpenAsPopupByDefault()Indicator that controls if a page is directly started as isolated modeless popup dialog.- Specified by:
getOpenAsPopupByDefault
in interfaceIWorkpageStartInfo
-
setOpenAsPopupByDefault
public void setOpenAsPopupByDefault(boolean value) - Specified by:
setOpenAsPopupByDefault
in interfaceIWorkpageStartInfo
-
getStartSubWorkpageContainerId
Id of the wokrpage container in which the page should be started.- Specified by:
getStartSubWorkpageContainerId
in interfaceIWorkpageStartInfo
-
setStartSubWorkpageContainerId
- Specified by:
setStartSubWorkpageContainerId
in interfaceIWorkpageStartInfo
-
getExcludeFromSavePerspective
public boolean getExcludeFromSavePerspective()Defines if the workpage instance is stored as part of a perspective or not. SeeIWorkpage.getExcludeFromSavePerspective()
.- Specified by:
getExcludeFromSavePerspective
in interfaceIWorkpageStartInfo
-
setExcludeFromSavePerspective
public void setExcludeFromSavePerspective(boolean excludeFromSavePerspective) - Specified by:
setExcludeFromSavePerspective
in interfaceIWorkpageStartInfo
-
getComment
Comment that is associated with this instance. The comment e.g. is shown as tooltip.- Specified by:
getComment
in interfaceIWorkpageStartInfo
-
setComment
- Specified by:
setComment
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setCommentImage
- Specified by:
setCommentImage
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setCode
- Specified by:
setCode
in interfaceIWorkpageStartInfo
-
getAppReference1
Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.- Specified by:
getAppReference1
in interfaceIWorkpageStartInfo
-
setAppReference1
- Specified by:
setAppReference1
in interfaceIWorkpageStartInfo
-
getAppReference2
Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.- Specified by:
getAppReference2
in interfaceIWorkpageStartInfo
-
setAppReference2
- Specified by:
setAppReference2
in interfaceIWorkpageStartInfo
-
getAppReference3
Application reference - this field is not used by CaptainCasa processing. It is up to your application to use it.- Specified by:
getAppReference3
in interfaceIWorkpageStartInfo
-
setAppReference3
- Specified by:
setAppReference3
in interfaceIWorkpageStartInfo
-
getSelectorBgpaint
Background painting that is applied to the selector.- Specified by:
getSelectorBgpaint
in interfaceIWorkpageStartInfo
-
setSelectorBgpaint
- Specified by:
setSelectorBgpaint
in interfaceIWorkpageStartInfo
-
getClientName
When starting the workpage then the following client name is assigned to the ROWINCLUDE-component that internally holds the workpage. The client name is the stable id that is used to identify components e.g. by test tools. By addigningthe client name here, the client name of the workpage is pre-prended to all client names of the components that are contained in the workpage.- Specified by:
getClientName
in interfaceIWorkpageStartInfo
-
setClientName
-