RichFaces UI Components UI 4.3.1.Final

org.richfaces.component
Class AbstractTogglePanel

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.richfaces.component.AbstractTogglePanel
All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AbstractDivPanel, org.richfaces.component.MetaComponentEncoder, org.richfaces.component.MetaComponentResolver, org.richfaces.event.ItemChangeSource
Direct Known Subclasses:
AbstractAccordion, AbstractCollapsiblePanel, AbstractTabPanel, UITogglePanel

public abstract class AbstractTogglePanel
extends javax.faces.component.UIOutput
implements AbstractDivPanel, org.richfaces.event.ItemChangeSource, org.richfaces.component.MetaComponentResolver, org.richfaces.component.MetaComponentEncoder

The <rich:togglePanel> component is used as a base for the other switchable components, the <rich:accordion> component and the <rich:tabPanel> component. It provides an abstract switchable component without any associated markup. As such, the <rich:togglePanel> component could be customized to provide a switchable component when neither an accordion component or a tab panel component is appropriate.

Author:
akolonitsky, Brian Leathem

Field Summary
static String ACTIVE_ITEM_META_COMPONENT
           
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String META_NAME_FIRST
           
static String META_NAME_LAST
           
static String META_NAME_NEXT
           
static String META_NAME_PREV
           
static String UPDATE_MESSAGE_ID
           
 
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 org.richfaces.component.MetaComponentResolver
META_COMPONENT_SEPARATOR_CHAR
 
Constructor Summary
protected AbstractTogglePanel()
           
 
Method Summary
 void addItemChangeListener(org.richfaces.event.ItemChangeListener listener)
           
 void broadcast(javax.faces.event.FacesEvent event)
           
 void decode(javax.faces.context.FacesContext facesContext)
           
 void encodeBegin(javax.faces.context.FacesContext facesContext)
           
 void encodeMetaComponent(javax.faces.context.FacesContext facesContext, String metaComponentId)
           
 String getActiveItem()
          Holds the active panel name.
 int getChildIndex(String name)
          Deprecated. 
abstract  Object getData()
           
abstract  Object getExecute()
           
 String getFamily()
           
 AbstractTogglePanelItemInterface getFirstItem()
           
 int getIndexByName(String name)
           
 AbstractTogglePanelItemInterface getItem(String name)
           
 AbstractTogglePanelItemInterface getItemByIndex(int index)
           
abstract  javax.el.MethodExpression getItemChangeListener()
          Occurs on the server side when an item is changed through Ajax using the server mode
 org.richfaces.event.ItemChangeListener[] getItemChangeListeners()
           
 int getItemCount()
           
 AbstractTogglePanelItemInterface getLastItem()
           
 String getNameByIndex(int index)
           
 AbstractTogglePanelItemInterface getNextItem()
           
 AbstractTogglePanelItemInterface getNextItem(String name)
           
abstract  String getOnbeforeitemchange()
          The client-side script method to be called before the item is changed.
abstract  String getOnitemchange()
          The client-side script method to be called after the item is changed.
 AbstractTogglePanelItemInterface getPrevItem()
           
 AbstractTogglePanelItemInterface getPrevItem(String name)
           
abstract  Object getRender()
           
 boolean getRendersChildren()
           
abstract  String getStatus()
           
 String getSubmittedActiveItem()
           
 Object getSubmittedValue()
           
 org.richfaces.component.SwitchType getSwitchType()
          The switch mode when a panel is activated.
 TogglePanelVisitState getVisitStateByName(String name)
           
protected  boolean isActiveItem(AbstractTogglePanelItemInterface item, String value)
           
protected  boolean isActiveItem(javax.faces.component.UIComponent kid)
           
protected  boolean isActiveItem(javax.faces.component.UIComponent kid, String value)
           
abstract  boolean isCycledSwitching()
          Applicable when cycling through the tabs.
 boolean isImmediate()
          Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
abstract  boolean isLimitRender()
           
 boolean isLocalValueSet()
           
