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:
-
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
ConstructorDescriptionFunctionNode
(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 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.boolean
getCode()
A short code for this item.Comment that is associated with this instance.Image that serves as additional comment to the image.Returns drag-send information of the node.boolean
getId()
getImage()
boolean
boolean
boolean
getText()
The text may be an expression.boolean
void
Reaction on row executions in the client (double click, return key selection).void
Reaction on row selections in the client.void
onToggle()
Event that is passed from the client when the user open/close a folder node.void
processTREENDOEAction
(javax.faces.event.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
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
void
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
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
void
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
-
Constructor Details
-
FunctionNode
This constructor is used when creating folder nodes. -
FunctionNode
This constructor is used when creating page nodes - containing start information. -
FunctionNode
-
-
Method Details
-
processTREENDOEAction
public void processTREENDOEAction(javax.faces.event.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 classFIXGRIDTreeItem
-
setClientName
-
setDecorated
public void setDecorated(boolean value) - Specified by:
setDecorated
in interfaceIWorkpageStartInfo
-
setOpenMultipleInstances
public void setOpenMultipleInstances(boolean value) - Specified by:
setOpenMultipleInstances
in interfaceIWorkpageStartInfo
-
getWindowTitle
- Specified by:
getWindowTitle
in interfaceIWorkpageStartInfo
-
isDecorated
public boolean isDecorated()- Specified by:
isDecorated
in interfaceIWorkpageStartInfo
-
getOpenMultipleInstances
public boolean getOpenMultipleInstances()- Specified by:
getOpenMultipleInstances
in interfaceIWorkpageStartInfo
-
getOpenAsPopupByDefault
public boolean getOpenAsPopupByDefault()- Specified by:
getOpenAsPopupByDefault
in interfaceIWorkpageStartInfo
-
getJspPage
- Specified by:
getJspPage
in interfaceIWorkpageStartInfo
-
getId
- Specified by:
getId
in interfaceIWorkpageStartInfo
-
getParam
- Specified by:
getParam
in interfaceIWorkpageStartInfo
-
setFunctionClassName
- Specified by:
setFunctionClassName
in interfaceIWorkpageStartInfo
-
getFunctionClassName
- Specified by:
getFunctionClassName
in interfaceIWorkpageStartInfo
-
getClientName
- Specified by:
getClientName
in interfaceIWorkpageStartInfo
-
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 interfaceIFIXGRIDItem
- Overrides:
onRowExecute
in classFIXGRIDItem
-
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 classFIXGRIDTreeItem
-
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 interfaceIFIXGRIDItem
- Overrides:
onRowSelect
in classFIXGRIDItem
-
getDragSend
Returns drag-send information of the node. Please note this is not a 100% counter-part ofsetDragSend(String)
: each node may get assigned some workplace-internal drag-send information in addition to what you may pass within the setDragSend method. -
setText
Description copied from class:FIXGRIDTreeItem
Sets the text of the node.- Specified by:
setText
in interfaceIWorkpageStartInfo
- Overrides:
setText
in classFIXGRIDTreeItem
-
setImage
Description copied from class:FIXGRIDTreeItem
Sets the image that is rendered for the node. Setting the image is optional.- Specified by:
setImage
in interfaceIWorkpageStartInfo
- Overrides:
setImage
in classFIXGRIDTreeItem
-
setId
- Specified by:
setId
in interfaceIWorkpageStartInfo
-
getText
- Specified by:
getText
in interfaceIWorkpageStartInfo
- Overrides:
getText
in classFIXGRIDTreeItem
-
getTextOriginal
The text may be an expression. While getText() returns the resolved expression, this method returns the original text. -
getImage
- Specified by:
getImage
in interfaceIWorkpageStartInfo
- Overrides:
getImage
in classFIXGRIDTreeItem
-
setParam
- Specified by:
setParam
in interfaceIWorkpageStartInfo
-
removeParam
- Specified by:
removeParam
in interfaceIWorkpageStartInfo
-
setJspPage
- Specified by:
setJspPage
in interfaceIWorkpageStartInfo
-
setPopupSupported
public void setPopupSupported(boolean value) - Specified by:
setPopupSupported
in interfaceIWorkpageStartInfo
-
setCloseSupported
public void setCloseSupported(boolean value) - Specified by:
setCloseSupported
in interfaceIWorkpageStartInfo
-
setOpenAsPopupByDefault
public void setOpenAsPopupByDefault(boolean value) - Specified by:
setOpenAsPopupByDefault
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
-
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
-
setDropReceive
You can explicitly set the DROPRECEIVE statement within the function node - so that you can drag&drop information into the workplace function tree. -
getDropReceive
-
setDragSend
You can explicitly add drag-send information to the node. -
getWorkpageStartInfo
-
setStartSubWorkpageContainerId
- Specified by:
setStartSubWorkpageContainerId
in interfaceIWorkpageStartInfo
-
getPopupSuppoted
public boolean getPopupSuppoted()- Specified by:
getPopupSuppoted
in interfaceIWorkpageStartInfo
-
getCloseSupported
public boolean getCloseSupported()- Specified by:
getCloseSupported
in interfaceIWorkpageStartInfo
-
getStartSubWorkpageContainerId
- Specified by:
getStartSubWorkpageContainerId
in interfaceIWorkpageStartInfo
-
getSelectorTitle
- Specified by:
getSelectorTitle
in interfaceIWorkpageStartInfo
-
getSelectorBgpaint
- Specified by:
getSelectorBgpaint
in interfaceIWorkpageStartInfo
-
setSelectorBgpaint
- Specified by:
setSelectorBgpaint
in interfaceIWorkpageStartInfo
-
setPageBeanName
- Specified by:
setPageBeanName
in interfaceIWorkpageStartInfo
-
getPageBeanName
- Specified by:
getPageBeanName
in interfaceIWorkpageStartInfo
-
setNodeTooltip
-
getTooltip
-
getExcludeFromSavePerspective
public boolean getExcludeFromSavePerspective()- Specified by:
getExcludeFromSavePerspective
in interfaceIWorkpageStartInfo
-
setExcludeFromSavePerspective
public void setExcludeFromSavePerspective(boolean excludeFromSavePerspective) - Specified by:
setExcludeFromSavePerspective
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setComment
- Specified by:
setComment
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setCommentImage
- Specified by:
setCommentImage
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setCode
- Specified by:
setCode
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setAppReference1
- Specified by:
setAppReference1
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setAppReference2
- Specified by:
setAppReference2
in interfaceIWorkpageStartInfo
-
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 interfaceIWorkpageStartInfo
-
setAppReference3
- Specified by:
setAppReference3
in interfaceIWorkpageStartInfo
-