Package com.dassault_systemes.catjdialog

   
Class CATTreeNodeInfo

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catjdialog.CATTreeNodeInfo
Class Location

Framework : CATJDialog

Module : CATJDialog

Class Description

public class CATTreeNodeInfo

The tree node info data structure.

This data structure class is returned by tree data models (CATKeyTreeModel and CATKeyPathTreeModel) and contains all node information.

See Also:
com.dassault_systemes.catjdialog.CATKeyTreeModel#getNodeInfo(String, boolean)
com.dassault_systemes.catjdialog.CATKeyPathTreeModel#getNodeInfo(CATDialog, String[], boolean)
Field Summary

Constructor Summary
CATTreeNodeInfo(boolean iIsExpandable)
CATTreeNodeInfo(boolean iIsExpandable, String iLabel)
CATTreeNodeInfo(boolean iIsExpandable, String iLabel, String iIcon)

Method Summary
void setLabel(String iLabel)
void setIcon(String iIcon)
void setChildrenKeys(String[] iKeys)
String getLabel()
String getIcon()
boolean isExpandable()
String[] getChildrenKeys()


Field Detail

Constructor Detail

CATTreeNodeInfo

    CATTreeNodeInfo(boolean iIsExpandable)

Creates a tree node info.

Parameters:
iIsExpandable
Tells whether this node is a expandable (with a 'plus' icon) or not.

CATTreeNodeInfo

    CATTreeNodeInfo(boolean iIsExpandable, String iLabel)

Creates a tree node info.

Parameters:
iIsExpandable
Tells whether this node is a expandable or not.
iLabel
The node label that will be displayed.

CATTreeNodeInfo

    CATTreeNodeInfo(boolean iIsExpandable, String iLabel, String iIcon)

Creates a tree node info.

Parameters:
iIsExpandable
Tells whether this node is a expandable or not.
iLabel
The node label that will be displayed.
iIcon
The node icon URL. This can be either a relative path from the resources/graphic directory of the runtime view, or an absolute URL to the icon.

Method Detail

setLabel

    void setLabel(String iLabel)

Sets the node label.

Parameters:
iLabel
The node label that will be displayed.

setIcon

    void setIcon(String iIcon)

Sets the node icon.

Parameters:
iIcon
The node icon URL. This can be either a relative path from the resources/graphic directory of the runtime view, or an absolute URL to the icon.

setChildrenKeys

    void setChildrenKeys(String[] iKeys)

Sets the children nodes keys.

This is only required when the framework explicitely requires for them (through the boolean argument of the getNodeInfo() method).

Parameters:
iKeys
The string array of children nodes keys. A null value means "no child".
See Also:
CATKeyTreeModel#getNodeInfo(String, boolean)
CATKeyPathTreeModel#getNodeInfo(CATDialog, String[], boolean)

getLabel

    String getLabel()

Returns the node label.

Returns:
The node label.

getIcon

    String getIcon()

Returns the node icon URI.

Returns:
The node icon URI. This can be either a relative path from the resources/graphic directory of the runtime view, or an absolute URL to the icon.

isExpandable

    boolean isExpandable()

Determines whether this node is a expandable or not.

Returns:
true if the node is expandable; false otherwise.

getChildrenKeys

    String[] getChildrenKeys()

Returns the node children keys.

Returns:
The string array of node children keys.


Copyright © 2000, Dassault Systèmes. All rights reserved