edu.tum.cs.commons.treemap
Interface ITreeMapNode<T>

Type Parameters:

T - the type the user data has.

public interface ITreeMapNode<T>

Interface for nodes used for building the tree map node hierarchy which is then rendered as a tree map.

Version:

$Rev: 28095 $

Author:

Benjamin Hummel, $Author: hummelb $

Rating:

GREEN Hash: 6A2576C914919BB550F99037D71626EA

Method Summary

double	getArea() Returns the area of this node including all subnodes.
List<ITreeMapNode<T>>	getChildren() Returns the list of children of this node.
Color	getColor() Returns the base color used for drawing this node.
IDrawingPattern	getDrawingPattern() Returns the pattern used for drawing the node (may be null to use no pattern).
Rectangle2D	getLayoutRectangle() Returns the rectangle this node was layouted into.
Color	getPatternColor() Returns the color used for drawing the pattern (if any) of this node.
String	getText() Returns the text of the tree map node
String	getTooltipId() Get displayable name of the node.
List<String>	getTooltipKeys() Returns keys for structured displayable data.
Object	getTooltipValue(String key) Returns the value to be displayed for a single key.
T	getUserDatum() Returns some user defined data which can be useful for some callbacks.
void	setLayoutRectangle(Rectangle2D rect) Sets the rectangle this node should be layouted into.

Method Detail

getText

String getText()

Returns the text of the tree map node

getChildren

List<ITreeMapNode<T>> getChildren()

Returns the list of children of this node. This usually is a readonly list.

getArea

double getArea()

Returns the area of this node including all subnodes.

getColor

Color getColor()

Returns the base color used for drawing this node.

getPatternColor

Color getPatternColor()

Returns the color used for drawing the pattern (if any) of this node.

getDrawingPattern

IDrawingPattern getDrawingPattern()

Returns the pattern used for drawing the node (may be null to use no pattern).

getUserDatum

T getUserDatum()

Returns some user defined data which can be useful for some callbacks.

getLayoutRectangle

Rectangle2D getLayoutRectangle()

Returns the rectangle this node was layouted into. If the tree was not yet layouted, this may be null, otherwise it should be the value set by setLayoutRectangle(Rectangle2D).

setLayoutRectangle

void setLayoutRectangle(Rectangle2D rect)

Sets the rectangle this node should be layouted into.

getTooltipId

String getTooltipId()

Get displayable name of the node.

getTooltipKeys

List<String> getTooltipKeys()

Returns keys for structured displayable data.

getTooltipValue

Object getTooltipValue(String key)

Returns the value to be displayed for a single key.