Skip navigation links

ilog.rules.teamserver.web.tree
Class IlrTreeController

java.lang.Object
  ilog.rules.teamserver.web.tree.IlrTreeController

Direct Known Subclasses:

IlrPackageController, IlrRuleExplorerController

public abstract class IlrTreeController
extends Object

IlrTreeController mediates between the model of the tree and its component.

All implementations must provide a tree data provider.

See Also:

IlrTreeDataProvider

Field Summary

protected ilog.rules.teamserver.web.tree.IlrTreeActionBarHandler	fTreeActionBarHandler
protected IlrTreeFilter	fTreeFilter
protected IlrTreeLabelProvider	fTreeLabelProvider
protected IlrTreeListener	fTreeListener
protected IlrTreeSorter	fTreeSorter

Constructor Summary

IlrTreeController()

Method Summary

void	collapseNode(IlrTreeNode node) Collapses a node.
void	expandNode(IlrTreeNode node) Expands a node.
List<IlrTreeNode>	getChildren(IlrTreeNode node) Returns the children of a node.
List<IlrTreeNode>	getChildren(IlrTreeNode node, boolean sortChildren) Returns the children of a node.
String	getId() Returns the tree ID.
IlrTreeNode	getSelectedNode() Returns the currently selected node.
abstract IlrTreeDataProvider	getTreeDataProvider() Returns a tree data provider.
IlrTreeFilter	getTreeFilter() Returns the tree filter.
IlrTreeLabelProvider	getTreeLabelProvider() Returns a tree label provider.
IlrTreeListener	getTreeListener() Returns a tree listener.
IlrTreeSorter	getTreeSorter() Returns a tree sorter.
IlrTreeStateProvider	getTreeStateProvider() Returns a tree state provider.
boolean	hasChildren(IlrTreeNode node) Checks if a node has children.
boolean	isClickable(IlrTreeNode node) Checks if a node is clickable.
boolean	isExpanded(IlrTreeNode node) Checks if a node is expanded.
boolean	isRootVisible() Checks if the root node must be rendered in the tree component.
boolean	isSelected(IlrTreeNode node) Checks if a node is selected.
void	reset() Resets the state of the tree component.
boolean	setSelectedNode(IlrTreeNode node, boolean fireEvent) Selects a node.
void	setTreeFilter(IlrTreeFilter treeFilter) Sets the tree filter that filters nodes in the tree.
void	setTreeLabelProvider(IlrTreeLabelProvider treeLabelProvider) Sets the tree label provider used to render the tree.
void	setTreeListener(IlrTreeListener treeListener) Sets the tree listener that listens for events on the tree.
void	setTreeSorter(IlrTreeSorter treeSorter) Sets the tree sorter used to sort nodes in the tree.
void	showNode(IlrTreeNode node, boolean select) Shows and selects a node in the tree component.
void	visit(IlrTreeVisitor visitor, IlrTreeNode node, boolean load) Visits the tree model.

Methods inherited from class java.lang.Object

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

Field Detail

fTreeLabelProvider

protected IlrTreeLabelProvider fTreeLabelProvider

fTreeListener

protected IlrTreeListener fTreeListener

fTreeFilter

protected IlrTreeFilter fTreeFilter

fTreeSorter

protected IlrTreeSorter fTreeSorter

fTreeActionBarHandler

protected ilog.rules.teamserver.web.tree.IlrTreeActionBarHandler fTreeActionBarHandler

Constructor Detail

IlrTreeController

public IlrTreeController()

Method Detail

getId

public String getId()

Returns the tree ID.

Returns:

The tree ID.

getTreeStateProvider

public IlrTreeStateProvider getTreeStateProvider()

Returns a tree state provider.

Returns:

A tree state provider. This default implementation returns an instance of IlrDefaultTreeStateProvider.

See Also:

IlrDefaultTreeStateProvider

getTreeDataProvider

public abstract IlrTreeDataProvider getTreeDataProvider()

Returns a tree data provider.

Returns:

A tree data provider.

getTreeLabelProvider

public IlrTreeLabelProvider getTreeLabelProvider()

Returns a tree label provider.

Returns:

A tree label provider.

setTreeLabelProvider

public void setTreeLabelProvider(IlrTreeLabelProvider treeLabelProvider)

Sets the tree label provider used to render the tree.

