org.alfresco.web.ui.repo.component

Class UITree

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.alfresco.web.ui.repo.component.UITree

All Implemented Interfaces:

StateHolder

public class UITree
extends UIComponentBase

JSF component that renders an AJAX based tree for browsing the repository.

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UITree.TreeNode Inner class representing a node in the tree

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER
protected String	nodeCollapsedCallback
protected String	nodeCollapsedUrl
protected String	nodeExpandedCallback
protected String	nodeSelectedCallback
protected String	retrieveChildrenUrl
protected List<UITree.TreeNode>	rootNodes

Constructor Summary

Constructors

Constructor and Description
UITree()

Method Summary

Modifier and Type	Method and Description
String	getFamily()
String	getNodeCollapsedCallback() Returns the Javascript function name to be used for node collapsed event
String	getNodeCollapsedUrl() Returns the URL to use for the AJAX call to inform the server that a node has been collapsed
String	getNodeExpandedCallback() Returns the Javascript function name to be used for node expanded event
String	getNodeSelectedCallback() Returns the Javascript function name to be used for node selected event
String	getRetrieveChildrenUrl() Returns the URL to use for the AJAX call to retrieve the child nodea
List<UITree.TreeNode>	getRootNodes() Get the root nodes for the tree
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setNodeCollapsedCallback(String nodeCollapsedCallback) Sets the name of the Javascript function to use for the node collapsed event
void	setNodeCollapsedUrl(String nodeCollapsedUrl) Sets the AJAX URL to use to inform the server that a node has been collapsed
void	setNodeExpandedCallback(String nodeExpandedCallback) Sets the name of the Javascript function to use for the expanded event
void	setNodeSelectedCallback(String nodeSelectedCallback) Sets the name of the Javascript function to use for the node selected event
void	setRetrieveChildrenUrl(String retrieveChildrenUrl) Sets the AJAX URL to use to retrive child nodes
void	setRootNodes(List<UITree.TreeNode> rootNodes) Set the root nodes for the tree to show

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

rootNodes

protected List<UITree.TreeNode> rootNodes

retrieveChildrenUrl

protected String retrieveChildrenUrl

nodeCollapsedUrl

protected String nodeCollapsedUrl

nodeExpandedCallback

protected String nodeExpandedCallback

nodeCollapsedCallback

protected String nodeCollapsedCallback

nodeSelectedCallback

protected String nodeSelectedCallback

Constructor Detail

UITree

public UITree()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

getRootNodes

public List<UITree.TreeNode> getRootNodes()

Get the root nodes for the tree

Returns:

the list of nodes representing the root nodes of the tree

setRootNodes

public void setRootNodes(List<UITree.TreeNode> rootNodes)

Set the root nodes for the tree to show

Parameters:

rootNodes - The list of node for the tree

getNodeCollapsedCallback

public String getNodeCollapsedCallback()

Returns the Javascript function name to be used for node collapsed event

Returns:

Javascript function name to be used for node collapsed event

setNodeCollapsedCallback

public void setNodeCollapsedCallback(String nodeCollapsedCallback)

Sets the name of the Javascript function to use for the node collapsed event

Parameters:

nodeCollapsedCallback - The Javascript function to use for the node collapsed event

getNodeExpandedCallback

public String getNodeExpandedCallback()

Returns the Javascript function name to be used for node expanded event

Returns:

Javascript function name to be used for node expanded event

setNodeExpandedCallback

public void setNodeExpandedCallback(String nodeExpandedCallback)

Sets the name of the Javascript function to use for the expanded event

Parameters:

nodeExpandedCallback - The Javascript function to use for the expanded event

getNodeSelectedCallback

public String getNodeSelectedCallback()

Returns the Javascript function name to be used for node selected event

Returns:

Javascript function name to be used for node selected event

setNodeSelectedCallback

public void setNodeSelectedCallback(String nodeSelectedCallback)

Sets the name of the Javascript function to use for the node selected event

Parameters:

nodeSelectedCallback - The Javascript function to use for the node selected event

getRetrieveChildrenUrl

public String getRetrieveChildrenUrl()

Returns the URL to use for the AJAX call to retrieve the child nodea

Returns:

AJAX URL to get children

setRetrieveChildrenUrl

public void setRetrieveChildrenUrl(String retrieveChildrenUrl)

Sets the AJAX URL to use to retrive child nodes

Parameters:

retrieveChildrenUrl - The AJAX URL to use

getNodeCollapsedUrl

public String getNodeCollapsedUrl()

Returns the URL to use for the AJAX call to inform the server that a node has been collapsed

Returns:

AJAX URL to inform of node collapse

setNodeCollapsedUrl

public void setNodeCollapsedUrl(String nodeCollapsedUrl)

Sets the AJAX URL to use to inform the server that a node has been collapsed

Parameters:

nodeCollapsedUrl - The AJAX URL to use