Package eu.essilab.lablib.checkboxtree

Class NullTreeCheckingModel

java.lang.Object

eu.essilab.lablib.checkboxtree.NullTreeCheckingModel

All Implemented Interfaces:

TreeCheckingModel

public class NullTreeCheckingModel
extends Object
implements TreeCheckingModel

Convenience class representing an empty tree checking model (cf. the Null Object pattern), whose paths are always enabled, unchecked and ungreyed. This class is a singleton.

Author:

Lorenzo Bigagli

Nested Class Summary

Nested classes/interfaces inherited from interface eu.essilab.lablib.checkboxtree.TreeCheckingModel

TreeCheckingModel.CheckingMode

Method Summary

Modifier and Type	Method	Description
void	addCheckingPath(TreePath path)	add a path to the checking set.
void	addCheckingPaths(TreePath[] paths)	add paths to the checking set.
void	addTreeCheckingListener(TreeCheckingListener tcl)	Adds the specified listener to the list of those being notified upon changes in the the checking set.
void	clearChecking()	Clears the checking.
TreeCheckingModel.CheckingMode	getCheckingMode()
TreePath[]	getCheckingPaths()
TreePath[]	getCheckingRoots()
TreePath[]	getGreyingPaths()
static NullTreeCheckingModel	getInstance()
boolean	isPathChecked(TreePath path)	Returns true if the item identified by the path is currently checked.
boolean	isPathEnabled(TreePath path)	Returns whether the specified path checking state can be toggled.
boolean	isPathGreyed(TreePath path)	Returns whether the specified path is greyed.
void	removeCheckingPath(TreePath path)	Removes a path from the checking set.
void	removeCheckingPaths(TreePath[] paths)	Remove the specified paths from the checking set.
void	removeTreeCheckingListener(TreeCheckingListener tcl)	Removes the specified listener from the list of those being notified upon changes in the checking set.
void	setCheckingMode(TreeCheckingModel.CheckingMode mode)	Sets the specified checking mode.
void	setCheckingPath(TreePath path)	(Re)sets the checking to the specified path.
void	setCheckingPaths(TreePath[] paths)	(Re)sets the checking to the specified paths.
void	setPathEnabled(TreePath path, boolean enable)	Sets whether or not the specified path can be toggled.
void	setPathsEnabled(TreePath[] paths, boolean enable)	Sets whether or not the specified paths can be toggled.
void	toggleCheckingPath(TreePath pathForRow)	Toggles (check/uncheck) the checking state of the specified path, if this is enabled, and possibly propagate the change, according to the checking mode.

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static NullTreeCheckingModel getInstance()

addCheckingPath

public void addCheckingPath(TreePath path)

Description copied from interface: TreeCheckingModel

add a path to the checking set.

Specified by:

addCheckingPath in interface TreeCheckingModel

Parameters:

path - the path to be added.

addCheckingPaths

public void addCheckingPaths(TreePath[] paths)

Description copied from interface: TreeCheckingModel

add paths to the checking set.

Specified by:

addCheckingPaths in interface TreeCheckingModel

Parameters:

paths - the paths to be added.

addTreeCheckingListener

public void addTreeCheckingListener(TreeCheckingListener tcl)

Description copied from interface: TreeCheckingModel

Adds the specified listener to the list of those being notified upon changes in the the checking set.

Specified by:

addTreeCheckingListener in interface TreeCheckingModel

Parameters:

tcl - the new listener to be added.

clearChecking

public void clearChecking()

Description copied from interface: TreeCheckingModel

Clears the checking.

Specified by:

clearChecking in interface TreeCheckingModel

getCheckingMode

public TreeCheckingModel.CheckingMode getCheckingMode()

Specified by:

getCheckingMode in interface TreeCheckingModel

Returns:

Returns the CheckingMode.

getCheckingPaths

public TreePath[] getCheckingPaths()

Specified by:

getCheckingPaths in interface TreeCheckingModel

Returns:

Returns the paths that are in the checking set.

getCheckingRoots

public TreePath[] getCheckingRoots()

Specified by:

getCheckingRoots in interface TreeCheckingModel

Returns:

Returns the paths that are in the checking set and are the (upper) roots of checked trees.

getGreyingPaths

public TreePath[] getGreyingPaths()

Specified by:

getGreyingPaths in interface TreeCheckingModel

Returns:

Returns the paths that are in the greying set.

isPathChecked

public boolean isPathChecked(TreePath path)

Description copied from interface: TreeCheckingModel

Returns true if the item identified by the path is currently checked.

Specified by:

isPathChecked in interface TreeCheckingModel

Parameters:

path - a TreePath identifying a node

Returns:

true if the node is checked

isPathEnabled

public boolean isPathEnabled(TreePath path)

Description copied from interface: TreeCheckingModel

Returns whether the specified path checking state can be toggled.

Specified by:

isPathEnabled in interface TreeCheckingModel

isPathGreyed

public boolean isPathGreyed(TreePath path)

Description copied from interface: TreeCheckingModel

Returns whether the specified path is greyed.

Specified by:

isPathGreyed in interface TreeCheckingModel

removeCheckingPath

public void removeCheckingPath(TreePath path)

Description copied from interface: TreeCheckingModel

Removes a path from the checking set.

Specified by:

removeCheckingPath in interface TreeCheckingModel

Parameters:

path - the path to be removed.

removeCheckingPaths

public void removeCheckingPaths(TreePath[] paths)

Description copied from interface: TreeCheckingModel

Remove the specified paths from the checking set.

Specified by:

removeCheckingPaths in interface TreeCheckingModel

Parameters:

paths - the paths to be added.

removeTreeCheckingListener

public void removeTreeCheckingListener(TreeCheckingListener tcl)

Description copied from interface: TreeCheckingModel

Removes the specified listener from the list of those being notified upon changes in the checking set.

Specified by:

removeTreeCheckingListener in interface TreeCheckingModel

Parameters:

tcl - the listener to remove.

setCheckingMode

public void setCheckingMode(TreeCheckingModel.CheckingMode mode)

Description copied from interface: TreeCheckingModel

Sets the specified checking mode.

Specified by:

setCheckingMode in interface TreeCheckingModel

Parameters:

mode - the checking mode to set.

setCheckingPath

public void setCheckingPath(TreePath path)

Description copied from interface: TreeCheckingModel

(Re)sets the checking to the specified path.

Specified by:

setCheckingPath in interface TreeCheckingModel

setCheckingPaths

public void setCheckingPaths(TreePath[] paths)

Description copied from interface: TreeCheckingModel

(Re)sets the checking to the specified paths.

Specified by:

setCheckingPaths in interface TreeCheckingModel

setPathEnabled

public void setPathEnabled(TreePath path,
 boolean enable)

Description copied from interface: TreeCheckingModel

Sets whether or not the specified path can be toggled.

Specified by:

setPathEnabled in interface TreeCheckingModel

Parameters:

path - the path to enable/disable

setPathsEnabled

public void setPathsEnabled(TreePath[] paths,
 boolean enable)

Description copied from interface: TreeCheckingModel

Sets whether or not the specified paths can be toggled.

Specified by:

setPathsEnabled in interface TreeCheckingModel

Parameters:

paths - the paths to enable/disable

toggleCheckingPath

public void toggleCheckingPath(TreePath pathForRow)

Description copied from interface: TreeCheckingModel

Toggles (check/uncheck) the checking state of the specified path, if this is enabled, and possibly propagate the change, according to the checking mode.

Specified by:

toggleCheckingPath in interface TreeCheckingModel