Parameters:

treeLabelProvider - A tree label provider.

getTreeListener

public IlrTreeListener getTreeListener()

Returns a tree listener.

Returns:

A tree listener.

setTreeListener

public void setTreeListener(IlrTreeListener treeListener)

Sets the tree listener that listens for events on the tree.

Parameters:

treeListener - A tree listener.

getTreeFilter

public IlrTreeFilter getTreeFilter()

Returns the tree filter.

Returns:

A tree filter.

setTreeFilter

public void setTreeFilter(IlrTreeFilter treeFilter)

Sets the tree filter that filters nodes in the tree.

Parameters:

treeFilter - A tree filter.

getTreeSorter

public IlrTreeSorter getTreeSorter()

Returns a tree sorter.

Returns:

A tree sorter.

setTreeSorter

public void setTreeSorter(IlrTreeSorter treeSorter)

Sets the tree sorter used to sort nodes in the tree.

Parameters:

treeSorter - A tree sorter.

isRootVisible

public boolean isRootVisible()

Checks if the root node must be rendered in the tree component.

Returns:

If the root is visible in the tree component, true is returned. This default implementation always returns true.

hasChildren

public boolean hasChildren(IlrTreeNode node)

Checks if a node has children. If specified, the child nodes are filtered out.

Parameters:

node - The node.

Returns:

If node has children, true is returned.

See Also:

IlrTreeDataProvider.getChildren(IlrTreeNode), getTreeFilter()

getChildren

public List<IlrTreeNode> getChildren(IlrTreeNode node)

Returns the children of a node.

Parameters:

node - The parent node to retrieve the children from.

Returns:

A list of IlrTreeNode objects.

See Also:

getChildren(IlrTreeNode, boolean)

getChildren

public List<IlrTreeNode> getChildren(IlrTreeNode node,
                                     boolean sortChildren)

Returns the children of a node.

If specified, the child nodes are filtered out.

Parameters:

node - The parent node to retrieve the children from.

sortChildren - Set to true so the nodes are sorted using the tree sorter.

Returns:

A list of IlrTreeNode objects.

See Also:

getTreeFilter(), getTreeSorter()

reset

public void reset()

Resets the state of the tree component.

See Also:

IlrTreeDataProvider.reset(), IlrTreeStateProvider.reset()

isExpanded

public boolean isExpanded(IlrTreeNode node)

Checks if a node is expanded.

Parameters:

node - The node.

Returns:

If node is expanded, true is returned.

expandNode

public void expandNode(IlrTreeNode node)

Expands a node.

This method does nothing if node is already expanded.

Parameters:

node - The node.

collapseNode

public void collapseNode(IlrTreeNode node)

Collapses a node. This method does nothing if node is already collapsed.

Parameters:

node - The node.

isSelected

public boolean isSelected(IlrTreeNode node)

Checks if a node is selected.

Parameters:

node - The node.

Returns:

If node is selected, true is returned.

getSelectedNode

public IlrTreeNode getSelectedNode()

Returns the currently selected node.

Returns:

The current selected node. If no node is selected, null is returned.

setSelectedNode

public boolean setSelectedNode(IlrTreeNode node,
                               boolean fireEvent)

Selects a node. This method does nothing if node is already selected or if IlrTreeListener.selectionChanging(IlrTreeNode) returns false.

Parameters:

node - The node.

fireEvent - Set to true to call IlrTreeListener.selectionChanged(IlrTreeNode).

Returns:

If node is selected, true is returned.

See Also:

IlrTreeListener.selectionChanging(IlrTreeNode), IlrTreeListener.selectionChanged(IlrTreeNode)

showNode

public void showNode(IlrTreeNode node,
                     boolean select)

Shows and selects a node in the tree component.

Parameters:

node - The node.

select - Set to true to select node.

isClickable

public boolean isClickable(IlrTreeNode node)

Checks if a node is clickable.

A node which is not clickable cannot be selected. The default implementation return true.

Parameters:

node - The node.

Returns:

If node is clickable, true is returned.

visit

public void visit(IlrTreeVisitor visitor,
                  IlrTreeNode node,
                  boolean load)

Visits the tree model.

Parameters:

visitor - The visitor.

node - The node to start the tree model visit from.

load - Set to true so nodes are loaded when they are discovered.