no.g9.client.core.view.tree

Interface TreeModel<T extends TreeNode,L extends ListRow>

Type Parameters:

T - The actual implementing TreeNode class

L - The actual implementing ListRow class

public interface TreeModel<T extends TreeNode,L extends ListRow>

The general tree model used by jVine targets. The tree model is used to hold all the data that can be displayed by a tree view in addition to various properties concerning node, row and cells.

TreeNode is used to represent nodes. Each node contains a ListRow as its data representation. When setting a state or property on a node, the state or property is propagated to the nodes statemap and the ListRow's PropertyManager. The tree model has a list of root nodes.

The tree model maintains two lists of root TreeNodes:

• The tree data list is the complete list of root nodes in this model. The list can be accessed by getTreeData() method.
• The view data list is the filtered and sorted list of root nodes in this model. The list can be accessed by getTreeView() method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TreeModel.Grouping Enumerates the various grouping modes.
static class	TreeModel.SelectionModel Enumerates the various node selection models.

Method Summary

Modifier and Type	Method and Description
void	addRowFilter(RowFilter<?,ListRow> rowFilter) Add the row filter to this tree model.
void	addRowFilters(Collection<RowFilter<?,ListRow>> rowFilters) Add the row filters to this tree model.
void	addTreeNodeComparator(DialogObjectConstant nodeConst, TreeNodeComparator comparator) Set the TreeNodeComparator to use when sorting this tree model.
void	clear() Clears this tree model by removing all root nodes.
void	filterTree(List<T> srcList, List<T> dstList) Filter the tree, given a list of root nodes.
<U> U	getCellProperty(T node, DialogObjectConstant columnIdentifier, Property<U> propertyName) Get the property value for the specified cell.
Object	getDataModel() Get the concrete data model.
List<T>	getExpanded() Returns a list of all nodes that are expanded.
List<T>	getSelected() Returns a list of all nodes that are selected.
TreeModel.SelectionModel	getSelectionModel() Returns the current selection model - none, single or multi selection.
List<T>	getTreeData() Get the tree root node data list.
int	getTreeDataNodeCount() Get the number of nodes in this tree data model.
List<T>	getTreeView() Get the tree root node view list.
int	getTreeViewNodeCount() Get the number of nodes in this tree view model.
Object	getValueAt(T node, DialogObjectConstant columnIdentifier) Get the cell value at the specified node and column.
boolean	isCellEnabled(T node, DialogObjectConstant columnIdentifier) Get the enabled property value of the specified cell.
boolean	isCellShown(T node, DialogObjectConstant columnIdentifier) Get the shown property value of the specified cell.
boolean	isEmpty() Test if this model contains any nodes.
boolean	isExpanded(T node) Return the 'expanded' state for a given node.
boolean	isSelected(T node) Return the 'selected' state for a given node.
void	removeRowFilter(RowFilter<?,ListRow> rowFilter) Remove the row filter from this tree model.
void	removeRowFilters(Collection<RowFilter<?,ListRow>> rowFilters) Remove the row filters from this tree model.
void	setCellEnabled(T node, DialogObjectConstant columnIdentifier, boolean enabled) Set the enabled property the specified cell.
<U> void	setCellProperty(T node, DialogObjectConstant columnIdentifier, Property<U> propertyName, U propertyValue) Set the specified property on the specified cell.
void	setCellShown(T node, DialogObjectConstant columnIdentifier, boolean shown) Set the shown property the specified cell.
void	setColumnEnabled(DialogObjectConstant columnIdentifier, boolean enabled) Set the enabled property for all cells in the specified column.
<U> void	setColumnProperty(DialogObjectConstant columnIdentifier, Property<U> propertyName, U value) Set the specified property on all cells in the column.
void	setColumnShown(DialogObjectConstant columnIdentifier, boolean shown) Set the shown property for all cells in the specified column.
void	setEnabled(boolean enabled) Set the enabled property for all cells in the entire tree.
void	setExpanded(boolean expanded) Sets all nodes to the 'expanded' state.
void	setExpanded(T node, boolean expanded) Sets the 'expanded' state on a single node.
void	setNodeEnabled(T node, boolean enabled) Set the enabled property for all cells in the specified node.
<U> void	setNodeProperty(T node, Property<U> property, U propertyValue) Set the specified property on all cells in the node.
void	setNodeShown(T node, boolean shown) Set the shown property for all cells in the specified node.
<U> void	setProperty(Property<U> property, U propertyValue) Set the specified property on all cells in the tree.
void	setRootNodes(List<T> nodeList) Sets the root nodes of this model data tree.
void	setSelected(boolean selected) Sets all nodes to the 'selected' state.
void	setSelected(T node, boolean selected) Sets the 'selected' state on a single node.
void	setSelectionModel(TreeModel.SelectionModel selectionModel) Sets the current selection model.
void	setShown(boolean shown) Set the shown property for all cells in the entire tree.
void	setValueAt(T node, DialogObjectConstant columnIdentifier, Object value) Set the specified cell value.
void	sortTree(List<T> nodeList) Sort all nodes in list of root nodes .

