Package org.eclnt.workplace

Class WorkplaceFunctionTree.FunctionNode

java.lang.Object

org.eclnt.jsfserver.elements.impl.FIXGRIDItem

org.eclnt.jsfserver.elements.impl.FIXGRIDTreeItem

org.eclnt.workplace.WorkplaceFunctionTree.FunctionNode

All Implemented Interfaces:

Serializable, Comparable, IFIXGRIDItem, IWorkpageStartInfo

Enclosing class:

WorkplaceFunctionTree

public class WorkplaceFunctionTree.FunctionNode
extends FIXGRIDTreeItem
implements IWorkpageStartInfo, Serializable

Represents function in function tree. The node is either a folgder node - then it just provides a text and (optionally) an image. Or it is a node containing workpage start information.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.eclnt.jsfserver.elements.impl.FIXGRIDTreeItem

STATUS_CLOSED, STATUS_ENDNODE, STATUS_OPENED

Fields inherited from class org.eclnt.jsfserver.elements.impl.FIXGRIDItem

ROWHEIGHT_DEFAULT

Constructor Summary

Constructors

Constructor	Description
FunctionNode(FIXGRIDTreeItem parentNode)	This constructor is used when creating folder nodes.
FunctionNode(FIXGRIDTreeItem parentNode, String page)	This constructor is used when creating page nodes - containing start information.
FunctionNode(FIXGRIDTreeItem parentNode, WorkpageStartInfo wpsi)

Method Summary

Modifier and Type	Method	Description
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()
boolean	getCloseSupported()
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.
String	getDragSend()	Returns drag-send information of the node.
String	getDropReceive()
boolean	getExcludeFromSavePerspective()
String	getFunctionClassName()
String	getId()
String	getImage()
String	getJspPage()
boolean	getOpenAsPopupByDefault()
boolean	getOpenMultipleInstances()
boolean	getOverlayAreaRendered()
String	getPageBeanName()
String	getParam(String paramName)
Map<String,String>	getParamMap()
boolean	getPopupSuppoted()
String	getSelectorBgpaint()
String	getSelectorTitle()
int	getSortIndex()	See: IWorkpage.getSortIndex()
String	getStartSubWorkpageContainerId()
String	getText()
String	getTextOriginal()	The text may be an expression.
String	getTooltip()
String	getWindowTitle()
WorkpageStartInfo	getWorkpageStartInfo()
boolean	isDecorated()
void	onRowExecute()	Reaction on row executions in the client (double click, return key selection).
void	onRowSelect()	Reaction on row selections in the client.
void	onStartInNewBrowser(ActionEvent event)
void	onToggle()	Event that is passed from the client when the user open/close a folder node.
void	processTREENDOEAction(ActionEvent event)	This is the central method that is called by default by client side TREENODE events.
void	removeParam(String paramName)
void	setAppReference1(String appReference1)
void	setAppReference2(String appReference2)
void	setAppReference3(String appReference3)
void	setClientName(String clientName)
void	setCloseSupported(boolean value)
void	setCode(String code)
void	setComment(String comment)
void	setCommentImage(String commentImage)
void	setDecorated(boolean value)
void	setDragSend(String value)	You can explicitly add drag-send information to the node.
void	setDropReceive(String value)	You can explicitly set the DROPRECEIVE statement within the function node - so that you can drag&drop information into the workplace function tree.
void	setExcludeFromSavePerspective(boolean excludeFromSavePerspective)
void	setFunctionClassName(String functionClassName)
void	setId(String value)
void	setImage(String value)	Sets the image that is rendered for the node.
void	setJspPage(String jspPage)
void	setNodeTooltip(String nodeTooltip)
void	setOpenAsPopupByDefault(boolean value)
void	setOpenMultipleInstances(boolean value)
void	setPageBeanName(String pageBeanName)
void	setParam(String paramName, String paramValue)
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 value)
void	setText(String value)	Sets the text of the node.
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.jsfserver.elements.impl.FIXGRIDTreeItem

addSubNode, addSubNode, appendVisibleSubNodes, checkIfNodeHasAsParent, closeAllNodes, collapseNode, collapseNodeAndSubNodes, compareTo, expandNode, expandNodeAndSubNodes, getAllContainedNodes, getChildNodes, getLevel, getLevelInt, getLineDrawing, getParentNode, getRequestfocus, getStatus, getStatusInt, getTextForExport, moveSubNodeBehind, moveSubNodeInFront, moveSubNodeOneDown, moveSubNodeOneUp, moveSubNodesOneDown, moveSubNodesOneUp, moveSubNodeToFirst, moveSubNodeToLast, openAllParentNodes, removeAllChildNodes, removeAllChildNodes, removeNode, requestFocus, setLevel, setStatus, toggleNode, toggleNodeAndScroll

