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:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WorkpageStartInfo()

Method Summary

Modifier and Type	Method	Description
WorkpageStartInfo	createClone()
String	getAppReference1()	Application reference - this field is not used by CaptainCasa processing.
String	getAppReference2()	Application reference - this field is not used by CaptainCasa processing.
String	getAppReference3()	Application reference - this field is not used by CaptainCasa processing.
String	getClientName()	When starting the workpage then the following client name is assigned to the ROWINCLUDE-component that internally holds the workpage.
boolean	getCloseSupported()	Indicator that controls if a page can be directly closed from the workplace.
String	getCode()	A short code for this item.
String	getComment()	Comment that is associated with this instance.
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.
String	getFunctionClassName()	The name of the class implementing IWorkpageStartInfo.
String	getId()	The id of the page.
String	getImage()	The image that is associated.
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()
String	getPageBeanName()	Name of the page pean, that is the one to be opened.
String	getParam(String paramName)
Map<String,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.
String	getSelectorBgpaint()	Background painting that is applied to the selector.
String	getSelectorTitle()	Special title that is shown in the selector, if different to the normal "text" attribute.
int	getSortIndex()	See: IWorkpage.getSortIndex()
String	getStartSubWorkpageContainerId()	Id of the wokrpage container in which the page should be started.
String	getText()	The text that is associated with the page.
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(String paramName)
void	setAppReference1(String appReference1)
void	setAppReference2(String appReference2)
void	setAppReference3(String appReference3)
void	setClientName(String clientName)
void	setCloseSupported(boolean closeSupported)
void	setCode(String code)
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	setId(String value)
void	setImage(String value)
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	setParam(String paramName, String paramValue)
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	setSortIndex(int sortIndex)
void	setStartSubWorkpageContainerId(String startSubWorkpageContainerId)
void	setText(String value)
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

Methods inherited from class java.lang.Object

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

Constructor Details

WorkpageStartInfo

public WorkpageStartInfo()

Method Details

createClone

public WorkpageStartInfo createClone()

getJspPage

public 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(String value)

Specified by:

setJspPage in interface IWorkpageStartInfo

getFunctionClassName

public 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(String functionClassName)

Specified by:

setFunctionClassName in interface IWorkpageStartInfo

getPageBeanName

public 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(String pageBeanName)

Specified by:

setPageBeanName in interface IWorkpageStartInfo

getImage

public 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(String value)

Specified by:

setImage in interface IWorkpageStartInfo

getText

public 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(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 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(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 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(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 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(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(String paramName,
 String paramValue)

Specified by:

setParam in interface IWorkpageStartInfo

getParam

public String getParam(String paramName)

Specified by:

getParam in interface IWorkpageStartInfo

removeParam

public void removeParam(String paramName)

Specified by:

removeParam in interface IWorkpageStartInfo

getParamMap

public Map<String,String> getParamMap()

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

Specified by:

getParamMap in interface IWorkpageStartInfo

setParamMap

public void setParamMap(Map<String,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 String getStartSubWorkpageContainerId()

Id of the wokrpage container in which the page should be started.

Specified by:

getStartSubWorkpageContainerId in interface IWorkpageStartInfo

setStartSubWorkpageContainerId

public void setStartSubWorkpageContainerId(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 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(String comment)

Specified by:

setComment in interface IWorkpageStartInfo

getCommentImage

public 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(String commentImage)

Specified by:

setCommentImage in interface IWorkpageStartInfo

getCode

public 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(String code)

Specified by:

setCode in interface IWorkpageStartInfo

getAppReference1

public 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(String appReference1)

Specified by:

setAppReference1 in interface IWorkpageStartInfo

getAppReference2

public 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(String appReference2)

Specified by:

setAppReference2 in interface IWorkpageStartInfo

getAppReference3

public 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(String appReference3)

Specified by:

setAppReference3 in interface IWorkpageStartInfo

getSelectorBgpaint

public String getSelectorBgpaint()

Background painting that is applied to the selector.

Specified by:

getSelectorBgpaint in interface IWorkpageStartInfo

setSelectorBgpaint

public void setSelectorBgpaint(String selectorBgpaint)

Specified by:

setSelectorBgpaint in interface IWorkpageStartInfo

getClientName

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

setClientName

public void setClientName(String clientName)

getSortIndex

public int getSortIndex()

See: IWorkpage.getSortIndex()

Specified by:

getSortIndex in interface IWorkpageStartInfo

setSortIndex

public void setSortIndex(int sortIndex)