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 ofActionEvent
s, including the ability to invoke application actions via the defaultActionListener
mechanism.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addActionListener(ActionListener listener)
Add a newActionListener
to the set of listeners interested in being notified whenActionEvent
s occur.ActionListener[]
getActionListeners()
Return the set of registeredActionListener
s for thisActionSource
instance.boolean
isImmediate()
Return a flag indicating that the defaultActionListener
provided by the Jakarta 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
setImmediate(boolean immediate)
Set the "immediate execution" flag for thisUIComponent
.
-
-
-
Method Detail
-
isImmediate
boolean isImmediate()
Return a flag indicating that the default
ActionListener
provided by the Jakarta 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
void addActionListener(ActionListener listener)
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
void removeActionListener(ActionListener listener)
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
-
-