metadone.client.grasyla2.swing.TreeNode Class Reference

Inheritance diagram for metadone.client.grasyla2.swing.TreeNode:

Collaboration diagram for metadone.client.grasyla2.swing.TreeNode:

List of all members.

Public Member Functions
void	setUserObject (Object userObject)
JComponent	getUserObject ()
String	toString ()
abstract void	buildChildren () throws BadPreCondition
void	disposeChildren () throws BadPreCondition
abstract GrasylaEngine	getEngine ()
DefaultTreeModel	getModel ()
void	setModel (DefaultTreeModel model)
Package Functions
void	eventWillExpand ()
void	eventWillCollapse ()
Private Attributes
DefaultTreeModel	model
Static Private Attributes
static final Logger	logger = Logger.getLogger(TreeNode.class)
static final long	serialVersionUID = 1L

---

Detailed Description

A tree node for Grasyla.

The user object is a JComponent.

This class is aware of the collapse and expand events and is able to load children on demand. Moreover, it has a reference to the model, so it can fire the change events.

Author:

kma

---

Member Function Documentation

abstract void metadone.client.grasyla2.swing.TreeNode.buildChildren

(

)

throws BadPreCondition [pure virtual]

Builds the children of this node.

Called when the node is expanded or shown. It can be called multiple times, the following calls should be aware that the old children may still be in the node.

Exceptions:

BadPreCondition

Implemented in metadone.client.grasyla2.swing.JTreeNodeEngine.GrasylaTreeNode.

Referenced by metadone.client.grasyla2.swing.TreeNode.eventWillExpand().

void metadone.client.grasyla2.swing.TreeNode.disposeChildren

(

)

throws BadPreCondition

Removes the children of this node.

Called when the node is hidden and its children don't have to be shown anymore.

Exceptions:

BadPreCondition

Reimplemented in metadone.client.grasyla2.swing.JTreeNodeEngine.GrasylaTreeNode.

Referenced by metadone.client.grasyla2.swing.TreeNode.eventWillCollapse().

void metadone.client.grasyla2.swing.TreeNode.eventWillCollapse

(

)

[package]

Called when the tree will collapse this node.

References metadone.util.Objects.cast(), metadone.client.grasyla2.swing.TreeNode.disposeChildren(), and metadone.client.grasyla2.swing.TreeNode.logger.

Referenced by metadone.client.grasyla2.swing.JTreeEngine.evaluateComponent().

void metadone.client.grasyla2.swing.TreeNode.eventWillExpand

(

)

[package]

Called when the tree will expand this node.

References metadone.client.grasyla2.swing.TreeNode.buildChildren(), metadone.util.Objects.cast(), and metadone.client.grasyla2.swing.TreeNode.logger.

Referenced by metadone.client.grasyla2.swing.JTreeEngine.evaluateComponent().

abstract GrasylaEngine metadone.client.grasyla2.swing.TreeNode.getEngine

(

)

[pure virtual]

Gets the related engine that has built this node.

Returns:

The engine

Implemented in metadone.client.grasyla2.swing.JTreeNodeEngine.GrasylaTreeNode.

Referenced by metadone.client.grasyla2.swing.JTreeEngine.evaluateComponent().

DefaultTreeModel metadone.client.grasyla2.swing.TreeNode.getModel

(

)

Gets the tree model for this node.

If a model is not defined for this node, the parent nodes are checked.

Returns:

The model or null

References metadone.util.Objects.cast(), metadone.client.grasyla2.swing.TreeNode.getModel(), and metadone.client.grasyla2.swing.TreeNode.model.

Referenced by metadone.client.grasyla2.swing.TreeNode.getModel().

JComponent metadone.client.grasyla2.swing.TreeNode.getUserObject

(

)

Referenced by metadone.client.grasyla2.swing.TreeNode.toString().

void metadone.client.grasyla2.swing.TreeNode.setModel

(

DefaultTreeModel

model

)

Sets the model for this node.

Parameters:

model

The new model or null

References metadone.client.grasyla2.swing.TreeNode.model.

Referenced by metadone.client.grasyla2.swing.JTreeEngine.evaluateComponent().

void metadone.client.grasyla2.swing.TreeNode.setUserObject

(

Object

userObject

)

Sets the user's object.

The object must be an instance of JComponent.

Parameters:

userObject

The object

Referenced by metadone.client.grasyla2.swing.JTreeNodeEngine.JTreeNodeEngine().

String metadone.client.grasyla2.swing.TreeNode.toString

(

)

References metadone.client.grasyla2.swing.TreeNode.getUserObject().

---

Member Data Documentation

final Logger metadone.client.grasyla2.swing.TreeNode.logger = Logger.getLogger(TreeNode.class) [static, private]

Referenced by metadone.client.grasyla2.swing.TreeNode.eventWillCollapse(), and metadone.client.grasyla2.swing.TreeNode.eventWillExpand().

DefaultTreeModel metadone.client.grasyla2.swing.TreeNode.model [private]

Referenced by metadone.client.grasyla2.swing.TreeNode.getModel(), and metadone.client.grasyla2.swing.TreeNode.setModel().

final long metadone.client.grasyla2.swing.TreeNode.serialVersionUID = 1L [static, private]

Reimplemented in metadone.client.grasyla2.swing.JTreeNodeEngine.GrasylaTreeNode.

---

The documentation for this class was generated from the following file:

• metadone_bundle_client/src/metadone/client/grasyla2/swing/TreeNode.java