org.olat.core.gui.components.tree
Class MenuTree

java.lang.Object
  org.olat.core.gui.components.Component
      org.olat.core.gui.components.tree.MenuTree

public class MenuTree
extends Component

Description:

Author:

Felix Jost

Field Summary

static java.lang.String	COMMAND_TREENODE_CLICKED event fired when a treenode was clicked (all leaf nodes)
static java.lang.String	COMMAND_TREENODE_EXPANDED event fired when a treenode was expanded (all nodes except leafs)
static java.lang.String	NODE_IDENT Comment for NODE_IDENT

Constructor Summary

MenuTree(java.lang.String name)

MenuTree(java.lang.String name, Controller eventListener)

Method Summary

void	clearSelection()
ComponentRenderer	getHTMLRendererSingleton()
TreeNode	getSelectedNode()
java.lang.String	getSelectedNodeId()
TreeModel	getTreeModel()
boolean	isDirtyForUser() this is true when the user expanded a treenode to view its children.
boolean	isExpandServerOnly()
void	setDirty(boolean dirty)
void	setExpandServerOnly(boolean expandServerOnly)
void	setSelectedNode(TreeNode node)
void	setSelectedNodeId(java.lang.String nodeId)
void	setTreeModel(TreeModel treeModel) Sets the treeModel.
void	validate(UserRequest ureq, ValidationResult vr) called just before the rendering of the -whole tree- takes place, so e.g.

Methods inherited from class org.olat.core.gui.components.Component

addListener, debuginfoGetListeners, dispatchRequest, getAndClearLatestFiredEvent, getComponentName, getDispatchID, getExtendedDebugInfo, getLatestDispatchedController, getListenerInfo, getParent, getSpanAsDomReplaceable, getTimestamp, getTranslator, isDirty, isDomReplaceable, isEnabled, isVisible, setDomReplaceable, setEnabled, setSpanAsDomReplaceable, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NODE_IDENT

public static final java.lang.String NODE_IDENT

Comment for NODE_IDENT

See Also:

Constant Field Values

COMMAND_TREENODE_CLICKED

public static final java.lang.String COMMAND_TREENODE_CLICKED

event fired when a treenode was clicked (all leaf nodes)

See Also:

Constant Field Values

COMMAND_TREENODE_EXPANDED

public static final java.lang.String COMMAND_TREENODE_EXPANDED

event fired when a treenode was expanded (all nodes except leafs)

See Also:

Constant Field Values

Constructor Detail

MenuTree

public MenuTree(java.lang.String name)

Parameters:

name -

MenuTree

public MenuTree(java.lang.String name,
                Controller eventListener)

Parameters:

name -

eventListener -

Method Detail

isDirtyForUser

public boolean isDirtyForUser()

this is true when the user expanded a treenode to view its children. it is false when the user clicked on a node with an action

Overrides:

isDirtyForUser in class Component

Returns:

whether the component has changed from a user's perspective.

See Also:

MenuTree

setDirty

public void setDirty(boolean dirty)

Overrides:

setDirty in class Component

Parameters:

dirty - The dirty to set.

validate

public void validate(UserRequest ureq,
                     ValidationResult vr)

Description copied from class: Component

called just before the rendering of the -whole tree- takes place, so e.g. lazy fetching can be implemented, or issueing a request for a new moduleUri (e.g. for CPComponent, so that the browser loads images correctly). only called when the component is visible

Overrides:

validate in class Component

getSelectedNode

public TreeNode getSelectedNode()

Returns:

the selected node

getSelectedNodeId

public java.lang.String getSelectedNodeId()

Returns:

the selected node's id

setSelectedNodeId

public void setSelectedNodeId(java.lang.String nodeId)

Parameters:

nodeId -

clearSelection

public void clearSelection()

getTreeModel

public TreeModel getTreeModel()

Returns:

MutableTreeModel

setTreeModel

public void setTreeModel(TreeModel treeModel)

Sets the treeModel.

Parameters:

treeModel - The treeModel to set

isExpandServerOnly

public boolean isExpandServerOnly()

Returns:

Returns the expandServerOnly.

setExpandServerOnly

public void setExpandServerOnly(boolean expandServerOnly)

Parameters:

expandServerOnly - The expandServerOnly to set.

setSelectedNode

public void setSelectedNode(TreeNode node)

Parameters:

nodeForum -

getHTMLRendererSingleton

public ComponentRenderer getHTMLRendererSingleton()

Specified by:

getHTMLRendererSingleton in class Component