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 change 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().

A subclass may extract the state of the leaf nodes from an external source by overriding AbstractCheckBoxTreeModel.CheckBoxNode.setState(boolean) and AbstractCheckBoxTreeModel.CheckBoxNode.getState(). A subclass may control the criteria which determine which nodes should be visible by overriding AbstractCheckBoxTreeModel.CheckBoxNode.isVisible().

When either an external source of state or the visibility criteria change, the subclass should invoke the treeChanged(javax.swing.tree.TreePath) method to notify the model.

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) The default AbstractCheckBoxTreeModel implementation considers only visible children.
int	getChildCount(java.lang.Object parent) The default AbstractCheckBoxTreeModel implementation returns the number of visible children.
int	getIndexOfChild(java.lang.Object parent, java.lang.Object child) The default AbstractCheckBoxTreeModel implementation returns the index of the child within the visible children of this node, or -1 if the child is not visible.
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)
boolean	isModified(java.lang.Object node) Gets whether an object in the tree is modified, relative to a baseline defined by the model.
void	nodeChanged(javax.swing.tree.TreePath path) Notify this model that attributes of a node, but not visibility, may have changed (and its descendants are unaffected).
void	stateForPathChanged(javax.swing.tree.TreePath path, boolean newState) Sets the selection state of an object in this tree.
void	treeChanged() Notify this model that attributes or visibility any node in this model may have changed.
void	treeChanged(javax.swing.tree.TreePath path) Notify this model that attributes or visibility of a node or any of its descendants may have changed.
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)

The default AbstractCheckBoxTreeModel implementation considers only visible children.

Specified by:

getChild in interface javax.swing.tree.TreeModel

getChildCount

public int getChildCount(java.lang.Object parent)

The default AbstractCheckBoxTreeModel implementation returns the number of visible children.

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

getIndexOfChild

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

The default AbstractCheckBoxTreeModel implementation returns the index of the child within the visible children of this node, or -1 if the child is not visible.

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

isModified

public boolean isModified(java.lang.Object node)

Gets whether an object in the tree is modified, relative to a baseline defined by the model. A model which does not support such a baseline should always return false. The default AbstractCheckBoxTreeModel implementation delegates to AbstractCheckBoxTreeModel.CheckBoxNode.isModified().

stateForPathChanged

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

Description copied from interface: CheckBoxTreeModel

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.

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.

treeChanged

public void treeChanged(javax.swing.tree.TreePath path)

Notify this model that attributes or visibility of a node or any of its descendants may have changed. Tree events are fired as appropriate. If children are added after the tree is initially constructed or if visibility criteria for specific nodes are changed, and the change is isolated to a specific subtree, this is the appropriate method to call to update the tree to reflect the change.

treeChanged

public void treeChanged()

Notify this model that attributes or visibility any node in this model may have changed. Tree events are fired as appropriate. If children are added after the tree is initially constructed or if visibility criteria are changed, and the change is not isolated to a specific subtree, this is the appropriate method to call to update the tree to reflect the change.

nodeChanged

public void nodeChanged(javax.swing.tree.TreePath path)

Notify this model that attributes of a node, but not visibility, may have changed (and its descendants are unaffected). Tree events are fired as appropriate. 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 update the tree to reflect the change.

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