fr.inria.zvtm.layout.tree

Class LNode

java.lang.Object

fr.inria.zvtm.layout.tree.LNode

public class LNode
extends Object

Node of the LTree tree.

Author:

Boris Trofimov

See Also:

LTree, TreeLayout

Field Summary

Fields

Modifier and Type	Field and Description
long	x
long	y

Method Summary

Modifier and Type	Method and Description
LNode	addChild(Object owner, String text)
LNode	addChild(Object owner, String text, boolean visible) Add new child to this node.
void	collapse() Collapse this node to hide all children.
void	deleteFromTree(boolean deleteSubTree)
void	expand() Expand this node to show all children.
LNode	getAt(int i) Get child of this node at specified index.
Color	getBackgroundColor() Get the color that will be used for background if drawBorder is true.
Color	getBorderColor() Get the color that will be used for borders if drawBorder is true.
Point2D.Double	getBounds(int camIndex) Get bounds of the node.
LNode[]	getChildren()
Object	getClientProperty(Object key) Get user object that was set for this key using method setClientProperty(Object key, Object value).
Color	getEdgeColor()
LNode	getFirstChild()
LNode	getLastChild()
LNode	getNextSibling()
Object	getOwner() Get user object that represent this node.
LNode	getParentNode()
LNode	getPreviousSibling()
Color	getSelectedBackgroundColor()
Color	getSelectedBorderColor()
Color	getSelectedTextColor()
String	getText() Get text of the node.
Color	getTextColor() Get the color that will be used for node's text.
LTree	getTree()
boolean	hasChildren()
boolean	isExpanded()
boolean	isVisible()
void	removeChild(LNode child, boolean deleteSubTree)
void	setBackgroundColor(Color backgroundColor) Set the color that will be used for background if drawBorder is true.
void	setBorderColor(Color borderColor) Set the color that will be used for borders if drawBorder is true.
void	setClientProperty(Object key, Object value) Set any key-value pair to the LNode instance.
void	setEdgeColor(Color edgeColor)
void	setOwner(Object owner) Set any user object that represent this node.
void	setSelectedBackgroundColor(Color selectedBackgroundColor)
void	setSelectedBorderColor(Color selectedBorderColor)
void	setSelectedTextColor(Color selectedTextColor)
void	setText(String text) Set text of the node.
void	setTextColor(Color textColor) Set the color that will be used for node's text.
void	updateNode(int treeOrientation, int camIndex) This method can be called after the tree was laid out with layout algorithm to update position of this node and all children.

Methods inherited from class java.lang.Object

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

Field Detail

x

public long x

y

public long y

Method Detail

getTree

public LTree getTree()

getText

public String getText()

Get text of the node.

Returns:

string text.

setText

public void setText(String text)

Set text of the node.

Parameters:

text - String for this node.

getBorderColor

public Color getBorderColor()

Get the color that will be used for borders if drawBorder is true.

Returns:

border color.

setBorderColor

public void setBorderColor(Color borderColor)

Set the color that will be used for borders if drawBorder is true.

Parameters:

borderColor - new border color.

getBackgroundColor

public Color getBackgroundColor()

Get the color that will be used for background if drawBorder is true.

Returns:

background color.

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Set the color that will be used for background if drawBorder is true.

Parameters:

backgroundColor - new background color.

getTextColor

public Color getTextColor()

Get the color that will be used for node's text.

Returns:

text color.

setTextColor

public void setTextColor(Color textColor)

Set the color that will be used for node's text.

Parameters:

textColor - new text color.

getSelectedBackgroundColor

public Color getSelectedBackgroundColor()

setSelectedBackgroundColor

public void setSelectedBackgroundColor(Color selectedBackgroundColor)

getSelectedTextColor

public Color getSelectedTextColor()

setSelectedTextColor

public void setSelectedTextColor(Color selectedTextColor)

getSelectedBorderColor

public Color getSelectedBorderColor()

setSelectedBorderColor

public void setSelectedBorderColor(Color selectedBorderColor)

getEdgeColor

public Color getEdgeColor()

setEdgeColor

public void setEdgeColor(Color edgeColor)

getBounds

public Point2D.Double getBounds(int camIndex)

Get bounds of the node. As far as we use VText for drawing nodes, we should provide camera index.

Parameters:

camIndex - Index of active camera.

Returns:

Point2D.Double that represent bounds of the node.

getClientProperty

public Object getClientProperty(Object key)

Get user object that was set for this key using method setClientProperty(Object key, Object value).

Parameters:

key - key to retrieve value

Returns:

corresponding value

setClientProperty

public void setClientProperty(Object key,
                              Object value)

Set any key-value pair to the LNode instance.

Parameters:

key - key for the value

value - any user object

getParentNode

public LNode getParentNode()

addChild

public LNode addChild(Object owner,
                      String text,
                      boolean visible)

Add new child to this node.

Parameters:

owner - Any user data

text - Text representation of the node.

visible - Visibility of newly created node.

Returns:

Just created child.

addChild

public LNode addChild(Object owner,
                      String text)

hasChildren

public boolean hasChildren()

getChildren

public LNode[] getChildren()

getFirstChild

public LNode getFirstChild()

getLastChild

public LNode getLastChild()

getPreviousSibling

public LNode getPreviousSibling()

getNextSibling

public LNode getNextSibling()

getAt

public LNode getAt(int i)

Get child of this node at specified index.

Parameters:

i - index of the desired child.

Returns:

child with index i.

removeChild

public void removeChild(LNode child,
                        boolean deleteSubTree)

deleteFromTree

public void deleteFromTree(boolean deleteSubTree)

updateNode

public void updateNode(int treeOrientation,
                       int camIndex)

This method can be called after the tree was laid out with layout algorithm to update position of this node and all children.

Parameters:

treeOrientation - One of the TreeOrientation constants.

camIndex - Index of active camera.

expand

public void expand()

Expand this node to show all children.

collapse

public void collapse()

Collapse this node to hide all children.

isExpanded

public boolean isExpanded()

isVisible

public boolean isVisible()

getOwner

public Object getOwner()

Get user object that represent this node.

Returns:

user object.

setOwner

public void setOwner(Object owner)

Set any user object that represent this node.

Parameters:

owner - user object.