public abstract class AbstractTreeNode extends javax.faces.component.UIComponentBase implements MetaComponentResolver, MetaComponentEncoder, IterationStateHolder, TreeToggleSource, CoreProps, EventsKeyProps, EventsMouseProps, ImmediateProps, I18nProps, TreeCommonProps
The
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
SUBTREE_META_COMPONENT_ID |
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
META_COMPONENT_SEPARATOR_CHAR
Constructor and Description |
---|
AbstractTreeNode() |
Modifier and Type | Method and Description |
---|---|
void |
addTreeToggleListener(TreeToggleListener listener) |
void |
broadcast(javax.faces.event.FacesEvent event) |
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId) |
AbstractTree |
findTreeComponent() |
String |
getFamily() |
Object |
getIterationState()
Get component state for a current iteration.
|
protected Boolean |
getLocalExpandedValue(javax.faces.context.FacesContext facesContext) |
abstract String |
getOnbeforetoggle()
The client-side script method to be called before the node is toggle.
|
abstract String |
getOntoggle()
The client-side script method to be called after the node is toggle.
|
TreeToggleListener[] |
getTreeToggleListeners() |
abstract String |
getType()
The type of the this component.
|
boolean |
isExpanded()
Determines if this tree node is expanded.
|
void |
queueEvent(javax.faces.event.FacesEvent event) |
void |
removeTreeToggleListener(TreeToggleListener listener) |
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Resolves and returns string identifying supported meta-component or
null if provided meta-component name is
not a supported one. |
void |
setExpanded(boolean newValue) |
void |
setIterationState(Object state)
Set component state for the next iteration.
|
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
Provides replacement for unresolved meta-component names.
|
boolean |
visitTree(javax.faces.component.visit.VisitContext context,
javax.faces.component.visit.VisitCallback callback) |
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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getStyle, getStyleClass, getTitle
getOnkeydown, getOnkeypress, getOnkeyup
getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup
isImmediate
getHandleClass, getIconClass, getIconCollapsed, getIconExpanded, getIconLeaf, getLabelClass
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String SUBTREE_META_COMPONENT_ID
public String getFamily()
getFamily
in class javax.faces.component.UIComponent
public abstract String getType()
public abstract String getOntoggle()
public abstract String getOnbeforetoggle()
protected Boolean getLocalExpandedValue(javax.faces.context.FacesContext facesContext)
public boolean isExpanded()
public void setExpanded(boolean newValue)
public Object getIterationState()
IterationStateHolder
getIterationState
in interface IterationStateHolder
public void setIterationState(Object state)
IterationStateHolder
null
value. In the second case component should reset its state to the initial.setIterationState
in interface IterationStateHolder
state
- request-scope component state or null
. Details are subject for a component implementationpublic AbstractTree findTreeComponent()
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
public void addTreeToggleListener(TreeToggleListener listener)
addTreeToggleListener
in interface TreeToggleSource
public TreeToggleListener[] getTreeToggleListeners()
public void removeTreeToggleListener(TreeToggleListener listener)
removeTreeToggleListener
in interface TreeToggleSource
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
if provided meta-component name is
not a supported one.resolveClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
MetaComponentResolver
null
substituteUnresolvedClientId
in interface MetaComponentResolver
facesContext
- - current instance of FacesContext
contextComponent
- - instance of UIComponent
that requested resolution of meta-componentmetaComponentId
- - name of meta-component (without leading '@' sign)null
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
public void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId) throws IOException
encodeMetaComponent
in interface MetaComponentEncoder
IOException
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.