jaxx.runtime.swing.navigation
Interface NavigationModel<E extends NavigationNode<E>>

All Known Implementing Classes:

AbstractNavigationModel, NavigationTreeModel, NavigationTreeTableModel

public interface NavigationModel<E extends NavigationNode<E>>

Interface to create model of the tree used for a navigation tree.

Il est composé de NavigationNode

Since:

2.0.0

Author:

sletellier

Method Summary

void	addTreeModelListener(TreeModelListener l) Adds a listener for the TreeModelEvent posted after the tree changes.
E	findNode(E root, String path) Search from a given root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by getPathSeparator().
E	findNode(E root, String path, Pattern regex) Apply first the regex pattern to obtain the searched node.
E	findNode(E root, String path, String regex) Apply first the regex pattern to obtain the searched node.
E	findNode(String path) Search from the root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by dot.
E	findNode(String path, Pattern regex) Apply first the regex pattern to obtain the searched node.
E	findNode(String path, String regex) Apply first the regex pattern to obtain the searched node fi the given regex is not null.
Object	getBean(E node) Obtain the associated bean value from context corresponding to node
Object	getBean(String navigationPath) Obtain the associated bean value from context corresponding to node from given navigation path.
Object	getChild(Object parent, int index) Returns the child of parent at index index in the parent's child array.
int	getChildCount(Object parent) Returns the number of children of parent.
JAXXContext	getContext()
int	getIndexOfChild(Object parent, Object child) Returns the index of child in parent.
String	getPathSeparator()
E[]	getPathToRoot(E aNode)
E	getRoot()
boolean	isAdjustingValue()
boolean	isLeaf(Object node) Returns true if node is a leaf.
void	nodeChanged(E node)
void	nodeChanged(E node, boolean deep)
void	nodeStructureChanged(E node)
void	removeNodeFromParent(E node)
void	removeTreeModelListener(TreeModelListener l) Removes a listener previously added with addTreeModelListener.
void	setAdjustingValue(boolean adjustingValue) Sets the new internal state adjustingValue.
void	setRoot(E root)
void	valueForPathChanged(TreePath path, Object newValue) Messaged when the user has altered the value for the item identified by path to newValue.

Method Detail

getRoot

E getRoot()

setRoot

void setRoot(E root)

getPathToRoot

E[] getPathToRoot(E aNode)

removeNodeFromParent

void removeNodeFromParent(E node)

findNode

E findNode(String path)

Search from the root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by dot.

Example :

$root.child1.leaf1

Parameters:

path - the fully path of the searched node.

Returns:

the node matching the fully context from the root node, or null if not find.

findNode

E findNode(String path,
           String regex)

Apply first the regex pattern to obtain the searched node fi the given regex is not null.

Search then from the root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by getPathSeparator().

Example :

$root.child1.leaf1

Parameters:

path - the fully path of the searched node.

regex - a optional regex to apply to path before searching

Returns:

the node matching the fully context from the root node, or null if not found.

findNode

E findNode(String path,
           Pattern regex)

Apply first the regex pattern to obtain the searched node.

Search then from the root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by getPathSeparator().

Example :

$root.child1.leaf1

Parameters:

path - the fully path of the searched node.

regex - a optional regex to apply to path before searching

Returns:

the node matching the fully context from the root node, or null if not found.

findNode

E findNode(E root,
           String path)

Search from a given root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by getPathSeparator().

Parameters:

root - root node to be used

path - the fully path of the searched node.

Returns:

the node matching the fully context from the given root node, or null if not found.

findNode

E findNode(E root,
           String path,
           String regex)

Apply first the regex pattern to obtain the searched node.

Search then from a given root node a node named by his fully path (concatenation of nodes) NavigationTreeNode.path valued separated by getPathSeparator().

Parameters:

root - root node to be used

path - the fully path of the searched node.

regex - a previous regex to apply to path : must have a matches

Returns:

the node matching the fully context from the given root node, or null if not found.

findNode

E findNode(E root,
           String path,
           Pattern regex)

Apply first the regex pattern to obtain the searched node.

Search then from a given root node a node named by his fully path (concatenation of nodes NavigationTreeNode.path valued separated by getPathSeparator().

Parameters:

root - root node to be used

path - the fully path of the searched node.

regex - a previous regex to apply to path : must have a matches

Returns:

the node matching the fully context from the given root node, or null if not found.

getContext

JAXXContext getContext()

isAdjustingValue

boolean isAdjustingValue()

Returns:

true if no event should be fired

setAdjustingValue

void setAdjustingValue(boolean adjustingValue)

Sets the new internal state adjustingValue. If the value is true, no more event will be fired, otherwise will not block events firing.

Parameters:

adjustingValue - the new value of valueAdjusting state

getBean

Object getBean(String navigationPath)

Obtain the associated bean value from context corresponding to node from given navigation path.

Parameters:

navigationPath - the current context path of the node

Returns:

the value associated in context with the given navigation path

getBean

Object getBean(E node)

Obtain the associated bean value from context corresponding to node

Parameters:

node - the current node

Returns:

the value associated in context with the given node.

nodeChanged

void nodeChanged(E node)

nodeStructureChanged

void nodeStructureChanged(E node)

nodeChanged

void nodeChanged(E node,
                 boolean deep)

getPathSeparator

String getPathSeparator()

getChild

Object getChild(Object parent,
                int index)

Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).

Parameters:

parent - a node in the tree, obtained from this data source

index - index of the node

Returns:

the child of parent at index index

getChildCount

int getChildCount(Object parent)

Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

Parameters:

parent - a node in the tree, obtained from this data source

Returns:

the number of children of the node parent

isLeaf

boolean isLeaf(Object node)

Returns true if node is a leaf. It is possible for this method to return false even if node has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.

Parameters:

node - a node in the tree, obtained from this data source

Returns:

true if node is a leaf

valueForPathChanged

void valueForPathChanged(TreePath path,
                         Object newValue)

Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Parameters:

path - path to the node that the user has altered

newValue - the new value from the TreeCellEditor

getIndexOfChild

int getIndexOfChild(Object parent,
                    Object child)

Returns the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

Parameters:

parent - a node in the tree, obtained from this data source

child - the node we are interested in

Returns:

the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model

addTreeModelListener

void addTreeModelListener(TreeModelListener l)

Adds a listener for the TreeModelEvent posted after the tree changes.

Parameters:

l - the listener to add

See Also:

removeTreeModelListener(javax.swing.event.TreeModelListener)

removeTreeModelListener

void removeTreeModelListener(TreeModelListener l)

Removes a listener previously added with addTreeModelListener.

Parameters:

l - the listener to remove

See Also:

addTreeModelListener(javax.swing.event.TreeModelListener)