LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view.win.swing.component
Interface LyJTreeElement

All Known Implementing Classes:
LyJTreeElementEntryImpl, LyJTreeElementImpl, LySwingLine

public interface LyJTreeElement

This interface defines an object than can be drawn in a tree.

See Also:
LyTree

Field Summary
static java.lang.String __VERSION
           
 
Method Summary
 void changeValidity()
          Changes the validity of the node in a three step mode: toggles the validity of the node and restores its default if this is a parent node on the third click.
 java.util.Vector<java.awt.Image> getAdditionalImages()
          Gets the list of the additional images of this tree node.
 java.awt.Color getColor()
          Gets the background color of this tree node.
 LyJTreeElementImpl._LyNodeContent getContent()
          Gets this node content.
 java.awt.Image getEmptyCheckboxImage()
          Gets the image for the empty checkbox.
 LyEnvironment getEnvironment()
          Gets this tree node's environment.
 java.awt.Font getFont()
          Gets the font of this tree node.
 java.awt.Color getFontColor()
          Gets the foreground color of this tree node.
 int getHeightFactor()
          Gets the height factor of this tree node.
 java.lang.String getId()
          Gets this tree node identifier.
 java.lang.String getLabel()
          Gets this tree node label.
 javax.swing.tree.DefaultMutableTreeNode getMutableTreeNode()
          Gets the mutable tree node object related to the current node.
 java.awt.Image getSelectedCheckboxImage()
          Gets the image for the selected checkbox.
 java.awt.Color getSelectedColor()
          Gets the background color of this tree node when selected.
 java.awt.Color getSelectedFontColor()
          Gets the font color of this tree node when selected.
 LyJTreeComponent getTree()
          Gets this tree node component.
 javax.swing.tree.TreePath getTreePath()
          Gets the path to go to the mutable tree node.
 int getValidityImageIndex()
          Gets the index of the validity image in this tree element.
 java.awt.Rectangle getValidityRectangle()
          Gets the validity rectangle of this tree node.
 boolean isOpen()
          Indicates that this tree node is opened.
 boolean isSelected()
          Indicates that this tree node is selected.
 void setTree(LyJTreeComponent tree)
          Sets this tree node component.
 void setValidityRectangle(java.awt.Rectangle rect)
          Sets the validity rectangle of this tree node.
 void treeCollapsed(javax.swing.event.TreeExpansionEvent event)
          Called whenever an item in the tree has been collapsed.
 void treeExpanded(javax.swing.event.TreeExpansionEvent event)
          Called whenever an item in the tree has been expanded.
 

Field Detail

__VERSION

static final java.lang.String __VERSION
See Also:
Constant Field Values
Method Detail

getMutableTreeNode

javax.swing.tree.DefaultMutableTreeNode getMutableTreeNode()
Gets the mutable tree node object related to the current node.

Returns:
the mutable tree node of this tree element

getTreePath

javax.swing.tree.TreePath getTreePath()
Gets the path to go to the mutable tree node.

Returns:
the tree path of this tree element

getContent

LyJTreeElementImpl._LyNodeContent getContent()
Gets this node content.

Returns:
the content of this node

setTree

void setTree(LyJTreeComponent tree)
Sets this tree node component.

Parameters:
tree - the new tree component
See Also:
getTree()

getTree

LyJTreeComponent getTree()
Gets this tree node component.

Returns:
this tree component
See Also:
setTree(LyJTreeComponent)

getEnvironment

LyEnvironment getEnvironment()
Gets this tree node's environment.

Returns:
the tree node environment

getId

java.lang.String getId()
Gets this tree node identifier.

Returns:
the id of this tree node

getLabel

java.lang.String getLabel()
Gets this tree node label.

Returns:
the label of this tree node

isSelected

boolean isSelected()
Indicates that this tree node is selected.

Returns:
true if this tree node is selected, false otherwise

isOpen

boolean isOpen()
Indicates that this tree node is opened.

Returns:
true if this tree node is opened, false otherwise

getHeightFactor

int getHeightFactor()
Gets the height factor of this tree node.

Returns:
the height factor

treeExpanded

void treeExpanded(javax.swing.event.TreeExpansionEvent event)
Called whenever an item in the tree has been expanded.

Parameters:
event - the event generated by the expansion

treeCollapsed

void treeCollapsed(javax.swing.event.TreeExpansionEvent event)
Called whenever an item in the tree has been collapsed.

Parameters:
event - the event generated by the collapse

getSelectedCheckboxImage

java.awt.Image getSelectedCheckboxImage()
Gets the image for the selected checkbox.

Returns:
the selected checkbox image

getEmptyCheckboxImage

java.awt.Image getEmptyCheckboxImage()
Gets the image for the empty checkbox.

Returns:
the empty checkbox image

getAdditionalImages

java.util.Vector<java.awt.Image> getAdditionalImages()
Gets the list of the additional images of this tree node.

Returns:
the list of the additional images

getValidityImageIndex

int getValidityImageIndex()
Gets the index of the validity image in this tree element.

Returns:
the index of the validity image, or -1 if there is none

setValidityRectangle

void setValidityRectangle(java.awt.Rectangle rect)
Sets the validity rectangle of this tree node.

Parameters:
rect - the rectangle where this tree node is valid
See Also:
getValidityRectangle()

getValidityRectangle

java.awt.Rectangle getValidityRectangle()
Gets the validity rectangle of this tree node.

Returns:
the rectangle where this tree node is valid
See Also:
setValidityRectangle(Rectangle)

getColor

java.awt.Color getColor()
Gets the background color of this tree node.

Returns:
the background color

getSelectedColor

java.awt.Color getSelectedColor()
Gets the background color of this tree node when selected.

Returns:
the background color when selected

getFontColor

java.awt.Color getFontColor()
Gets the foreground color of this tree node.

Returns:
the foreground color

getSelectedFontColor

java.awt.Color getSelectedFontColor()
Gets the font color of this tree node when selected.

Returns:
the font color when selected

getFont

java.awt.Font getFont()
Gets the font of this tree node.

Returns:
the font

changeValidity

void changeValidity()
Changes the validity of the node in a three step mode: toggles the validity of the node and restores its default if this is a parent node on the third click.


(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com