se.entra.phantom.server

Class VirtualCTreeNode

java.lang.Object

se.entra.phantom.server.VirtualCTreeNode

public class VirtualCTreeNode
extends Object

Class holding nodes in the tree component on the server. Manipulating nodes is done through instances of this class. The class is thread-safe.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static VirtualCTreeNode[]	EMPTY_ARRAY An empty array of nodes.

Constructor Summary

Constructors

Constructor and Description
VirtualCTreeNode() Constructs the node without text, image, tooltip text and attachment.
VirtualCTreeNode(String text) Constructs the node with specified text.
VirtualCTreeNode(String text, Object attachment) Constructs the node with specified text and attachment.
VirtualCTreeNode(String text, String image) Constructs the node with specified text and image.
VirtualCTreeNode(String text, String image, Object attachment) Constructs the node with specified text, image and attachment.
VirtualCTreeNode(String text, String image, String tooltipText) Constructs the node with specified text, image and tooltip text.
VirtualCTreeNode(String text, String image, String tooltipText, Object attachment) Constructs the node with specified text, image, tooltip text and attachment.

Method Summary

Modifier and Type	Method and Description
boolean	add(int index, VirtualCTreeNode child) Adds a child node by inserting it at the specified position.
boolean	add(VirtualCTreeNode child) Adds a child node last of all children.
int	addAll(VirtualCTreeNode[] children) Adds all children node last of all children.
boolean	collapse() Collapses this node.
boolean	collapseAll() Collapses this node and all below it.
boolean	expand() Collapses this node.
boolean	expandAll() Collapses this node and all below it.
Object	getAttachment() Gets the attachment.
VirtualCTreeNode[]	getChildren() Gets the children nodes.
String	getImage() Get the image associated with the node.
VirtualCTreeNode	getParent() Gets the parent node.
Object	getSynchronizer() Gets the synchronize objects for the tree.
String	getText() Gets the text of this node.
String	getTooltipText() Get the tooltip associated with the node.
VirtualCTree	getTree() Gets the tree associated with this node.
boolean	isLeaf() Checks if this node is a leaf.
boolean	isRoot() Checks if this is the root node.
boolean	remove() Removes the node from the parent node.
boolean	remove(VirtualCTreeNode child) Removes a child node.
int	removeAll() Removes all children nodes.
void	setAttachment(Object attachment) Assigns the attachment.
boolean	setImage(String image) Set the image associated with the node.
boolean	setText(String text) Sets the text of this node.
boolean	setTooltipText(String tooltipText) Set or clears the tooltip text associated with the node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final VirtualCTreeNode[] EMPTY_ARRAY

An empty array of nodes.

Constructor Detail

VirtualCTreeNode

public VirtualCTreeNode()

Constructs the node without text, image, tooltip text and attachment.

VirtualCTreeNode

public VirtualCTreeNode(String text)

Constructs the node with specified text. No image, no tooltip text and no attachment is set.

VirtualCTreeNode

public VirtualCTreeNode(String text,
                        Object attachment)

Constructs the node with specified text and attachment. No image and no tooltip text is set.

VirtualCTreeNode

public VirtualCTreeNode(String text,
                        String image)

Constructs the node with specified text and image. No tooltip text and no attachment is set.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Parameters:

text - The text, or null for none.

image - The image, or null for none.

VirtualCTreeNode

public VirtualCTreeNode(String text,
                        String image,
                        String tooltipText)

Constructs the node with specified text, image and tooltip text. No attachment is set.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Parameters:

text - The text, or null for none.

image - The image, or null for none.

tooltipText - The tooltip text, or null for none.

VirtualCTreeNode

public VirtualCTreeNode(String text,
                        String image,
                        Object attachment)

Constructs the node with specified text, image and attachment. No tooltip text is set.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Parameters:

text - The text, or null for none.

image - The image, or null for none.

attachment - The custom attachment Object, can be null.

VirtualCTreeNode

public VirtualCTreeNode(String text,
                        String image,
                        String tooltipText,
                        Object attachment)

Constructs the node with specified text, image, tooltip text and attachment.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Parameters:

text - The text, or null for none.

image - The image, or null for none.

tooltipText - The tooltip text, or null for none.

attachment - The custom attachment Object, can be null.

Method Detail

getTree

public VirtualCTree getTree()

Gets the tree associated with this node. This method searches the node parents, so do not call this method too often (as it is not just getting a reference but performing a look-up, although this method is very fast).

Returns:

The tree component or null if the node is not added in tree.

getSynchronizer

public Object getSynchronizer()

