org.richfaces.component
Class AbstractTogglePanel
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
org.richfaces.component.AbstractTogglePanel
- All Implemented Interfaces:
- EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, 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
- Version:
- 1.0
- Author:
- akolonitsky
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 |
Method Summary |
void |
addItemChangeListener(org.richfaces.event.ItemChangeListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
|
void |
decode(javax.faces.context.FacesContext context)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
|
String |
getActiveItem()
|
int |
getChildIndex(String name)
|
abstract Object |
getData()
|
abstract Object |
getExecute()
|
String |
getFamily()
|
AbstractTogglePanelItemInterface |
getFirstItem()
|
AbstractTogglePanelItemInterface |
getItem(String name)
|
AbstractTogglePanelItemInterface |
getItemByIndex(int index)
|
abstract javax.el.MethodExpression |
getItemChangeListener()
|
org.richfaces.event.ItemChangeListener[] |
getItemChangeListeners()
|
List<AbstractTogglePanelItemInterface> |
getItems(boolean isRendered)
|
AbstractTogglePanelItemInterface |
getLastItem()
|
AbstractTogglePanelItemInterface |
getNextItem()
|
AbstractTogglePanelItemInterface |
getNextItem(String name)
|
abstract String |
getOnbeforeitemchange()
|
abstract String |
getOnitemchange()
|
AbstractTogglePanelItemInterface |
getPrevItem()
|
AbstractTogglePanelItemInterface |
getPrevItem(String name)
|
abstract Object |
getRender()
|
List<AbstractTogglePanelItemInterface> |
getRenderedItems()
|
boolean |
getRendersChildren()
|
abstract String |
getStatus()
|
String |
getSubmittedActiveItem()
|
Object |
getSubmittedValue()
|
org.richfaces.component.SwitchType |
getSwitchType()
|
protected boolean |
isActiveItem(javax.faces.component.UIComponent kid)
|
protected boolean |
isActiveItem(javax.faces.component.UIComponent kid,
String value)
|
abstract boolean |
isCycledSwitching()
|
boolean |
isImmediate()
|
abstract boolean |
isLimitRender()
|
boolean |
isLocalValueSet()
|
boolean |
isRequired()
|
boolean |
isValid()
|
void |
processDecodes(javax.faces.context.FacesContext context)
Specialized decode behavior on top of that provided by the
superclass. |
void |
processUpdates(javax.faces.context.FacesContext context)
In addition to the standard processUpdates behavior
inherited from UIComponentBase , calls
updateModel() . |
void |
processValidators(javax.faces.context.FacesContext context)
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)
|
void |
updateModel(javax.faces.context.FacesContext context)
|
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, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, 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, subscribeToEvent, unsubscribeFromEvent |
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 |
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
AbstractTogglePanel
protected AbstractTogglePanel()
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()
setImmediate
public void setImmediate(boolean immediate)
encodeBegin
public void encodeBegin(javax.faces.context.FacesContext context)
throws IOException
- Overrides:
encodeBegin
in class javax.faces.component.UIComponentBase
- Throws:
IOException
processDecodes
public void processDecodes(javax.faces.context.FacesContext context)
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 context)
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 context)
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 context)
- Overrides:
decode
in class javax.faces.component.UIComponentBase
- Throws:
NullPointerException
updateModel
public void updateModel(javax.faces.context.FacesContext context)
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)
getItemByIndex
public AbstractTogglePanelItemInterface getItemByIndex(int index)
getRenderedItems
public List<AbstractTogglePanelItemInterface> getRenderedItems()
getItems
public List<AbstractTogglePanelItemInterface> getItems(boolean isRendered)
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
public int getChildIndex(String name)
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()
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()
setSwitchType
public void setSwitchType(org.richfaces.component.SwitchType switchType)
isLimitRender
public abstract boolean isLimitRender()
isCycledSwitching
public abstract boolean isCycledSwitching()
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()
getOnitemchange
public abstract String getOnitemchange()
getOnbeforeitemchange
public abstract String getOnbeforeitemchange()
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 context,
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
Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.