Method Detail

getTreeView

List<T> getTreeView()

Get the tree root node view list. This is the sorted and filtered list of root nodes presented to dialog views.

Note that any changes made directly to this list will not be detected by the tree model. Thus adding or removing rows to this list might not yield the desired result.

Returns:

tree root node view list

getTreeData

List<T> getTreeData()

Get the tree root node data list. This is the list used for maintaining the unsorted and un-filtered tree root node list.

Note that any changes made directly to this list will be detected by the tree model and trigger and update of the tree view list.

Returns:

tree root node data list

getDataModel

Object getDataModel()

Get the concrete data model. For eagerly fetched trees it will be a List of root nodes, for lazily loaded trees it will be an implementation of LazyNodeDataModel.

Returns:

the datamodel for the tree.

addRowFilter

void addRowFilter(RowFilter<?,ListRow> rowFilter)

Add the row filter to this tree model. The tree view list will be updated.

Parameters:

rowFilter - row filter(s) to add

addRowFilters

void addRowFilters(Collection<RowFilter<?,ListRow>> rowFilters)

Add the row filters to this tree model. The tree view list will be updated.

Parameters:

rowFilters - row filter(s) to add

removeRowFilter

void removeRowFilter(RowFilter<?,ListRow> rowFilter)

Remove the row filter from this tree model. The tree view list will be updated.

Parameters:

rowFilter - row filter(s) to remove

removeRowFilters

void removeRowFilters(Collection<RowFilter<?,ListRow>> rowFilters)

Remove the row filters from this tree model. The tree view list will be updated.

Parameters:

rowFilters - row filters to remove

filterTree

void filterTree(List<T> srcList,
                List<T> dstList)

Filter the tree, given a list of root nodes.

Parameters:

srcList - source list of root nodes

dstList - destination list of root nodes

getValueAt

Object getValueAt(T node,
                  DialogObjectConstant columnIdentifier)

Get the cell value at the specified node and column.

Parameters:

node - tree data node

columnIdentifier - constant denoting the column

Returns:

the cell value

setValueAt

void setValueAt(T node,
                DialogObjectConstant columnIdentifier,
                Object value)

Set the specified cell value.

Note: The tree view is not updated as a result of invoking this method.

Parameters:

node - tree data's node

columnIdentifier - constant denoting the column

value - cell value

See Also:

filterTree(List, List)

getTreeDataNodeCount

int getTreeDataNodeCount()

Get the number of nodes in this tree data model.

Returns:

the data model's node count

getTreeViewNodeCount

int getTreeViewNodeCount()

Get the number of nodes in this tree view model.

Returns:

the view model's node count

setRootNodes

void setRootNodes(List<T> nodeList)

Sets the root nodes of this model data tree.

Parameters:

nodeList - the list of root nodes

clear

void clear()

Clears this tree model by removing all root nodes.

isEmpty

boolean isEmpty()

Test if this model contains any nodes.

Returns:

true if this model is empty

setProperty

<U> void setProperty(Property<U> property,
                     U propertyValue)

Set the specified property on all cells in the tree.

Type Parameters:

U - The property value type

Parameters:

property - the property

propertyValue - value of the property

setNodeProperty

<U> void setNodeProperty(T node,
                         Property<U> property,
                         U propertyValue)

Set the specified property on all cells in the node.

Type Parameters:

U - The property value type

Parameters:

node - tree data's node

property - the property

propertyValue - value of the property

setColumnProperty

<U> void setColumnProperty(DialogObjectConstant columnIdentifier,
                           Property<U> propertyName,
                           U value)

Set the specified property on all cells in the column.

Type Parameters:

U - The property value type

Parameters:

columnIdentifier - constant denoting the column

propertyName - name identifying the property

value - value of the property

setCellProperty

<U> void setCellProperty(T node,
                         DialogObjectConstant columnIdentifier,
                         Property<U> propertyName,
                         U propertyValue)

Set the specified property on the specified cell.

Type Parameters:

U - The property value type

Parameters:

node - tree data's node

columnIdentifier - constant denoting the column

propertyName - name identifying the property

propertyValue - value of the property

getCellProperty

<U> U getCellProperty(T node,
                      DialogObjectConstant columnIdentifier,
                      Property<U> propertyName)

Get the property value for the specified cell.

Type Parameters:

U - The property value type

Parameters:

node - tree data's node

columnIdentifier - constant denoting the column

propertyName - name identifying the property

Returns:

value of the property

getSelectionModel

TreeModel.SelectionModel getSelectionModel()

Returns the current selection model - none, single or multi selection.

Returns:

The current TreeModel.SelectionModel

setSelectionModel

void setSelectionModel(TreeModel.SelectionModel selectionModel)

