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.
NodeDescriptor
s represent objects on a
user interface panel as displayed in a tree view.
-
NodeDescriptor()
- Constructs a
NodeDescriptor
.
-
NodeDescriptor(String, String, String)
- Constructs a
NodeDescriptor
with the specified
name and title, and image file.
-
NodeDescriptor(String, String, String, boolean)
- Constructs a
NodeDescriptor
with the specified
name and title, and image file.
-
NodeDescriptor(String, String, String, HandlerTask[])
- Constructs a
NodeDescriptor
with the specified
name, title, image file and HandlerTask
list.
-
addHandlerTask(HandlerTask)
- Adds a
HandlerTask
to the node.
-
getImageFile()
- Returns the node image file name.
-
getName()
- Returns the node name.
-
getTitle()
- Returns the node title.
-
isLeaf()
- Determines whether this node is a leaf.
-
removeHandlerTask(HandlerTask)
- Removes a
HandlerTask
from the node.
-
setImageFile(String)
- Sets the node image file name.
-
setLeaf(boolean)
- Indicates whether this node is a leaf, depending on the value of parameter
isLeaf
.
-
setName(String)
- Sets the node name.
-
setTitle(String)
- Sets the node title.
-
toString()
- Returns a string representation of the node.
NodeDescriptor
public NodeDescriptor()
- Constructs a
NodeDescriptor
.
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
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
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
HandlerTask
s which describe to
the UI framework actions which should be carried out when the node is selected
getName
public String getName()
- Returns the node name.
- Returns:
- a string which is used to identify the node programmatically
- See Also:
- setName
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
getTitle
public String getTitle()
- Returns the node title.
- Returns:
- the string which is displayed to the user
- See Also:
- setTitle
setTitle
public void setTitle(String title)
- Sets the node title.
- Parameters:
- title - the string which is displayed to the user
- See Also:
- getTitle
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
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
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
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
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
isLeaf
public boolean isLeaf()
- Determines whether this node is a leaf.
- Returns:
- true if the node is a leaf; false otherwise.
- See Also:
- setLeaf
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