Interface ActionSource
- All Known Subinterfaces:
ActionSource2
- All Known Implementing Classes:
HtmlCommandButton
,HtmlCommandLink
,HtmlCommandScript
,UICommand
,UIViewAction
public interface ActionSource
ActionSource is an interface that may be implemented by any concrete UIComponent
that wishes
to be a source of ActionEvent
s, including the ability to invoke application actions via the default
ActionListener
mechanism.
-
Method Summary
Modifier and Type Method Description void
addActionListener(ActionListener listener)
Add a newActionListener
to the set of listeners interested in being notified whenActionEvent
s occur.MethodBinding
getAction()
Deprecated.This has been replaced byActionSource2.getActionExpression()
.MethodBinding
getActionListener()
Deprecated.UsegetActionListeners()
instead.ActionListener[]
getActionListeners()
Return the set of registeredActionListener
s for thisActionSource
instance.boolean
isImmediate()
Return a flag indicating that the defaultActionListener
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 existingActionListener
(if any) from the set of listeners interested in being notified whenActionEvent
s occur.void
setAction(MethodBinding action)
Deprecated.This has been replaced byActionSource2.setActionExpression(jakarta.el.MethodExpression)
.void
setActionListener(MethodBinding actionListener)
Deprecated.This has been replaced byaddActionListener(jakarta.faces.event.ActionListener)
.void
setImmediate(boolean immediate)
Set the "immediate execution" flag for thisUIComponent
.
-
Method Details
-
isImmediate
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 befalse
.- Returns:
true
if immediate,false
otherwise.
-
setImmediate
void setImmediate(boolean immediate)Set the "immediate execution" flag for this
UIComponent
.- Parameters:
immediate
- The new immediate execution flag
-
addActionListener
Add a new
ActionListener
to the set of listeners interested in being notified whenActionEvent
s occur.- Parameters:
listener
- TheActionListener
to be added- Throws:
NullPointerException
- iflistener
isnull
-
getActionListeners
ActionListener[] getActionListeners()Return the set of registered
ActionListener
s for thisActionSource
instance. If there are no registered listeners, a zero-length array is returned.- Returns:
- the action listeners, or a zero-length array.
-
removeActionListener
Remove an existing
ActionListener
(if any) from the set of listeners interested in being notified whenActionEvent
s occur.- Parameters:
listener
- TheActionListener
to be removed- Throws:
NullPointerException
- iflistener
isnull
-
getAction
Deprecated.This has been replaced byActionSource2.getActionExpression()
.If the implementing class also implements
ActionSource2
, the implementation of this method must call through toActionSource2.getActionExpression()
and examine the result. If the result came from a previous call tosetAction(jakarta.faces.el.MethodBinding)
, extract theMethodBinding
from it and return it. Otherwise, wrap the returnedMethodExpression
in aMethodBinding
implementation, and return it.If the implementing class does not implement
ActionSource2
, return theMethodBinding
pointing at the application action to be invoked, if thisUIComponent
is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of theimmediate
property.- Returns:
- the action.
-
setAction
Deprecated.This has been replaced byActionSource2.setActionExpression(jakarta.el.MethodExpression)
.If the implementing class also implements
ActionSource2
, the implementation of this method must wrap the argumentaction
in a class that implementsMethodExpression
and call through toActionSource2.setActionExpression(jakarta.el.MethodExpression)
, passing the wrappedaction
.If the implementing class does not implement
ActionSource2
, set theMethodBinding
pointing at the appication action to be invoked, if thisUIComponent
is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of theimmediate
property.Any method referenced by such an expression must be public, with a return type of
String
, and accept no parameters.- Parameters:
action
- The new MethodBinding expression
-
getActionListener
Deprecated.UsegetActionListeners()
instead.If
setActionListener(jakarta.faces.el.MethodBinding)
was not previously called for this instance, this method must returnnull
. If it was called, this method must return the exactMethodBinding
instance that was passed tosetActionListener(jakarta.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 theimmediate
property.- Returns:
- the action listener.
-
setActionListener
Deprecated.This has been replaced byaddActionListener(jakarta.faces.event.ActionListener)
.Wrap the argument
actionListener
in an implementation ofActionListener
and store it in the internal data structure that backs thegetActionListeners()
method, taking care to over-write any instance that was stored by a previous call tosetActionListener
.Any method referenced by such an expression must be public, with a return type of
void
, and accept a single parameter of typeActionEvent
.- Parameters:
actionListener
- The new method binding expression
-