Package 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:
TreeBase,TreeTableBase
public abstract class UITree
extends javax.faces.component.UIComponentBase
implements javax.faces.component.NamingContainer
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringFields 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_KEYFields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidbroadcast(javax.faces.event.FacesEvent event) voidbuildRowKeys(TreeNode<?> node) protected booleandoVisitChildren(javax.faces.component.visit.VisitContext context) voidencodeBegin(javax.faces.context.FacesContext context) protected TreeNode<?>findTreeNode(TreeNode<?> searchRoot, String rowKey) getContainerClientId(javax.faces.context.FacesContext context) Class<?>getValue()getVar()voidbooleaninvokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidpopulateRowKeys(TreeNode<?> node, List<String> keys) protected voidpreDecode(javax.faces.context.FacesContext context) protected voidpreEncode(javax.faces.context.FacesContext context) protected voidpreUpdate(javax.faces.context.FacesContext context) protected voidpreValidate(javax.faces.context.FacesContext context) protected voidprocessColumnChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, String nodeKey) protected voidprocessColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root) protected voidprocessComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId) voidprocessDecodes(javax.faces.context.FacesContext context) protected voidprocessFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root) protected voidprocessNode(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root, TreeNode treeNode, String rowKey) protected voidprocessNodes(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root) voidprocessUpdates(javax.faces.context.FacesContext context) voidprocessValidators(javax.faces.context.FacesContext context) voidqueueEvent(javax.faces.event.FacesEvent event) voidprotected booleanvoidsetNodeVar(String _nodeVar) voidsetPropagateSelectionDown(boolean _propagateSelectionDown) voidsetPropagateSelectionUp(boolean _propagateSelectionUp) voidsetRequired(boolean _required) voidsetRequiredMessage(String _requiredMessage) voidvoidvoidprotected voidvoidsetRTLRendering(boolean rtl) voidsetSelection(Object _selection) voidsetSelectionMode(String _selectionMode) voidsetShowUnselectableCheckbox(boolean _showUnselectableCheckbox) voidsetSkipChildren(boolean _skipChildren) voidvoidprotected booleanshouldVisitNode(TreeNode node) voidupdateRowKeys(TreeNode<?> node) voidupdateSelection(javax.faces.context.FacesContext context) protected voidvalidateSelection(javax.faces.context.FacesContext context) protected booleanvisitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component) protected booleanvisitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component) protected booleanvisitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group) protected booleanvisitColumnsAndColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, boolean visitRows, Lazy<TreeNode> root) protected booleanvisitFacets(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, boolean visitNodes) protected booleanvisitNode(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, TreeNode treeNode, String rowKey) protected booleanvisitNodes(javax.faces.component.visit.VisitContext context, Lazy<TreeNode> root, javax.faces.component.visit.VisitCallback callback, boolean visitRows) booleanvisitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback) Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventMethods 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
-
Field Details
-
SEPARATOR
- See Also:
-
REQUIRED_MESSAGE_ID
- See Also:
-
CHECKBOX_CLASS
- See Also:
-
ROOT_ROW_KEY
- See Also:
-
-
Constructor Details
-
UITree
public UITree()
-
-
Method Details
-
getRowKey
-
setRowKey
-
setRowKey
-
setRowKey
-
setRowKey
-
getRowNode
-
getVar
-
setVar
-
getNodeVar
-
setNodeVar
-
getValue
-
setValue
-
getSelectionMode
-
setSelectionMode
-
getSelection
-
setSelection
-
isRequired
public boolean isRequired() -
setRequired
public void setRequired(boolean _required) -
getRequiredMessage
-
setRequiredMessage
-
isSkipChildren
public boolean isSkipChildren() -
setSkipChildren
public void setSkipChildren(boolean _skipChildren) -
isShowUnselectableCheckbox
public boolean isShowUnselectableCheckbox() -
setShowUnselectableCheckbox
public void setShowUnselectableCheckbox(boolean _showUnselectableCheckbox) -
getLocalSelectedNodes
-
isPropagateSelectionDown
public boolean isPropagateSelectionDown() -
setPropagateSelectionDown
public void setPropagateSelectionDown(boolean _propagateSelectionDown) -
isPropagateSelectionUp
public boolean isPropagateSelectionUp() -
setPropagateSelectionUp
public void setPropagateSelectionUp(boolean _propagateSelectionUp) -
findTreeNode
-
buildRowKeys
-
populateRowKeys
-
updateRowKeys
-
initPreselection
public void initPreselection() -
refreshSelectedNodeKeys
public void refreshSelectedNodeKeys() -
getSelectedRowKeysAsString
-
getContainerClientId
- Overrides:
getContainerClientIdin classjavax.faces.component.UIComponent
-
queueEvent
public void queueEvent(javax.faces.event.FacesEvent event) - Overrides:
queueEventin classjavax.faces.component.UIComponentBase
-
broadcast
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException - Overrides:
broadcastin classjavax.faces.component.UIComponentBase- Throws:
javax.faces.event.AbortProcessingException
-
processDecodes
public void processDecodes(javax.faces.context.FacesContext context) - Overrides:
processDecodesin classjavax.faces.component.UIComponentBase
-
processValidators
public void processValidators(javax.faces.context.FacesContext context) - Overrides:
processValidatorsin classjavax.faces.component.UIComponentBase
-
validateSelection
protected void validateSelection(javax.faces.context.FacesContext context) -
processUpdates
public void processUpdates(javax.faces.context.FacesContext context) - Overrides:
processUpdatesin classjavax.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, TreeNode root) -
processNode
-
processFacets
protected void processFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root) -
processColumnFacets
protected void processColumnFacets(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, TreeNode root) -
processColumnChildren
-
processComponent
protected void processComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, javax.faces.event.PhaseId phaseId) -
invokeOnComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException - Overrides:
invokeOnComponentin classjavax.faces.component.UIComponentBase- Throws:
javax.faces.FacesException
-
visitTree
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback) - Overrides:
visitTreein classjavax.faces.component.UIComponent
-
doVisitChildren
protected boolean doVisitChildren(javax.faces.component.visit.VisitContext context) -
visitFacets
-
visitColumnContent
protected boolean visitColumnContent(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component) -
visitNodes
-
visitNode
-
requiresColumns
protected boolean requiresColumns() -
visitColumnsAndColumnFacets
-
visitColumnFacets
protected boolean visitColumnFacets(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, javax.faces.component.UIComponent component) -
visitColumnGroup
protected boolean visitColumnGroup(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback, ColumnGroup group) -
isRTLRendering
public boolean isRTLRendering() -
setRTLRendering
public void setRTLRendering(boolean rtl) -
shouldVisitNode
-
encodeBegin
- Overrides:
encodeBeginin classjavax.faces.component.UIComponentBase- Throws:
IOException
-
preDecode
protected void preDecode(javax.faces.context.FacesContext context) -
preValidate
protected void preValidate(javax.faces.context.FacesContext context) -
preUpdate
protected void preUpdate(javax.faces.context.FacesContext context) -
preEncode
protected void preEncode(javax.faces.context.FacesContext context) -
isSelectionEnabled
public boolean isSelectionEnabled() -
isMultipleSelectionMode
public boolean isMultipleSelectionMode() -
getSelectionType
-
isCheckboxSelectionMode
public boolean isCheckboxSelectionMode()
-