|
RichFaces UI Components UI 4.2.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
org.richfaces.component.AbstractTogglePanel
public abstract class AbstractTogglePanel
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.
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 context)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
|
String |
getActiveItem()
Holds the active panel name. |
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()
Occurs on the server side when an item is changed through Ajax using the server mode |
org.richfaces.event.ItemChangeListener[] |
getItemChangeListeners()
|
List<AbstractTogglePanelItemInterface> |
getItems(boolean isRendered)
|
AbstractTogglePanelItemInterface |
getLastItem()
|
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()
|
List<AbstractTogglePanelItemInterface> |
getRenderedItems()
|
boolean |
getRendersChildren()
|
abstract String |
getStatus()
|
String |
getSubmittedActiveItem()
|
Object |
getSubmittedValue()
|
org.richfaces.component.SwitchType |
getSwitchType()
The switch mode when a panel is activated. |
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()
|
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, 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 |
---|
public static final String ACTIVE_ITEM_META_COMPONENT
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String META_NAME_FIRST
public static final String META_NAME_PREV
public static final String META_NAME_NEXT
public static final String META_NAME_LAST
public static final String UPDATE_MESSAGE_ID
Constructor Detail |
---|
protected AbstractTogglePanel()
Method Detail |
---|
public Object getSubmittedValue()
public void resetValue()
public void setSubmittedValue(Object submittedValue)
public boolean isLocalValueSet()
public void setLocalValueSet(boolean localValueSet)
public boolean isValid()
public void setValid(boolean valid)
public boolean isRequired()
public void setRequired(boolean required)
Set the "required field" state for this component.
required
- The new "required field" statepublic boolean isImmediate()
public void setImmediate(boolean immediate)
public void encodeBegin(javax.faces.context.FacesContext context) throws IOException
encodeBegin
in class javax.faces.component.UIComponentBase
IOException
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()
.
processDecodes
in class javax.faces.component.UIComponentBase
NullPointerException
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.
processValidators
in class javax.faces.component.UIComponentBase
NullPointerException
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.
processUpdates
in class javax.faces.component.UIComponentBase
NullPointerException
public void decode(javax.faces.context.FacesContext context)
decode
in class javax.faces.component.UIComponentBase
NullPointerException
public void updateModel(javax.faces.context.FacesContext context)
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
protected void setEventPhase(org.richfaces.event.ItemChangeEvent event)
protected void setEventPhase(javax.faces.event.FacesEvent event)
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 String getFamily()
getFamily
in class javax.faces.component.UIOutput
public boolean getRendersChildren()
getRendersChildren
in class javax.faces.component.UIComponentBase
protected boolean isActiveItem(javax.faces.component.UIComponent kid)
protected boolean isActiveItem(javax.faces.component.UIComponent kid, String value)
public AbstractTogglePanelItemInterface getItemByIndex(int index)
public List<AbstractTogglePanelItemInterface> getRenderedItems()
public List<AbstractTogglePanelItemInterface> getItems(boolean isRendered)
public AbstractTogglePanelItemInterface getItem(String name)
public AbstractTogglePanelItemInterface getFirstItem()
public AbstractTogglePanelItemInterface getPrevItem()
public AbstractTogglePanelItemInterface getPrevItem(String name)
public AbstractTogglePanelItemInterface getNextItem()
public AbstractTogglePanelItemInterface getNextItem(String name)
public AbstractTogglePanelItemInterface getLastItem()
public int getChildIndex(String name)
public String getSubmittedActiveItem()
public void setSubmittedActiveItem(String submittedActiveItem)
public void setValue(Object value)
setValue
in interface javax.faces.component.ValueHolder
setValue
in class javax.faces.component.UIOutput
public String getActiveItem()
public void setActiveItem(String value)
public void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression
in class javax.faces.component.UIComponent
public org.richfaces.component.SwitchType getSwitchType()
public void setSwitchType(org.richfaces.component.SwitchType switchType)
public abstract boolean isLimitRender()
public abstract boolean isCycledSwitching()
public abstract Object getData()
public abstract String getStatus()
public abstract Object getExecute()
public abstract Object getRender()
public abstract javax.el.MethodExpression getItemChangeListener()
public abstract String getOnitemchange()
public abstract String getOnbeforeitemchange()
public void addItemChangeListener(org.richfaces.event.ItemChangeListener listener)
addItemChangeListener
in interface org.richfaces.event.ItemChangeSource
public org.richfaces.event.ItemChangeListener[] getItemChangeListeners()
getItemChangeListeners
in interface org.richfaces.event.ItemChangeSource
public void removeItemChangeListener(org.richfaces.event.ItemChangeListener listener)
removeItemChangeListener
in interface org.richfaces.event.ItemChangeSource
public String resolveClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
resolveClientId
in interface org.richfaces.component.MetaComponentResolver
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent contextComponent, String metaComponentId)
substituteUnresolvedClientId
in interface org.richfaces.component.MetaComponentResolver
public void encodeMetaComponent(javax.faces.context.FacesContext context, String metaComponentId) throws IOException
encodeMetaComponent
in interface org.richfaces.component.MetaComponentEncoder
IOException
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)
visitTree
in class javax.faces.component.UIComponent
|
RichFaces UI Components UI 4.2.1.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |