Package hu.webarticum.treeprinter.decorator

Class AbstractTreeNodeDecorator

java.lang.Object

hu.webarticum.treeprinter.decorator.AbstractTreeNodeDecorator

All Implemented Interfaces:

TreeNode

Direct Known Subclasses:

BorderTreeNodeDecorator, DefaultFsTreeNodeDecorator, JustifyTreeNodeDecorator, PadTreeNodeDecorator, ShadowTreeNodeDecorator, TrackingTreeNodeDecorator

public abstract class AbstractTreeNodeDecorator
extends java.lang.Object
implements TreeNode

Base class for TreeNode decorators. Decorators should only effect if the wrapped node is decorable. Decorators should inherit by default (wrap their children with a similar decorator), and should not inherit when the inherit option is set to false.

Field Summary

Fields

Modifier and Type	Field	Description
protected TreeNode	baseNode
protected boolean	decorable
protected boolean	inherit

Constructor Summary

Constructors

Constructor	Description
AbstractTreeNodeDecorator(TreeNode baseNode)
AbstractTreeNodeDecorator(TreeNode baseNode, boolean inherit)
AbstractTreeNodeDecorator(TreeNode baseNode, boolean inherit, boolean decorable)

Method Summary

Modifier and Type	Method	Description
java.util.List<TreeNode>	children()	Gets the list of child nodes of this node.
java.lang.String	content()	Gets the content of this node.
protected abstract java.lang.String	decoratedContent()
TreeNode	getDecoratedNode()
Insets	insets()	Gets the content insets.
boolean	isDecorable()	Checks if this node can be decorated.
boolean	isPlaceholder()	Checks if this node is a placeholder.
TreeNode	originalNode()	Gets the original node object.
protected abstract TreeNode	wrapChild(TreeNode childNode, int index)

Methods inherited from class java.lang.Object

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

Field Detail

baseNode

protected final TreeNode baseNode

inherit

protected final boolean inherit

decorable

protected final boolean decorable

Constructor Detail

AbstractTreeNodeDecorator

public AbstractTreeNodeDecorator(TreeNode baseNode)

AbstractTreeNodeDecorator

public AbstractTreeNodeDecorator(TreeNode baseNode,
                                 boolean inherit)

AbstractTreeNodeDecorator

public AbstractTreeNodeDecorator(TreeNode baseNode,
                                 boolean inherit,
                                 boolean decorable)

Method Detail

content

public java.lang.String content()

Description copied from interface: TreeNode

Gets the content of this node.

Specified by:

content in interface TreeNode

getDecoratedNode

public TreeNode getDecoratedNode()

originalNode

public TreeNode originalNode()

Description copied from interface: TreeNode

Gets the original node object. By default, returns with this. Decorators should return with the most inner decorated node.

Specified by:

originalNode in interface TreeNode

insets

public Insets insets()

Description copied from interface: TreeNode

Gets the content insets. Returns with the sizes of the visual decoration around the main content. By default, this is fully zero. Visually extending decorators (border, shadow etc.) should extend the insets with the sizes of the visual extension.

Specified by:

insets in interface TreeNode

isDecorable

public boolean isDecorable()

Description copied from interface: TreeNode

Checks if this node can be decorated. By default, decorators should keep non-decorable nodes untouched.

Specified by:

isDecorable in interface TreeNode

isPlaceholder

public boolean isPlaceholder()

Description copied from interface: TreeNode

Checks if this node is a placeholder. By default, generic TreePrinter implementations hide placeholder nodes. Some types of implementation (e. g. n-ary trees) should take these into account anyway.

Specified by:

isPlaceholder in interface TreeNode

children

public java.util.List<TreeNode> children()

Description copied from interface: TreeNode

Gets the list of child nodes of this node.

Specified by:

children in interface TreeNode

decoratedContent

protected abstract java.lang.String decoratedContent()

wrapChild

protected abstract TreeNode wrapChild(TreeNode childNode,
                                      int index)