oracle.jdevimpl.audit.swing

Class AbstractCheckBoxTreeModel

java.lang.Object

oracle.jdevimpl.audit.swing.AbstractTreeModel

oracle.jdevimpl.audit.swing.AbstractCheckBoxTreeModel

All Implemented Interfaces:

javax.swing.tree.TreeModel, CheckBoxTreeModel

Direct Known Subclasses:

ProfileTreeModel

public abstract class AbstractCheckBoxTreeModel
extends AbstractTreeModel
implements CheckBoxTreeModel

An implementation of CheckBoxTreeModel which maintains the checkbox state and fires changes events more or less optimally.

Clients are expected to populate the tree with implementations of AbstractCheckBoxTreeModel.CheckBoxNode. The root node is provided by overriding {#link #getRoot()}. The methods of AbstractCheckBoxTreeModel.CheckBoxNode that are typically overridden are AbstractCheckBoxTreeModel.CheckBoxNode.getChildren(), AbstractCheckBoxTreeModel.CheckBoxNode.isLeaf(), and AbstractCheckBoxTreeModel.CheckBoxNode.getLabel(). Rarely, AbstractCheckBoxTreeModel.CheckBoxNode.setState(boolean), and AbstractCheckBoxTreeModel.CheckBoxNode.getState() might be overridden for leaf nodes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractCheckBoxTreeModel.CheckBoxNode<T extends AbstractCheckBoxTreeModel.CheckBoxNode>

Field Summary

Fields inherited from class oracle.jdevimpl.audit.swing.AbstractTreeModel

listenerList

Constructor Summary

Constructors

Constructor and Description
AbstractCheckBoxTreeModel()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	convertValueToText(java.lang.Object node) Gets the label text for an object in this tree.
java.lang.Object	getChild(java.lang.Object parent, int index)
int	getChildCount(java.lang.Object parent)
int	getIndexOfChild(java.lang.Object parent, java.lang.Object child)
abstract java.lang.Object	getRoot()
java.lang.Boolean	getState(java.lang.Object node) Gets the selection state of an object in this tree.
boolean	isLeaf(java.lang.Object node)
protected void	resetStateOfParents(javax.swing.tree.TreePath path) Resets the state of parents to reflect the change of the AbstractCheckBoxTreeModel.CheckBoxNode at the specified path and fires events for any resulting changes.
protected boolean	setStateOfSubtree(javax.swing.tree.TreePath parent, AbstractCheckBoxTreeModel.CheckBoxNode node, boolean newState) Sets the state of the AbstractCheckBoxTreeModel.CheckBoxNode subtree at the specified path and fires events for any resulting changes.
void	stateForPathChanged(javax.swing.tree.TreePath path, boolean newState) Sets the selection state of an object in this tree.
void	valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object newValue)

Methods inherited from class oracle.jdevimpl.audit.swing.AbstractTreeModel

addTreeModelListener, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, fireTreeStructureChanged, getListeners, getTreeModelListeners, removeTreeModelListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, removeTreeModelListener

Constructor Detail

AbstractCheckBoxTreeModel

public AbstractCheckBoxTreeModel()

Method Detail

getRoot

public abstract java.lang.Object getRoot()

Specified by:

getRoot in interface javax.swing.tree.TreeModel

getChild

public java.lang.Object getChild(java.lang.Object parent,
                        int index)

Specified by:

getChild in interface javax.swing.tree.TreeModel

getChildCount

public int getChildCount(java.lang.Object parent)

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                  java.lang.Object child)

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

isLeaf

public boolean isLeaf(java.lang.Object node)

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

valueForPathChanged

public void valueForPathChanged(javax.swing.tree.TreePath path,
                       java.lang.Object newValue)

Specified by:

valueForPathChanged in interface javax.swing.tree.TreeModel

getState

public java.lang.Boolean getState(java.lang.Object node)

Description copied from interface: CheckBoxTreeModel

Gets the selection state of an object in this tree.

Gets Boolean.TRUE or Boolean.FALSE if the object is selected or unselected, respectively, and null if it is neither (e.g., if it is not a leaf node and some but not all of its children are selected).

Specified by:

getState in interface CheckBoxTreeModel

stateForPathChanged

public void stateForPathChanged(javax.swing.tree.TreePath path,
                       boolean newState)

Sets the selection state of an object in this tree. The selection state of the subtree rooted at this object is also set. Additionally, changing the state of this object could change the state of ancestors of this object as well. The model should fire treeNodesChanged events for any objects in the tree for which the selection state actually changes.

The default AbstractCheckBoxTreeModel implementation invokes setStateOfSubtree(javax.swing.tree.TreePath, oracle.jdevimpl.audit.swing.AbstractCheckBoxTreeModel.CheckBoxNode, boolean) for the specified path and if the selection state for that path changes as a result, it then invokes resetStateOfParents(javax.swing.tree.TreePath) for the specified path.

Specified by:

stateForPathChanged in interface CheckBoxTreeModel

Parameters:

path - path to the object whose state was changed by the user.

newState - the new state from the user.

resetStateOfParents

protected void resetStateOfParents(javax.swing.tree.TreePath path)

Resets the state of parents to reflect the change of the AbstractCheckBoxTreeModel.CheckBoxNode at the specified path and fires events for any resulting changes. If children are added after the tree is initially constructed, or if a leaf node of the model changes state for a cause other than stateForPathChanged(javax.swing.tree.TreePath, boolean), this is the appropriate method to call to refresh the tree to reflect the change.

setStateOfSubtree

protected boolean setStateOfSubtree(javax.swing.tree.TreePath parent,
                        AbstractCheckBoxTreeModel.CheckBoxNode node,
                        boolean newState)

Sets the state of the AbstractCheckBoxTreeModel.CheckBoxNode subtree at the specified path and fires events for any resulting changes.

Returns:

whether the state of the AbstractCheckBoxTreeModel.CheckBoxNode at the specified path actually changed.

convertValueToText

public java.lang.String convertValueToText(java.lang.Object node)

Gets the label text for an object in this tree.

The default AbstractCheckBoxTreeModel implementation delegates to the getLabel method of the CheckBoxNode object.

Specified by:

convertValueToText in interface CheckBoxTreeModel