org.primefaces.component.tree

Class Tree

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.api.UITree

org.primefaces.component.tree.Tree

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, PrimeClientBehaviorHolder, RTLAware, Widget

public class Tree
extends UITree

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	org.primefaces.component.tree.TreeBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILDREN_NODES_CLASS
static String	COLLAPSED_ICON_CLASS_H
static String	COLLAPSED_ICON_CLASS_V
static String	COLLAPSED_ICON_RTL_CLASS_V
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
static String	CONTAINER_RTL_CLASS
static String	DEFAULT_RENDERER
static String	EXPANDED_ICON_CLASS_H
static String	EXPANDED_ICON_CLASS_V
static String	FILTER_CLASS
static String	FILTER_CONTAINER
static String	HORIZONTAL_CONTAINER_CLASS
static String	LEAF_ICON_CLASS
static String	LEAF_NODE_CLASS
static String	NODE_CONTENT_CLASS_H
static String	NODE_CONTENT_CLASS_V
static String	NODE_ICON_CLASS
static String	NODE_LABEL_CLASS
static String	PARENT_NODE_CLASS
static String	ROOT_NODES_CLASS
static String	SELECTABLE_NODE_CONTENT_CLASS_H
static String	SELECTABLE_NODE_CONTENT_CLASS_V

Fields inherited from class org.primefaces.component.api.UITree

CHECKBOX_CLASS, REQUIRED_MESSAGE_ID, ROOT_ROW_KEY, SEPARATOR

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
Tree()

Method Summary

Modifier and Type	Method and Description
TreeNode	createCopyOfTreeNode(TreeNode node)
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
Object	getDatakey()
String	getDir()
String	getDragdropScope()
String	getDragMode()
String	getDropRestrict()
Collection<String>	getEventNames()
String	getFamily()
Object	getFilterBy()
List<String>	getFilteredRowKeys()
String	getFilterMatchMode()
String	getFilterMode()
javax.el.MethodExpression	getOnDrop()
String	getOnNodeClick()
String	getOrientation()
String	getScrollState()
String	getStyle()
String	getStyleClass()
int	getTabindex()
Map<String,UITreeNode>	getTreeNodes()
UITreeNode	getUITreeNodeByType(String type)
String	getWidgetVar()
boolean	isAnimate()
boolean	isCache()
boolean	isCheckboxSelection()
boolean	isDisabled()
boolean	isDragDropRequest(javax.faces.context.FacesContext context)
boolean	isDraggable()
boolean	isDropCopyNode()
boolean	isDroppable()
boolean	isDynamic()
boolean	isFilterRequest(javax.faces.context.FacesContext context)
boolean	isHighlight()
boolean	isMultipleDrag()
boolean	isNodeExpandRequest(javax.faces.context.FacesContext context)
boolean	isPropagateSelectionDown()
boolean	isPropagateSelectionUp()
boolean	isRTL()
boolean	isSelectionRequest(javax.faces.context.FacesContext context)
boolean	isTreeNodeDropped()
protected void	processColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, String nodeKey)
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
String	resolveWidgetVar()
void	setAnimate(boolean animate)
void	setCache(boolean cache)
void	setDatakey(Object datakey)
void	setDir(String dir)
void	setDisabled(boolean disabled)
void	setDragdropScope(String dragdropScope)
void	setDraggable(boolean draggable)
void	setDragMode(String dragMode)
void	setDropCopyNode(boolean dropCopyNode)
void	setDroppable(boolean droppable)
void	setDropRestrict(String dropRestrict)
void	setDynamic(boolean dynamic)
void	setFilterBy(Object filterBy)
void	setFilteredRowKeys(List<String> filteredRowKeys)
void	setFilterMatchMode(String filterMatchMode)
void	setFilterMode(String filterMode)
void	setHighlight(boolean highlight)
void	setMultipleDrag(boolean multipleDrag)
void	setOnDrop(javax.el.MethodExpression onDrop)
void	setOnNodeClick(String onNodeClick)
void	setOrientation(String orientation)
void	setPropagateSelectionDown(boolean propagateSelectionDown)
void	setPropagateSelectionUp(boolean propagateSelectionUp)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTabindex(int tabindex)
void	setWidgetVar(String widgetVar)
protected boolean	shouldVisitNode(TreeNode node)
protected void	validateSelection(javax.faces.context.FacesContext context)