static boolean isPanelItemDynamic(javax.faces.component.UIComponent component)
           
 boolean isRequired()
           
 boolean isValid()
           
 void processDecodes(javax.faces.context.FacesContext facesContext)
           Specialized decode behavior on top of that provided by the superclass.
 void processUpdates(javax.faces.context.FacesContext facesContext)
           In addition to the standard processUpdates behavior inherited from UIComponentBase, calls updateModel().
 void processValidators(javax.faces.context.FacesContext facesContext)
           In addition to the standard processValidators behavior inherited from UIComponentBase, calls processValue() if the immediate property is false (which is the default); if the component is invalid afterwards, calls FacesContext.renderResponse().
 void queueEvent(javax.faces.event.FacesEvent event)
           
 void removeItemChangeListener(org.richfaces.event.ItemChangeListener listener)
           
 void resetValue()
           
 String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
           
 void setActiveItem(String value)
           
protected  void setEventPhase(javax.faces.event.FacesEvent event)
           
protected  void setEventPhase(org.richfaces.event.ItemChangeEvent event)
           
 void setImmediate(boolean immediate)
           
 void setLocalValueSet(boolean localValueSet)
           
 void setRequired(boolean required)
           Set the "required field" state for this component.
 void setSubmittedActiveItem(String submittedActiveItem)
           
 void setSubmittedValue(Object submittedValue)
           
 void setSwitchType(org.richfaces.component.SwitchType switchType)
           
 void setValid(boolean valid)
           
 void setValue(Object value)
           
 void setValueExpression(String name, javax.el.ValueExpression binding)
           
 String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
           
 String updateActiveName(String activeItemName)
           
 void updateModel(javax.faces.context.FacesContext facesContext)
           
 TogglePanelVisitState visitTogglePanelItems(AbstractTogglePanel panel, TogglePanelVisitCallback callback)
           
 boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
           
 
Methods inherited from class javax.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.richfaces.component.AbstractDivPanel
getDir, getLang, getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getStyle, getStyleClass, getTitle
 

Field Detail

ACTIVE_ITEM_META_COMPONENT

public static final String ACTIVE_ITEM_META_COMPONENT
See Also:
Constant Field Values

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

META_NAME_FIRST

public static final String META_NAME_FIRST
See Also:
Constant Field Values

META_NAME_PREV

public static final String META_NAME_PREV
See Also:
Constant Field Values

META_NAME_NEXT

public static final String META_NAME_NEXT
See Also:
Constant Field Values

META_NAME_LAST

public static final String META_NAME_LAST
See Also:
Constant Field Values

UPDATE_MESSAGE_ID

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

AbstractTogglePanel

protected AbstractTogglePanel()
Method Detail

isPanelItemDynamic

public static boolean isPanelItemDynamic(javax.faces.component.UIComponent component)

getSubmittedValue

public Object getSubmittedValue()

resetValue

public void resetValue()

setSubmittedValue

public void setSubmittedValue(Object submittedValue)

isLocalValueSet

public boolean isLocalValueSet()

setLocalValueSet

public void setLocalValueSet(boolean localValueSet)

isValid

public boolean isValid()

setValid

public void setValid(boolean valid)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

Set the "required field" state for this component.

Parameters:
required - The new "required field" state

isImmediate

public boolean isImmediate()
Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.


setImmediate

public void setImmediate(boolean immediate)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext facesContext)
                 throws IOException
Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Throws:
IOException

updateActiveName

public String updateActiveName(String activeItemName)

processDecodes

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

Specialized decode behavior on top of that provided by the superclass. In addition to the standard processDecodes behavior inherited from UIComponentBase, calls processValue() if the the immediate property is true; if the component is invalid afterwards or a RuntimeException is thrown, calls FacesContext.renderResponse().

Overrides:
processDecodes in class javax.faces.component.UIComponentBase
Throws:
NullPointerException

processValidators

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

In addition to the standard processValidators behavior inherited from UIComponentBase, calls processValue() if the immediate property is false (which is the default); if the component is invalid afterwards, calls FacesContext.renderResponse(). If a RuntimeException is thrown during validation processing, calls FacesContext.renderResponse() and re-throw the exception.

Overrides:
processValidators in class javax.faces.component.UIComponentBase
Throws:
NullPointerException

processUpdates

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

In addition to the standard processUpdates behavior inherited from UIComponentBase, calls updateModel(). If the component is invalid afterwards, calls FacesContext.renderResponse(). If a RuntimeException is thrown during update processing, calls FacesContext.renderResponse() and re-throw the exception.

Overrides:
processUpdates in class javax.faces.component.UIComponentBase
Throws:
NullPointerException

decode

