All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.ui.framework.java.NodeDescriptor

java.lang.Object
   |
   +----com.ibm.as400.ui.framework.java.NodeDescriptor

public class NodeDescriptor
extends Object
Describes an item in a tree. NodeDescriptors represent objects on a user interface panel as displayed in a tree view.


Constructor Index

 o NodeDescriptor()
Constructs a NodeDescriptor.
 o NodeDescriptor(String, String, String)
Constructs a NodeDescriptor with the specified name and title, and image file.
 o NodeDescriptor(String, String, String, boolean)
Constructs a NodeDescriptor with the specified name and title, and image file.
 o NodeDescriptor(String, String, String, HandlerTask[])
Constructs a NodeDescriptor with the specified name, title, image file and HandlerTask list.

Method Index

 o addHandlerTask(HandlerTask)
Adds a HandlerTask to the node.
 o getImageFile()
Returns the node image file name.
 o getName()
Returns the node name.
 o getTitle()
Returns the node title.
 o isLeaf()
Determines whether this node is a leaf.
 o removeHandlerTask(HandlerTask)
Removes a HandlerTask from the node.
 o setImageFile(String)
Sets the node image file name.
 o setLeaf(boolean)
Indicates whether this node is a leaf, depending on the value of parameter isLeaf.
 o setName(String)
Sets the node name.
 o setTitle(String)
Sets the node title.
 o toString()
Returns a string representation of the node.

Constructors

 o NodeDescriptor
 public NodeDescriptor()
Constructs a NodeDescriptor.

 o NodeDescriptor
 public NodeDescriptor(String name,
                       String title,
                       String imageFile)
Constructs a NodeDescriptor with the specified name and title, and image file.

Parameters:
name - the name that is used to identify the node programmatically
title - the title of the node in a form suitable for displaying to the user
imageFile - the name of the image resource that will be used to create the icon for the node
 o NodeDescriptor
 public NodeDescriptor(String name,
                       String title,
                       String imageFile,
                       boolean isLeaf)
Constructs a NodeDescriptor with the specified name and title, and image file. This constructor provides an additional parameter for indicating whether this node is a leaf.

Parameters:
name - the name that is used to identify the node programmatically
title - the title of the node in a form suitable for displaying to the user
imageFile - the name of the image resource that will be used to create the icon for the node
isLeaf - indicates node is a leaf if true
 o NodeDescriptor
 public NodeDescriptor(String name,
                       String title,
                       String imageFile,
                       HandlerTask handlerTasks[])
Constructs a NodeDescriptor with the specified name, title, image file and HandlerTask list.

Parameters:
name - the name that is used to identify the node programmatically
title - the title of the node in a form suitable for displaying to the user
imageFile - the name of the image resource that will be used to create the icon for the node
handlerTasks - a list of HandlerTasks which describe to the UI framework actions which should be carried out when the node is selected

Methods

 o getName
 public String getName()
Returns the node name.

Returns:
a string which is used to identify the node programmatically
See Also:
setName
 o setName
 public void setName(String name)
Sets the node name.

Parameters:
name - a string which is used to identify the node programmatically
See Also:
getName
 o getTitle
 public String getTitle()
Returns the node title.

Returns:
the string which is displayed to the user
See Also:
setTitle
 o setTitle
 public void setTitle(String title)
Sets the node title.

Parameters:
title - the string which is displayed to the user
See Also:
getTitle
 o getImageFile
 public String getImageFile()
Returns the node image file name.

Returns:
the name of the image resource that will be used to create the icon for the node
See Also:
setImageFile
 o setImageFile
 public void setImageFile(String imageFile)
Sets the node image file name.

Parameters:
imageFile - the name of the image resource that will be used to create the icon for the node
See Also:
getImageFile
 o addHandlerTask
 public void addHandlerTask(HandlerTask task)
Adds a HandlerTask to the node. A HandlerTask is an action that should be performed by the UI framework when the node is selected.

Parameters:
task - the task to be performed
See Also:
removeHandlerTask, HandlerTask
 o removeHandlerTask
 public void removeHandlerTask(HandlerTask task)
Removes a HandlerTask from the node. If the specified HandlerTask is not associated with the node, no action occurs.

Parameters:
task - the task to be removed
See Also:
addHandlerTask, HandlerTask
 o setLeaf
 public void setLeaf(boolean isLeaf)
Indicates whether this node is a leaf, depending on the value of parameter isLeaf.

Parameters:
isLeaf - If true, node will be displayed as a leaf; otherwise, node will displayed as a container.
See Also:
isLeaf
 o isLeaf
 public boolean isLeaf()
Determines whether this node is a leaf.

Returns:
true if the node is a leaf; false otherwise.
See Also:
setLeaf
 o toString
 public String toString()
Returns a string representation of the node. The string is in a form suitable for displaying to the user.

Returns:
the node as a string
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index