Methods inherited from class org.primefaces.component.api.UITree

broadcast, buildRowKeys, doVisitChildren, encodeBegin, findTreeNode, getContainerClientId, getLocalSelectedNodes, getNodeVar, getRequiredMessage, getRowKey, getRowNode, getSelectedRowKeysAsString, getSelection, getSelectionMode, getValue, getVar, initPreselection, isNestedWithinIterator, isRequired, isRTLRendering, isShowUnselectableCheckbox, isSkipChildren, populateRowKeys, preDecode, preEncode, preUpdate, preValidate, processColumnFacets, processComponent, processFacets, processNode, processNodes, refreshSelectedNodeKeys, requiresIteration, setNodeVar, setRequired, setRequiredMessage, setRowKey, setRTLRendering, setSelection, setSelectionMode, setShowUnselectableCheckbox, setSkipChildren, setValue, setVar, updateRowKeys, updateSelection, visitColumnContent, visitFacets, visitNode, visitNodes, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

FILTER_CLASS

public static final String FILTER_CLASS

See Also:

Constant Field Values

FILTER_CONTAINER

public static final String FILTER_CONTAINER

See Also:

Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

Constant Field Values

CONTAINER_RTL_CLASS

public static final String CONTAINER_RTL_CLASS

See Also:

Constant Field Values

HORIZONTAL_CONTAINER_CLASS

public static final String HORIZONTAL_CONTAINER_CLASS

See Also:

Constant Field Values

ROOT_NODES_CLASS

public static final String ROOT_NODES_CLASS

See Also:

Constant Field Values

PARENT_NODE_CLASS

public static final String PARENT_NODE_CLASS

See Also:

Constant Field Values

LEAF_NODE_CLASS

public static final String LEAF_NODE_CLASS

See Also:

Constant Field Values

CHILDREN_NODES_CLASS

public static final String CHILDREN_NODES_CLASS

See Also:

Constant Field Values

NODE_CONTENT_CLASS_V

public static final String NODE_CONTENT_CLASS_V

See Also:

Constant Field Values

SELECTABLE_NODE_CONTENT_CLASS_V

public static final String SELECTABLE_NODE_CONTENT_CLASS_V

See Also:

Constant Field Values

NODE_CONTENT_CLASS_H

public static final String NODE_CONTENT_CLASS_H

See Also:

Constant Field Values

SELECTABLE_NODE_CONTENT_CLASS_H

public static final String SELECTABLE_NODE_CONTENT_CLASS_H

See Also:

Constant Field Values

EXPANDED_ICON_CLASS_V

public static final String EXPANDED_ICON_CLASS_V

See Also:

Constant Field Values

COLLAPSED_ICON_CLASS_V

public static final String COLLAPSED_ICON_CLASS_V

See Also:

Constant Field Values

COLLAPSED_ICON_RTL_CLASS_V

public static final String COLLAPSED_ICON_RTL_CLASS_V

See Also:

Constant Field Values

EXPANDED_ICON_CLASS_H

public static final String EXPANDED_ICON_CLASS_H

See Also:

Constant Field Values

COLLAPSED_ICON_CLASS_H

public static final String COLLAPSED_ICON_CLASS_H

See Also:

Constant Field Values

LEAF_ICON_CLASS

public static final String LEAF_ICON_CLASS

See Also:

Constant Field Values

NODE_ICON_CLASS

public static final String NODE_ICON_CLASS

See Also:

Constant Field Values

NODE_LABEL_CLASS

public static final String NODE_LABEL_CLASS

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

Tree

public Tree()

Method Detail

getUITreeNodeByType

public UITreeNode getUITreeNodeByType(String type)

isNodeExpandRequest

public boolean isNodeExpandRequest(javax.faces.context.FacesContext context)

isSelectionRequest

public boolean isSelectionRequest(javax.faces.context.FacesContext context)

isFilterRequest

public boolean isFilterRequest(javax.faces.context.FacesContext context)

getTreeNodes

public Map<String,UITreeNode> getTreeNodes()

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class UITree

isDragDropRequest

public boolean isDragDropRequest(javax.faces.context.FacesContext context)

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class UITree

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class UITree

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class UITree

isCheckboxSelection

public boolean isCheckboxSelection()

shouldVisitNode

protected boolean shouldVisitNode(TreeNode node)

Overrides:

shouldVisitNode in class UITree

processColumnChildren

protected void processColumnChildren(javax.faces.context.FacesContext context,
                                     javax.faces.event.PhaseId phaseId,
                                     String nodeKey)

Overrides:

processColumnChildren in class UITree

validateSelection

protected void validateSelection(javax.faces.context.FacesContext context)

Overrides:

validateSelection in class UITree

createCopyOfTreeNode

public TreeNode createCopyOfTreeNode(TreeNode node)

isTreeNodeDropped

public boolean isTreeNodeDropped()

getScrollState

public String getScrollState()

getFilteredRowKeys

public List<String> getFilteredRowKeys()

setFilteredRowKeys

public void setFilteredRowKeys(List<String> filteredRowKeys)

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

isCache

public boolean isCache()

setCache

public void setCache(boolean cache)

getOnNodeClick

public String getOnNodeClick()

setOnNodeClick

public void setOnNodeClick(String onNodeClick)

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

isHighlight

public boolean isHighlight()

setHighlight

public void setHighlight(boolean highlight)

getDatakey

public Object getDatakey()

setDatakey

public void setDatakey(Object datakey)

isAnimate

public boolean isAnimate()

setAnimate

public void setAnimate(boolean animate)

getOrientation

public String getOrientation()

setOrientation

public void setOrientation(String orientation)

isPropagateSelectionUp

public boolean isPropagateSelectionUp()

setPropagateSelectionUp

public void setPropagateSelectionUp(boolean propagateSelectionUp)

isPropagateSelectionDown

public boolean isPropagateSelectionDown()

setPropagateSelectionDown

public void setPropagateSelectionDown(boolean propagateSelectionDown)

getDir

public String getDir()

setDir

public void setDir(String dir)

isDraggable

public boolean isDraggable()

setDraggable

public void setDraggable(boolean draggable)

isDroppable

public boolean isDroppable()

setDroppable

public void setDroppable(boolean droppable)

getDragdropScope

public String getDragdropScope()

setDragdropScope

public void setDragdropScope(String dragdropScope)

getDragMode

public String getDragMode()

setDragMode

public void setDragMode(String dragMode)

getDropRestrict

public String getDropRestrict()

setDropRestrict

public void setDropRestrict(String dropRestrict)

getTabindex

public int getTabindex()

setTabindex

public void setTabindex(int tabindex)

getFilterBy

public Object getFilterBy()

setFilterBy

public void setFilterBy(Object filterBy)

getFilterMatchMode

public String getFilterMatchMode()

setFilterMatchMode

public void setFilterMatchMode(String filterMatchMode)

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean disabled)

isMultipleDrag

public boolean isMultipleDrag()

setMultipleDrag

public void setMultipleDrag(boolean multipleDrag)

isDropCopyNode

public boolean isDropCopyNode()

setDropCopyNode

public void setDropCopyNode(boolean dropCopyNode)

getOnDrop

public javax.el.MethodExpression getOnDrop()

setOnDrop

public void setOnDrop(javax.el.MethodExpression onDrop)

getFilterMode

public String getFilterMode()

setFilterMode

public void setFilterMode(String filterMode)

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget

isRTL

public boolean isRTL()

Specified by:

isRTL in interface RTLAware