Package jakarta.faces.event

Interface ActionListener

All Superinterfaces:

EventListener, FacesListener

All Known Implementing Classes:

ActionListenerImpl, ActionListenerWrapper, MethodExpressionActionListener, SetPropertyActionListenerImpl

public interface ActionListener
extends FacesListener

A listener interface for receiving ActionEvents. An implementation of this interface must be thread-safe. A class that is interested in receiving such events implements this interface, and then registers itself with the source UIComponent of interest, by calling addActionListener().

Field Summary

Fields

Modifier and Type	Field	Description
static String	TO_FLOW_DOCUMENT_ID_ATTR_NAME	The presence of this component attribute on an ActionSource component will cause the default ActionListener to interpret the value of the attribute as the toFlowDocumentId value to pass to NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String).

Method Summary

Modifier and Type	Method	Description
void	processAction(ActionEvent event)	Invoked when the action described by the specified ActionEvent occurs.

Field Details

TO_FLOW_DOCUMENT_ID_ATTR_NAME

static final String TO_FLOW_DOCUMENT_ID_ATTR_NAME

The presence of this component attribute on an ActionSource component will cause the default ActionListener to interpret the value of the attribute as the toFlowDocumentId value to pass to NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String).

See Also:

Constant Field Values

Method Details

processAction

void processAction(ActionEvent event) throws AbortProcessingException

Invoked when the action described by the specified ActionEvent occurs.

Parameters:

event - The ActionEvent that has occurred

Throws:

AbortProcessingException - Signal the Jakarta Server Faces implementation that no further processing on the current event should be performed