@JSFComponent(defaultRendererType="javax.faces.Button") public class UICommand extends UIComponentBase implements ActionSource2
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY| Constructor and Description |
|---|
UICommand()
Construct an instance of the UICommand.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addActionListener(ActionListener listener) |
void |
broadcast(FacesEvent event)
Invoke any listeners attached to this object which are listening for an event whose type matches the specified
event's runtime type.
|
javax.el.MethodExpression |
getActionExpression()
The action to take when this command is invoked.
|
ActionListener[] |
getActionListeners()
Event delivered when the "action" of the component has been
invoked; for example, by clicking on a button.
|
String |
getFamily() |
Object |
getValue()
The text to display to the user for this command component.
|
boolean |
isImmediate()
A boolean value that identifies the phase during which action events
should fire.
|
void |
queueEvent(FacesEvent event) |
void |
removeActionListener(ActionListener listener) |
void |
setActionExpression(javax.el.MethodExpression actionExpression) |
void |
setImmediate(boolean immediate) |
void |
setValue(Object value) |
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreegetClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public void broadcast(FacesEvent event) throws AbortProcessingException
UIComponentBaseThis method does not propagate the event up to parent components, ie listeners attached to parent components don't automatically get called.
If any of the listeners throws AbortProcessingException then that exception will prevent any further listener callbacks from occurring, and the exception propagates out of this method without alteration.
ActionEvent events are typically queued by the renderer associated with this component in its decode method; ValueChangeEvent events by the component's validate method. In either case the event's source property references a component. At some later time the UIViewRoot component iterates over its queued events and invokes the broadcast method on each event's source object.
broadcast in class UIComponentBaseevent - must not be null.AbortProcessingExceptionpublic void queueEvent(FacesEvent event)
queueEvent in class UIComponentBase@JSFProperty public boolean isImmediate()
During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
isImmediate in interface ActionSourcepublic void setImmediate(boolean immediate)
setImmediate in interface ActionSource@JSFProperty public Object getValue()
public void setValue(Object value)
@JSFProperty(stateHolder=true,
returnSignature="java.lang.Object",
jspName="action",
clientEvent="action")
public javax.el.MethodExpression getActionExpression()
If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute.
If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.
getActionExpression in interface ActionSource2public void setActionExpression(javax.el.MethodExpression actionExpression)
setActionExpression in interface ActionSource2public void addActionListener(ActionListener listener)
addActionListener in interface ActionSourcepublic void removeActionListener(ActionListener listener)
removeActionListener in interface ActionSource@JSFListener(event="javax.faces.event.ActionEvent",
phases="Invoke Application, Apply Request Values")
public ActionListener[] getActionListeners()
getActionListeners in interface ActionSourcepublic String getFamily()
getFamily in class UIComponentCopyright © 2022 The Apache Software Foundation. All rights reserved.