org.primefaces.component.api

Class UITree

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.api.UITree

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

Tree, TreeTable

public abstract class UITree
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UITree.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECKBOX_CLASS
static String	REQUIRED_MESSAGE_ID
static String	SEPARATOR

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UITree()

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
void	buildRowKeys(TreeNode node)
protected boolean	doVisitChildren(javax.faces.component.visit.VisitContext context)
protected TreeNode	findTreeNode(TreeNode searchRoot, String rowKey)
String	getContainerClientId(javax.faces.context.FacesContext context)
Object	getLocalSelectedNodes()
String	getNodeVar()
String	getRequiredMessage()
String	getRowKey()
TreeNode	getRowNode()
String	getSelectedRowKeysAsString()
Object	getSelection()
String	getSelectionMode()
TreeNode	getValue()
String	getVar()
void	initPreselection()
boolean	isRequired()
boolean	isRTLRendering()
boolean	isShowUnselectableCheckbox()
boolean	isSkipChildren()
void	populateRowKeys(TreeNode node, List<String> keys)
protected void	processColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, String nodeKey)
protected void	processColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected void	processComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId)
void	processDecodes(javax.faces.context.FacesContext context)
protected void	processFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected void	processNode(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode treeNode, String rowKey)
protected void	processNodes(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	refreshSelectedNodeKeys()
void	setNodeVar(String _nodeVar)
void	setRequired(boolean _required)
void	setRequiredMessage(String _requiredMessage)
void	setRowKey(String rowKey)
void	setRTLRendering(boolean rtl)
void	setSelection(Object _selection)
void	setSelectionMode(String _selectionMode)
void	setShowUnselectableCheckbox(boolean _showUnselectableCheckbox)
void	setSkipChildren(boolean _skipChildren)
void	setValue(TreeNode _value)
void	setVar(String _var)
protected boolean	shouldVisitNode(TreeNode node)
void	updateRowKeys(TreeNode node)
void	updateSelection(javax.faces.context.FacesContext context)
protected void	validateSelection(javax.faces.context.FacesContext context)
protected boolean	visitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component)
protected boolean	visitFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
protected boolean	visitNode(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, TreeNode treeNode, String rowKey)
protected boolean	visitNodes(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getFamily, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

REQUIRED_MESSAGE_ID

public static final String REQUIRED_MESSAGE_ID

See Also:

Constant Field Values

CHECKBOX_CLASS

public static final String CHECKBOX_CLASS

See Also:

Constant Field Values

Constructor Detail

UITree

public UITree()

Method Detail

getRowKey

public String getRowKey()

setRowKey

public void setRowKey(String rowKey)

getRowNode

public TreeNode getRowNode()

getVar

public String getVar()

setVar

public void setVar(String _var)

getNodeVar

public String getNodeVar()

setNodeVar

public void setNodeVar(String _nodeVar)

getValue

public TreeNode getValue()

setValue

public void setValue(TreeNode _value)

getSelectionMode

public String getSelectionMode()

setSelectionMode

public void setSelectionMode(String _selectionMode)

getSelection

public Object getSelection()

setSelection

public void setSelection(Object _selection)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean _required)

getRequiredMessage

public String getRequiredMessage()

setRequiredMessage

public void setRequiredMessage(String _requiredMessage)

isSkipChildren

public boolean isSkipChildren()

setSkipChildren

public void setSkipChildren(boolean _skipChildren)

isShowUnselectableCheckbox

public boolean isShowUnselectableCheckbox()

setShowUnselectableCheckbox

public void setShowUnselectableCheckbox(boolean _showUnselectableCheckbox)

getLocalSelectedNodes

public Object getLocalSelectedNodes()

findTreeNode

protected TreeNode findTreeNode(TreeNode searchRoot,
                    String rowKey)

buildRowKeys

public void buildRowKeys(TreeNode node)

populateRowKeys

public void populateRowKeys(TreeNode node,
                   List<String> keys)

updateRowKeys

public void updateRowKeys(TreeNode node)

initPreselection

public void initPreselection()

refreshSelectedNodeKeys

public void refreshSelectedNodeKeys()

getSelectedRowKeysAsString

public String getSelectedRowKeysAsString()

getContainerClientId

public String getContainerClientId(javax.faces.context.FacesContext context)

Overrides:

getContainerClientId in class javax.faces.component.UIComponent

queueEvent

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

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

processDecodes

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

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

processValidators

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

Overrides:

processValidators in class javax.faces.component.UIComponentBase

validateSelection

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

processUpdates

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

Overrides:

processUpdates in class javax.faces.component.UIComponentBase

updateSelection

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

processNodes

protected void processNodes(javax.faces.context.FacesContext context,
                javax.faces.event.PhaseId phaseId)

processNode

protected void processNode(javax.faces.context.FacesContext context,
               javax.faces.event.PhaseId phaseId,
               TreeNode treeNode,
               String rowKey)

processFacets

protected void processFacets(javax.faces.context.FacesContext context,
                 javax.faces.event.PhaseId phaseId)

processColumnFacets

protected void processColumnFacets(javax.faces.context.FacesContext context,
                       javax.faces.event.PhaseId phaseId)

processColumnChildren

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

processComponent

protected void processComponent(javax.faces.context.FacesContext context,
                    javax.faces.component.UIComponent component,
                    javax.faces.event.PhaseId phaseId)

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIComponent

doVisitChildren

protected boolean doVisitChildren(javax.faces.component.visit.VisitContext context)

visitFacets

protected boolean visitFacets(javax.faces.component.visit.VisitContext context,
                  javax.faces.component.visit.VisitCallback callback)

visitColumnContent

protected boolean visitColumnContent(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback,
                         javax.faces.component.UIComponent component)

visitNodes

protected boolean visitNodes(javax.faces.component.visit.VisitContext context,
                 javax.faces.component.visit.VisitCallback callback)

visitNode

protected boolean visitNode(javax.faces.component.visit.VisitContext context,
                javax.faces.component.visit.VisitCallback callback,
                TreeNode treeNode,
                String rowKey)

isRTLRendering

public boolean isRTLRendering()

setRTLRendering

public void setRTLRendering(boolean rtl)

shouldVisitNode

protected boolean shouldVisitNode(TreeNode node)