Gets the synchronize objects for the tree. This is the VirtualSessionManager instance of the tree, if the node is added to the tree, otherwise a non-blocking object. This synchronizer object is used for all operations involving tree node manipulations.

Returns:

An object to use for synchronizing (as with the code synchronized(getSynchronizer()) {}).

getParent

public VirtualCTreeNode getParent()

Gets the parent node.

Returns:

The tree component or null if the node is not added in tree.

isRoot

public boolean isRoot()

Checks if this is the root node.

Returns:

true if it's the root node, false otherwise.

isLeaf

public boolean isLeaf()

Checks if this node is a leaf.

getChildren

public VirtualCTreeNode[] getChildren()

Gets the children nodes.

Returns:

An array of nodes. The size of the array is zero if this is a leaf.

add

public boolean add(VirtualCTreeNode child)

Adds a child node last of all children.

This method triggers a change in the tree to send updates to the client.

Parameters:

child - The child node.

Returns:

true for success, false if the node is not added because it is already added to another parent node, i.e. already in the tree.

addAll

public int addAll(VirtualCTreeNode[] children)

Adds all children node last of all children.

This method triggers a change in the tree to send updates to the client.

Parameters:

children - The children nodes.

Returns:

Count of children successfully added.

add

public boolean add(int index,
                   VirtualCTreeNode child)

Adds a child node by inserting it at the specified position.

This method triggers a change in the tree to send updates to the client.

Parameters:

index - The index, -1 to add it last.

child - The child node.

Throws:

IndexOutOfBoundsException - if the index is out of range.

UnsupportedOperationException - if the child is already added to a parent.

remove

public boolean remove()

Removes the node from the parent node.

This method triggers a change in the tree to send updates to the client.

Returns:

true for success, false if the node is not added to a parent.

remove

public boolean remove(VirtualCTreeNode child)

Removes a child node.

This method triggers a change in the tree to send updates to the client.

Parameters:

child - The child node.

Returns:

true for success, false if the node is not a child of this node.

removeAll

public int removeAll()

Removes all children nodes.

Returns:

Count of children removed.

setText

public boolean setText(String text)

Sets the text of this node.

Parameters:

text - The text of this node, null for none.

Returns:

true for a change in the text, false otherwise.

getText

public String getText()

Gets the text of this node.

Returns:

The text for the node, or empty String if none has been set.

setImage

public boolean setImage(String image)

Set the image associated with the node. If none is set, the tree shows the defined image for root, branch or leaf depending on the node type.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Parameters:

image - The image to use, or null to use default image for the tree component.

Returns:

true for change in image, false for no change.

getImage

public String getImage()

Get the image associated with the node. If none is set null is returned and the tree shows the defined image for root, branch or leaf depending on the node type.

Note: the image string can contain a tab character '\t', and if it does, the first image is the collapsed node image and the second the expanded node image. If no, the same image is used for both collapsed and expanded states.

Returns:

The image, or null for default image of the tree component.

setTooltipText

public boolean setTooltipText(String tooltipText)

Set or clears the tooltip text associated with the node.

Parameters:

tooltipText - The tooltip text to use for the node, or null to clear or remove it.

Returns:

true for change in tooltip text, false for no change.

getTooltipText

public String getTooltipText()

Get the tooltip associated with the node. If none is set null is returned.

Returns:

The tooltip text, or null for none.

setAttachment

public void setAttachment(Object attachment)

Assigns the attachment. This is a custom object and the tree nodes does nothing with this value, it is entirely for custom usage. It is retrieved from a tree node using getAttachment().

Parameters:

attachment - The custom attachment Object, can be null.

getAttachment

public Object getAttachment()

Gets the attachment. This is a custom object and the tree nodes does nothing with this value, it is entirely for custom usage.

Returns:

The attachment object set with setAttachment, could be null and is null if not never set.

collapse

public boolean collapse()

Collapses this node. This method has no effect if the node is not added in a tree. This is a convenience method for VirtualCTree.collapse(this).

Returns:

true for success, false if the node is not attached in the tree.

collapseAll

public boolean collapseAll()

Collapses this node and all below it. This method has no effect if the node is not added in a tree. This is a convenience method for VirtualCTree.collapseAll(this).

Returns:

true for success, false if the node is not attached in the tree.

expand

public boolean expand()

Collapses this node. This method has no effect if the node is not added in a tree. This is a convenience method for VirtualCTree.collapse(this).

Returns:

true for success, false if the node is not attached in the tree.

expandAll

public boolean expandAll()

Collapses this node and all below it. This method has no effect if the node is not added in a tree. This is a convenience method for VirtualCTree.collapse(this).

Returns:

true for success, false if the node is not attached in the tree.