org.richfaces.component
Class AbstractTreeNode

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.richfaces.component.AbstractTreeNode
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.component.MetaComponentEncoder, org.richfaces.component.MetaComponentResolver, org.richfaces.event.TreeToggleSource
Direct Known Subclasses:
UITreeNode

public abstract class AbstractTreeNode
extends javax.faces.component.UIComponentBase
implements org.richfaces.component.MetaComponentResolver, org.richfaces.component.MetaComponentEncoder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.event.TreeToggleSource

Author:
Nick Belaevski

Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String SUBTREE_META_COMPONENT_ID
           
 
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 org.richfaces.component.MetaComponentResolver
META_COMPONENT_SEPARATOR_CHAR
 
Constructor Summary
AbstractTreeNode()
           
 
Method Summary
 void addTreeToggleListener(org.richfaces.event.TreeToggleListener listener)
           
 void broadcast(javax.faces.event.FacesEvent event)
           
 void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId)
           
 AbstractTree findTreeComponent()
           
 String getFamily()
           
 Object getIterationState()
           
protected  Boolean getLocalExpandedValue(javax.faces.context.FacesContext facesContext)
           
abstract  String getOnbeforetoggle()
           
abstract  String getOntoggle()
           
 org.richfaces.event.TreeToggleListener[] getTreeToggleListeners()
           
abstract  String getType()
           
 boolean isExpanded()
           
abstract  boolean isImmediate()
           
 void queueEvent(javax.faces.event.FacesEvent event)
           
 void removeTreeToggleListener(org.richfaces.event.TreeToggleListener listener)
           
 String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
           
 void setExpanded(boolean newValue)
           
 void setIterationState(Object state)
           
 String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
           
 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, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, 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
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

SUBTREE_META_COMPONENT_ID

public static final String SUBTREE_META_COMPONENT_ID
See Also:
Constant Field Values
Constructor Detail

AbstractTreeNode

public AbstractTreeNode()
Method Detail

getFamily

public String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

isImmediate

public abstract boolean isImmediate()

getType

public abstract String getType()

getOntoggle

public abstract String getOntoggle()

getOnbeforetoggle

public abstract String getOnbeforetoggle()

getLocalExpandedValue

protected Boolean getLocalExpandedValue(javax.faces.context.FacesContext facesContext)

isExpanded

public boolean isExpanded()

setExpanded

public void setExpanded(boolean newValue)

getIterationState

public Object getIterationState()
Specified by:
getIterationState in interface org.ajax4jsf.component.IterationStateHolder

setIterationState

public void setIterationState(Object state)
Specified by:
setIterationState in interface org.ajax4jsf.component.IterationStateHolder

findTreeComponent

public AbstractTree findTreeComponent()

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

addTreeToggleListener

public void addTreeToggleListener(org.richfaces.event.TreeToggleListener listener)
Specified by:
addTreeToggleListener in interface org.richfaces.event.TreeToggleSource

getTreeToggleListeners

public org.richfaces.event.TreeToggleListener[] getTreeToggleListeners()

removeTreeToggleListener

public void removeTreeToggleListener(org.richfaces.event.TreeToggleListener listener)
Specified by:
removeTreeToggleListener in interface org.richfaces.event.TreeToggleSource

resolveClientId

public String resolveClientId(javax.faces.context.FacesContext facesContext,
                              javax.faces.component.UIComponent contextComponent,
                              String metaComponentId)
Specified by:
resolveClientId in interface org.richfaces.component.MetaComponentResolver

substituteUnresolvedClientId

public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
                                           javax.faces.component.UIComponent contextComponent,
                                           String metaComponentId)
Specified by:
substituteUnresolvedClientId in interface org.richfaces.component.MetaComponentResolver

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback)
Overrides:
visitTree in class javax.faces.component.UIComponent

encodeMetaComponent

public void encodeMetaComponent(javax.faces.context.FacesContext context,
                                String metaComponentId)
                         throws IOException
Specified by:
encodeMetaComponent in interface org.richfaces.component.MetaComponentEncoder
Throws:
IOException


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.