Methods inherited from class org.eclnt.jsfserver.elements.impl.FIXGRIDItem

assignRowComponent, checkIfCellIsHighlighted, checkIfCellsAreHighlighted, getChangeIndex, getHighlightedCells, getOriginalIndex, getRequestFocus, getRowHeight, getSelected, highlightCell, onRowDeselect, onRowDrop, onRowPopupMenuItem, onRowPopupMenuLoad, setOriginalIndex, setRowHeight, setSelected, unhighlightAllCells, unhighlightCell, unrequestFocus, updateSelectedInternally

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionNode

public FunctionNode(FIXGRIDTreeItem parentNode)

This constructor is used when creating folder nodes.

FunctionNode

public FunctionNode(FIXGRIDTreeItem parentNode,
 String page)

This constructor is used when creating page nodes - containing start information.

FunctionNode

public FunctionNode(FIXGRIDTreeItem parentNode,
 WorkpageStartInfo wpsi)

Method Details

processTREENDOEAction

public void processTREENDOEAction(ActionEvent event)

Description copied from class: FIXGRIDTreeItem

This is the central method that is called by default by client side TREENODE events. It automatically handles the event "toggle". In case of enhancing a TREENODE (e.g. adding drag & drop onto TREENODE level) you need to override this method and add the behavior for the specific event. In any case you need to call this super-implementation within your implementation!

Overrides:

processTREENDOEAction in class FIXGRIDTreeItem

setClientName

public void setClientName(String clientName)

setDecorated

public void setDecorated(boolean value)

Specified by:

setDecorated in interface IWorkpageStartInfo

setOpenMultipleInstances

public void setOpenMultipleInstances(boolean value)

Specified by:

setOpenMultipleInstances in interface IWorkpageStartInfo

getWindowTitle

public String getWindowTitle()

Specified by:

getWindowTitle in interface IWorkpageStartInfo

isDecorated

public boolean isDecorated()

Specified by:

isDecorated in interface IWorkpageStartInfo

getOpenMultipleInstances

public boolean getOpenMultipleInstances()

Specified by:

getOpenMultipleInstances in interface IWorkpageStartInfo

getOpenAsPopupByDefault

public boolean getOpenAsPopupByDefault()

Specified by:

getOpenAsPopupByDefault in interface IWorkpageStartInfo

getJspPage

public String getJspPage()

Specified by:

getJspPage in interface IWorkpageStartInfo

getId

public String getId()

Specified by:

getId in interface IWorkpageStartInfo

getParam

public String getParam(String paramName)

Specified by:

getParam in interface IWorkpageStartInfo

getParamMap

public Map<String,String> getParamMap()

Specified by:

getParamMap in interface IWorkpageStartInfo

setFunctionClassName

public void setFunctionClassName(String functionClassName)

Specified by:

setFunctionClassName in interface IWorkpageStartInfo

getFunctionClassName

public String getFunctionClassName()

Specified by:

getFunctionClassName in interface IWorkpageStartInfo

getSortIndex

public int getSortIndex()

Description copied from interface: IWorkpageStartInfo

See: IWorkpage.getSortIndex()

Specified by:

getSortIndex in interface IWorkpageStartInfo

getClientName

public String getClientName()

Specified by:

getClientName in interface IWorkpageStartInfo

onRowExecute

public void onRowExecute()

Description copied from class: FIXGRIDItem

Reaction on row executions in the client (double click, return key selection).

Specified by:

onRowExecute in interface IFIXGRIDItem

Overrides:

onRowExecute in class FIXGRIDItem

onToggle

public void onToggle()

Description copied from class: FIXGRIDTreeItem

Event that is passed from the client when the user open/close a folder node. You may read sub-items into the tree as reaction. OVerride this method in your implementation.

Overrides:

onToggle in class FIXGRIDTreeItem

onRowSelect

public void onRowSelect()

Description copied from class: FIXGRIDItem

Reaction on row selections in the client. Override this method for specific reactions.

Specified by:

onRowSelect in interface IFIXGRIDItem

Overrides:

onRowSelect in class FIXGRIDItem

onStartInNewBrowser

public void onStartInNewBrowser(ActionEvent event)

getDragSend

public String getDragSend()