public void decode(javax.faces.context.FacesContext facesContext)
Overrides:
decode in class javax.faces.component.UIComponentBase
Throws:
NullPointerException

updateModel

public void updateModel(javax.faces.context.FacesContext facesContext)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)
Overrides:
queueEvent in class javax.faces.component.UIComponentBase

setEventPhase

protected void setEventPhase(org.richfaces.event.ItemChangeEvent event)

setEventPhase

protected void setEventPhase(javax.faces.event.FacesEvent event)

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

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.UIOutput

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class javax.faces.component.UIComponentBase

isActiveItem

protected boolean isActiveItem(javax.faces.component.UIComponent kid)

isActiveItem

protected boolean isActiveItem(javax.faces.component.UIComponent kid,
                               String value)

isActiveItem

protected boolean isActiveItem(AbstractTogglePanelItemInterface item,
                               String value)

visitTogglePanelItems

public TogglePanelVisitState visitTogglePanelItems(AbstractTogglePanel panel,
                                                   TogglePanelVisitCallback callback)

getVisitStateByName

public TogglePanelVisitState getVisitStateByName(String name)

getItemByIndex

public AbstractTogglePanelItemInterface getItemByIndex(int index)

getNameByIndex

public String getNameByIndex(int index)

getIndexByName

public int getIndexByName(String name)

getItemCount

public int getItemCount()

getItem

public AbstractTogglePanelItemInterface getItem(String name)

getFirstItem

public AbstractTogglePanelItemInterface getFirstItem()

getPrevItem

public AbstractTogglePanelItemInterface getPrevItem()

getPrevItem

public AbstractTogglePanelItemInterface getPrevItem(String name)

getNextItem

public AbstractTogglePanelItemInterface getNextItem()

getNextItem

public AbstractTogglePanelItemInterface getNextItem(String name)

getLastItem

public AbstractTogglePanelItemInterface getLastItem()

getChildIndex

@Deprecated
public int getChildIndex(String name)
Deprecated. 


getSubmittedActiveItem

public String getSubmittedActiveItem()

setSubmittedActiveItem

public void setSubmittedActiveItem(String submittedActiveItem)

setValue

public void setValue(Object value)
Specified by:
setValue in interface javax.faces.component.ValueHolder
Overrides:
setValue in class javax.faces.component.UIOutput

getActiveItem

public String getActiveItem()
Holds the active panel name. This name is a reference to the name identifier of the active child <rich:togglePanelItem> component.


setActiveItem

public void setActiveItem(String value)

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression binding)
Overrides:
setValueExpression in class javax.faces.component.UIComponent

getSwitchType

public org.richfaces.component.SwitchType getSwitchType()
The switch mode when a panel is activated. One of: "client", "server", "ajax". Default: "ajax"


setSwitchType

public void setSwitchType(org.richfaces.component.SwitchType switchType)

isLimitRender

public abstract boolean isLimitRender()

isCycledSwitching

public abstract boolean isCycledSwitching()
Applicable when cycling through the tabs. If "true", then when the last tab is active, cycling to next will activate the first tab, if "false", cycling to next will have not effect. The inverse applies for the first tab, and cycling to previous. Whether to Default: false


getData

public abstract Object getData()

getStatus

public abstract String getStatus()

getExecute

public abstract Object getExecute()

getRender

public abstract Object getRender()

getItemChangeListener

public abstract javax.el.MethodExpression getItemChangeListener()
Occurs on the server side when an item is changed through Ajax using the server mode


getOnitemchange

public abstract String getOnitemchange()
The client-side script method to be called after the item is changed.


getOnbeforeitemchange

public abstract String getOnbeforeitemchange()
The client-side script method to be called before the item is changed.


addItemChangeListener

public void addItemChangeListener(org.richfaces.event.ItemChangeListener listener)
Specified by:
addItemChangeListener in interface org.richfaces.event.ItemChangeSource

getItemChangeListeners

public org.richfaces.event.ItemChangeListener[] getItemChangeListeners()
Specified by:
getItemChangeListeners in interface org.richfaces.event.ItemChangeSource

removeItemChangeListener

public void removeItemChangeListener(org.richfaces.event.ItemChangeListener listener)
Specified by:
removeItemChangeListener in interface org.richfaces.event.ItemChangeSource

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

encodeMetaComponent

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

visitTree

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

RichFaces UI Components UI 4.3.1.Final

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.