public interface ActionSource
ActionSource is an interface that may be implemented by any concrete
UIComponent that wishes to be a source of ActionEvents, including the ability to
invoke application actions via the default ActionListener mechanism.
| Modifier and Type | Method and Description |
|---|---|
void |
addActionListener(ActionListener listener)
Add a new
ActionListener to the set of listeners interested in being notified when
ActionEvents occur. |
MethodBinding |
getAction()
Deprecated.
This has been replaced by
ActionSource2.getActionExpression(). |
MethodBinding |
getActionListener()
Deprecated.
Use
getActionListeners() instead. |
ActionListener[] |
getActionListeners()
Return the set of registered
ActionListeners for this ActionSource instance. |
boolean |
isImmediate()
Return a flag indicating that the default
ActionListener provided by the Jakarta Server
Faces implementation should be executed immediately (that is, during Apply Request
Values phase of the request processing lifecycle), rather than waiting until the
Invoke Application phase. |
void |
removeActionListener(ActionListener listener)
Remove an existing
ActionListener (if any) from the set of listeners interested in
being notified when ActionEvents occur. |
void |
setAction(MethodBinding action)
Deprecated.
This has been replaced by
ActionSource2.setActionExpression(javax.el.MethodExpression). |
void |
setActionListener(MethodBinding actionListener)
Deprecated.
This has been replaced by
addActionListener(javax.faces.event.ActionListener). |
void |
setImmediate(boolean immediate)
Set the "immediate execution" flag for this
UIComponent. |
boolean isImmediate()
Return a flag indicating that the default ActionListener provided by the Jakarta Server
Faces implementation should be executed immediately (that is, during Apply Request
Values phase of the request processing lifecycle), rather than waiting until the
Invoke Application phase. The default value for this property must be
false.
true if immediate, false otherwise.void setImmediate(boolean immediate)
Set the "immediate execution" flag for this UIComponent.
immediate - The new immediate execution flagvoid addActionListener(ActionListener listener)
Add a new ActionListener to the set of listeners interested in being notified when
ActionEvents occur.
listener - The ActionListener to be addedNullPointerException - if listener is nullActionListener[] getActionListeners()
Return the set of registered ActionListeners for this ActionSource instance.
If there are no registered listeners, a zero-length array is returned.
void removeActionListener(ActionListener listener)
Remove an existing ActionListener (if any) from the set of listeners interested in
being notified when ActionEvents occur.
listener - The ActionListener to be removedNullPointerException - if listener is nullMethodBinding getAction()
ActionSource2.getActionExpression().
If the implementing class also implements ActionSource2, the implementation of this
method must call through to ActionSource2.getActionExpression() and examine the result.
If the result came from a previous call to setAction(javax.faces.el.MethodBinding), extract the
MethodBinding from it and return it. Otherwise, wrap the returned
MethodExpression in a MethodBinding implementation, and return
it.
If the implementing class does not implement ActionSource2, return the
MethodBindingpointing at the application action to be invoked, if this
UIComponent is activated by the user, during the Apply Request Values or
Invoke Application phase of the request processing lifecycle, depending on the value
of the immediate property.
void setAction(MethodBinding action)
ActionSource2.setActionExpression(javax.el.MethodExpression).
If the implementing class also implements ActionSource2, the implementation of this
method must wrap the argument action in a class that implements
MethodExpression and call through to
ActionSource2.setActionExpression(javax.el.MethodExpression), passing the wrapped action.
If the implementing class does not implement ActionSource2, set the
MethodBinding pointing at the appication action to be invoked, if this
UIComponent is activated by the user, during the Apply Request Values or
Invoke Application phase of the request processing lifecycle, depending on the value
of the immediate property.
Any method referenced by such an expression must be public, with a return type of
String, and accept no parameters.
action - The new MethodBinding expressionMethodBinding getActionListener()
getActionListeners() instead.
If setActionListener(javax.faces.el.MethodBinding) was not previously called for this instance, this method must
return null. If it was called, this method must return the exact
MethodBinding instance that was passed to setActionListener(javax.faces.el.MethodBinding).
The method to be invoked, if this UIComponent is activated by the user, will be
called during the Apply Request Values or Invoke Application phase of the
request processing lifecycle, depending upon the value of the immediate
property.
void setActionListener(MethodBinding actionListener)
addActionListener(javax.faces.event.ActionListener).
Wrap the argument actionListener in an implementation of ActionListener
and store it in the internal data structure that backs the getActionListeners()
method, taking care to over-write any instance that was stored by a previous call to
setActionListener.
Any method referenced by such an expression must be public, with a return type of
void, and accept a single parameter of type ActionEvent.
actionListener - The new method binding expressionCopyright © 2019 Eclipse Foundation.
Use is subject to license terms.