ca.odell.glazedlists.swing.AbstractTreeTableNodeDataRenderer Maven / Gradle / Ivy

/* Glazed Lists                                                 (c) 2003-2006 */
/* http://publicobject.com/glazedlists/                      publicobject.com,*/
/*                                                     O'Dell Engineering Ltd.*/
package ca.odell.glazedlists.swing;

/**
 * A convenient renderer that eases the implementation of
 * TreeTableNodeDataRenderer by providing convenient access methods to the data
 * within the given {@link TreeNodeData}.
 */
public abstract class AbstractTreeTableNodeDataRenderer implements TreeTableNodeDataRenderer {

    private TreeNodeData treeNodeData;

    /** @inheritDoc */
    public final void setTreeNodeData(TreeNodeData treeNodeData) {
        this.treeNodeData = treeNodeData;
    }

    /**
     * Returns the depth of the tree node in the hierarchy.
     */
    protected int getDepth() { return treeNodeData.getDepth(); }

    /**
     * Returns true if the tree node has child nodes; false
     * otherwise.
     */
    protected boolean hasChildren() { return treeNodeData.hasChildren(); }

    /**
     * Returns true if the node is of the type that can have child
     * elements; false otherwise.
     */
    protected boolean allowsChildren() { return treeNodeData.allowsChildren(); }

    /**
     * Returns true if the node is expanded and its children are thus
     * visible; false if it is collapsed and its children are thus
     * hidden. This argument only has meaning when {@link #hasChildren()}
     * returns true; otherwise it should be ignored.
     */
    protected boolean isExpanded() { return treeNodeData.isExpanded(); }
}