public abstract class AbstractTree extends org.richfaces.component.UIDataAdaptor implements org.richfaces.ui.common.meta.MetaComponentResolver, org.richfaces.ui.common.meta.MetaComponentEncoder, TreeSelectionChangeSource, TreeToggleSource
The <rich:tree> component provides a hierarchical tree control. Each <rich:tree> component typically consists of <rich:treeNode> child components. The appearance and behavior of the tree and its nodes can be fully customized.
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
DEFAULT_TREE_NODE_FACET_NAME |
static String |
DEFAULT_TREE_NODE_ID |
static String |
SELECTION_META_COMPONENT_ID |
decodeVisitor, updateVisitor, validateVisitorATTRS_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| Constructor and Description |
|---|
AbstractTree() |
| Modifier and Type | Method and Description |
|---|---|
void |
addTreeSelectionChangeListener(TreeSelectionChangeListener listener) |
void |
addTreeToggleListener(TreeToggleListener listener) |
void |
broadcast(javax.faces.event.FacesEvent event) |
org.richfaces.model.DeclarativeModelKey |
convertDeclarativeKeyFromString(javax.faces.context.FacesContext context,
String modelId,
String modelKeyAsString) |
String |
convertDeclarativeKeyToString(javax.faces.context.FacesContext context,
org.richfaces.model.DeclarativeModelKey declarativeKey) |
protected org.richfaces.model.DataComponentState |
createComponentState() |
protected org.richfaces.model.ExtendedDataModel<?> |
createExtendedDataModel() |
org.richfaces.model.TreeDataModelTuple |
createSnapshot() |
protected Iterator<javax.faces.component.UIComponent> |
dataChildren() |
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
protected javax.faces.component.UIComponent |
findDeclarativeModel(String modelId) |
protected Iterator<javax.faces.component.UIComponent> |
findMatchingTreeNodeComponent(String nodeType,
javax.faces.component.UIComponent parentComponent) |
AbstractTreeNode |
findTreeNodeComponent() |
String |
getFamily() |
abstract String |
getNodeClass() |
abstract String |
getNodeType() |
abstract String |
getOnbeforenodetoggle() |
abstract String |
getOnbeforeselectionchange() |
abstract String |
getOnnodetoggle() |
abstract String |
getOnselectionchange() |
javax.faces.convert.Converter |
getRowKeyConverter() |
Collection<Object> |
getSelection() |
abstract org.richfaces.component.SwitchType |
getSelectionType() |
abstract String |
getToggleNodeEvent() |
abstract org.richfaces.component.SwitchType |
getToggleType() |
protected org.richfaces.model.TreeDataModel<?> |
getTreeDataModel() |
protected TreeRange |
getTreeRange() |
TreeSelectionChangeListener[] |
getTreeSelectionChangeListeners() |
TreeToggleListener[] |
getTreeToggleListeners() |
abstract Object |
getValue() |
boolean |
isExpanded() |
abstract boolean |
isImmediate() |
boolean |
isLeaf() |
void |
removeTreeSelectionChangeListener(TreeSelectionChangeListener listener) |
void |
removeTreeToggleListener(TreeToggleListener listener) |
protected void |
resetDataModel() |
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId) |
protected void |
restoreChildState(javax.faces.context.FacesContext facesContext) |
void |
restoreFromSnapshot(javax.faces.context.FacesContext context,
org.richfaces.model.TreeDataModelTuple tuple) |
void |
setSelection(Collection<Object> selection) |
protected void |
setupCurrentComponent() |
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId) |
protected boolean |
visitFixedChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback) |
void |
walk(javax.faces.context.FacesContext faces,
org.richfaces.model.DataVisitor visitor,
Object argument) |
void |
walkModel(javax.faces.context.FacesContext context,
org.richfaces.model.TreeDataVisitor dataVisitor) |
allFixedChildren, captureOrigValue, clearExtendedDataModel, clearInitialState, createUniqueId, doUpdate, extractKeySegment, fixedChildren, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, getIterationState, getLocalComponentState, getRowCount, getRowData, getRowKey, getRowKeyVar, getStateVar, getVar, getVariablesMap, invokeOnComponent, invokeOnRow, isKeepSaved, isListenerForSource, isRowAvailable, iterate, keepSaved, markInitialState, preDecode, preEncodeBegin, preUpdate, preValidate, processDecodes, processDecodesChildren, processEvent, processEvent, processUpdates, processUpdatesChildren, processValidatesChildren, processValidators, queueEvent, resetChildState, restoreChildState, restoreOrigValue, restoreState, saveChildState, saveChildState, saveState, setExtendedDataModel, setId, setIterationState, setKeepSaved, setRowKey, setRowKey, setRowKeyConverter, setRowKeyVar, setStateVar, setupVariable, setValueExpression, setVar, visitDataChildren, visitDataChildrenMetaComponents, visitTree, wrapEventaddClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInViewpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String SELECTION_META_COMPONENT_ID
public static final String DEFAULT_TREE_NODE_ID
public static final String DEFAULT_TREE_NODE_FACET_NAME
protected TreeRange getTreeRange()
public abstract Object getValue()
public abstract boolean isImmediate()
public abstract String getNodeClass()
public abstract String getOnnodetoggle()
public abstract String getOnbeforenodetoggle()
public abstract String getOnselectionchange()
public abstract String getOnbeforeselectionchange()
public abstract org.richfaces.component.SwitchType getToggleType()
public abstract org.richfaces.component.SwitchType getSelectionType()
public abstract String getNodeType()
public abstract String getToggleNodeEvent()
public String getFamily()
getFamily in class org.richfaces.component.UIDataAdaptorpublic Collection<Object> getSelection()
public void setSelection(Collection<Object> selection)
protected org.richfaces.model.DataComponentState createComponentState()
createComponentState in class org.richfaces.component.UIDataAdaptorpublic javax.faces.convert.Converter getRowKeyConverter()
getRowKeyConverter in class org.richfaces.component.UIDataAdaptorprotected Iterator<javax.faces.component.UIComponent> findMatchingTreeNodeComponent(String nodeType, javax.faces.component.UIComponent parentComponent)
protected void setupCurrentComponent()
public AbstractTreeNode findTreeNodeComponent()
public void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class org.richfaces.component.UIDataAdaptorjavax.faces.event.AbortProcessingExceptionprotected boolean visitFixedChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
visitFixedChildren in class org.richfaces.component.UIDataAdaptorpublic void encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
throws IOException
encodeMetaComponent in interface org.richfaces.ui.common.meta.MetaComponentEncoderIOExceptionpublic String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
resolveClientId in interface org.richfaces.ui.common.meta.MetaComponentResolverpublic String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
substituteUnresolvedClientId in interface org.richfaces.ui.common.meta.MetaComponentResolverprotected Iterator<javax.faces.component.UIComponent> dataChildren()
dataChildren in class org.richfaces.component.UIDataAdaptorpublic void addTreeSelectionChangeListener(TreeSelectionChangeListener listener)
addTreeSelectionChangeListener in interface TreeSelectionChangeSourcepublic TreeSelectionChangeListener[] getTreeSelectionChangeListeners()
public void removeTreeSelectionChangeListener(TreeSelectionChangeListener listener)
removeTreeSelectionChangeListener in interface TreeSelectionChangeSourcepublic void addTreeToggleListener(TreeToggleListener listener)
addTreeToggleListener in interface TreeToggleSourcepublic TreeToggleListener[] getTreeToggleListeners()
public void removeTreeToggleListener(TreeToggleListener listener)
removeTreeToggleListener in interface TreeToggleSourcepublic boolean isExpanded()
protected org.richfaces.model.TreeDataModel<?> getTreeDataModel()
public boolean isLeaf()
public void walk(javax.faces.context.FacesContext faces,
org.richfaces.model.DataVisitor visitor,
Object argument)
walk in class org.richfaces.component.UIDataAdaptorprotected org.richfaces.model.ExtendedDataModel<?> createExtendedDataModel()
createExtendedDataModel in class org.richfaces.component.UIDataAdaptorpublic void walkModel(javax.faces.context.FacesContext context,
org.richfaces.model.TreeDataVisitor dataVisitor)
protected void resetDataModel()
resetDataModel in class org.richfaces.component.UIDataAdaptorpublic org.richfaces.model.TreeDataModelTuple createSnapshot()
public void restoreFromSnapshot(javax.faces.context.FacesContext context,
org.richfaces.model.TreeDataModelTuple tuple)
protected void restoreChildState(javax.faces.context.FacesContext facesContext)
restoreChildState in class org.richfaces.component.UIDataAdaptorprotected javax.faces.component.UIComponent findDeclarativeModel(String modelId)
public String convertDeclarativeKeyToString(javax.faces.context.FacesContext context, org.richfaces.model.DeclarativeModelKey declarativeKey) throws javax.faces.convert.ConverterException
javax.faces.convert.ConverterExceptionCopyright © 2013 JBoss by Red Hat. All Rights Reserved.