Returns drag-send information of the node. Please note this is not a 100% counter-part of setDragSend(String): each node may get assigned some workplace-internal drag-send information in addition to what you may pass within the setDragSend method.

setText

public void setText(String value)

Description copied from class: FIXGRIDTreeItem

Sets the text of the node.

Specified by:

setText in interface IWorkpageStartInfo

Overrides:

setText in class FIXGRIDTreeItem

setImage

public void setImage(String value)

Description copied from class: FIXGRIDTreeItem

Sets the image that is rendered for the node. Setting the image is optional.

Specified by:

setImage in interface IWorkpageStartInfo

Overrides:

setImage in class FIXGRIDTreeItem

setId

public void setId(String value)

Specified by:

setId in interface IWorkpageStartInfo

getText

public String getText()

Specified by:

getText in interface IWorkpageStartInfo

Overrides:

getText in class FIXGRIDTreeItem

getTextOriginal

public String getTextOriginal()

The text may be an expression. While getText() returns the resolved expression, this method returns the original text.

getImage

public String getImage()

Specified by:

getImage in interface IWorkpageStartInfo

Overrides:

getImage in class FIXGRIDTreeItem

setParam

public void setParam(String paramName,
 String paramValue)

Specified by:

setParam in interface IWorkpageStartInfo

removeParam

public void removeParam(String paramName)

Specified by:

removeParam in interface IWorkpageStartInfo

setJspPage

public void setJspPage(String jspPage)

Specified by:

setJspPage in interface IWorkpageStartInfo

setPopupSupported

public void setPopupSupported(boolean value)

Specified by:

setPopupSupported in interface IWorkpageStartInfo

setCloseSupported

public void setCloseSupported(boolean value)

Specified by:

setCloseSupported in interface IWorkpageStartInfo

setOpenAsPopupByDefault

public void setOpenAsPopupByDefault(boolean value)

Specified by:

setOpenAsPopupByDefault 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

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

setDropReceive

public void setDropReceive(String value)

You can explicitly set the DROPRECEIVE statement within the function node - so that you can drag&drop information into the workplace function tree.

getDropReceive

public String getDropReceive()

setDragSend

public void setDragSend(String value)

You can explicitly add drag-send information to the node.

getWorkpageStartInfo

public WorkpageStartInfo getWorkpageStartInfo()

setStartSubWorkpageContainerId

public void setStartSubWorkpageContainerId(String value)

Specified by:

setStartSubWorkpageContainerId in interface IWorkpageStartInfo

getPopupSuppoted

public boolean getPopupSuppoted()

Specified by:

getPopupSuppoted in interface IWorkpageStartInfo

getCloseSupported

public boolean getCloseSupported()

Specified by:

getCloseSupported in interface IWorkpageStartInfo

getStartSubWorkpageContainerId

public String getStartSubWorkpageContainerId()

Specified by:

getStartSubWorkpageContainerId in interface IWorkpageStartInfo

getSelectorTitle

public String getSelectorTitle()

Specified by:

getSelectorTitle in interface IWorkpageStartInfo

getSelectorBgpaint

public String getSelectorBgpaint()

Specified by:

getSelectorBgpaint in interface IWorkpageStartInfo

setSelectorBgpaint

public void setSelectorBgpaint(String selectorBgpaint)

Specified by:

setSelectorBgpaint in interface IWorkpageStartInfo

setPageBeanName

public void setPageBeanName(String pageBeanName)

Specified by:

setPageBeanName in interface IWorkpageStartInfo

getPageBeanName

public String getPageBeanName()

Specified by:

getPageBeanName in interface IWorkpageStartInfo

setNodeTooltip

public void setNodeTooltip(String nodeTooltip)

getTooltip

public String getTooltip()

getExcludeFromSavePerspective

public boolean getExcludeFromSavePerspective()

Specified by:

getExcludeFromSavePerspective in interface IWorkpageStartInfo

setExcludeFromSavePerspective

public void setExcludeFromSavePerspective(boolean excludeFromSavePerspective)

Specified by:

setExcludeFromSavePerspective in interface IWorkpageStartInfo

getComment

public String getComment()

Description copied from interface: IWorkpageStartInfo

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()

Description copied from interface: IWorkpageStartInfo

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()

Description copied from interface: IWorkpageStartInfo

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()

Description copied from interface: IWorkpageStartInfo

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()

Description copied from interface: IWorkpageStartInfo

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()

Description copied from interface: IWorkpageStartInfo

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

getOverlayAreaRendered

public boolean getOverlayAreaRendered()