Package jakarta.faces.component

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 ActionEvents, 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 new ActionListener to the set of listeners interested in being notified when ActionEvents occur.
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	setImmediate(boolean immediate)	Set the "immediate execution" flag for this UIComponent.

Method Detail

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 be false.

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 when ActionEvents occur.

Parameters:

listener - The ActionListener to be added

Throws:

java.lang.NullPointerException - if listener is null

getActionListeners

ActionListener[] getActionListeners()

Return the set of registered ActionListeners for this ActionSource 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 when ActionEvents occur.

Parameters:

listener - The ActionListener to be removed

Throws:

java.lang.NullPointerException - if listener is null