Sets the current selection model. See TreeModel.SelectionModel.

Parameters:

selectionModel - the selection model to set

setSelected

void setSelected(boolean selected)

Sets all nodes to the 'selected' state.

Parameters:

selected - boolean indicating wheather to set selected or unselected state

setSelected

void setSelected(T node,
                 boolean selected)

Sets the 'selected' state on a single node.

Parameters:

node - the node to set the 'selected' state upon

selected - boolean indicating wheather to set selected or unselected state

isSelected

boolean isSelected(T node)

Return the 'selected' state for a given node.

Parameters:

node - the node the check state for

Returns:

true if given node is in a selected state, false otherwise

getSelected

List<T> getSelected()

Returns a list of all nodes that are selected.

Returns:

list of all nodes that are in the 'selected' state

setExpanded

void setExpanded(T node,
                 boolean expanded)

Sets the 'expanded' state on a single node.

Parameters:

node - the node to set the 'expanded' state upon

expanded - boolean indicating wheather to set expanded or contracted state

setExpanded

void setExpanded(boolean expanded)

Sets all nodes to the 'expanded' state.

Parameters:

expanded - boolean indicating wheather to set selected or unselected state

isExpanded

boolean isExpanded(T node)

Return the 'expanded' state for a given node.

Parameters:

node - the node the check state for

Returns:

true if given node is in an expanded state, false otherwise

getExpanded

List<T> getExpanded()

Returns a list of all nodes that are expanded.

Returns:

list of all nodes that are in the 'expanded' state

setEnabled

void setEnabled(boolean enabled)

Set the enabled property for all cells in the entire tree.

Parameters:

enabled - if true, all cells in the tree will be enabled

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

setNodeEnabled

void setNodeEnabled(T node,
                    boolean enabled)

Set the enabled property for all cells in the specified node.

Parameters:

node - the node to set editable

enabled - if true, all cells in the node will be enabled

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

setColumnEnabled

void setColumnEnabled(DialogObjectConstant columnIdentifier,
                      boolean enabled)

Set the enabled property for all cells in the specified column.

Parameters:

columnIdentifier - constant denoting the column

enabled - if true, all cells in the column will be enabled

Throws:

NoSuchElementException - if the specified column is not part of this tree model

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

setCellEnabled

void setCellEnabled(T node,
                    DialogObjectConstant columnIdentifier,
                    boolean enabled)

Set the enabled property the specified cell.

Parameters:

node - the node

columnIdentifier - constant denoting the column

enabled - if true, the cells will be editable

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

isCellEnabled

boolean isCellEnabled(T node,
                      DialogObjectConstant columnIdentifier)

Get the enabled property value of the specified cell. If the enabled property of a cell is false the cell will not be able to receive focus. If the cell is visible and enabled the cell will be able to receive focus.

Parameters:

node - the node

columnIdentifier - constant denoting the column

Returns:

true if the cell is enabled

setShown

void setShown(boolean shown)

Set the shown property for all cells in the entire tree.

Parameters:

shown - if true, all cells in the node will be rendered

See Also:

isCellShown(TreeNode, DialogObjectConstant)

setNodeShown

void setNodeShown(T node,
                  boolean shown)

Set the shown property for all cells in the specified node.

Parameters:

node - the node to set shown

shown - if true, all cells in the node will be rendered

See Also:

isCellShown(TreeNode, DialogObjectConstant)

setColumnShown

void setColumnShown(DialogObjectConstant columnIdentifier,
                    boolean shown)

Set the shown property for all cells in the specified column.

Parameters:

columnIdentifier - constant denoting the column

shown - if true, all cells in the column will be rendered

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

setCellShown

void setCellShown(T node,
                  DialogObjectConstant columnIdentifier,
                  boolean shown)

Set the shown property the specified cell.

Parameters:

node - the node

columnIdentifier - constant denoting the column

shown - if true, the cell will be rendered

See Also:

isCellEnabled(TreeNode, DialogObjectConstant)

isCellShown

boolean isCellShown(T node,
                    DialogObjectConstant columnIdentifier)

Get the shown property value of the specified cell. If the shown property of a cell is true the cell will be rendered.

Parameters:

node - the node

columnIdentifier - constant denoting the column

Returns:

true if the cell is shown

sortTree

void sortTree(List<T> nodeList)

Sort all nodes in list of root nodes . The tree is sorted according to the defined TreeNodeComparator comparator.

Parameters:

nodeList - list of root nodes

See Also:

addTreeNodeComparator(DialogObjectConstant, TreeNodeComparator)

addTreeNodeComparator

void addTreeNodeComparator(DialogObjectConstant nodeConst,
                           TreeNodeComparator comparator)

Set the TreeNodeComparator to use when sorting this tree model.

Parameters:

nodeConst - the dialog object constant denoting the tree node

comparator - the comparator to use for a particular type of node