ActionEvent (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.faces.event
Class ActionEvent

java.lang.Object
  java.util.EventObject
      javax.faces.event.FacesEvent
          javax.faces.event.ActionEvent

All Implemented Interfaces:: Serializable

public class ActionEvent
extends FacesEvent
extends FacesEvent

An ActionEvent represents the activation of a user interface component (such as a UICommand).

See Also:: Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

ActionEvent(UIComponent component)
          Construct a new event object from the specified source component and action command.

Method Summary

boolean isAppropriateListener(FacesListener listener)
          Return true if this FacesListener is an instance of a listener class that this event supports.

void processListener(FacesListener listener)
          Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is appropriate.

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Fields inherited from class java.util.EventObject
`source`

Constructor Summary
`ActionEvent(UIComponent component)` Construct a new event object from the specified source component and action command.

Method Summary
`boolean`	`isAppropriateListener(FacesListener listener)` Return `true` if this `FacesListener` is an instance of a listener class that this event supports.
`void`	`processListener(FacesListener listener)` Broadcast this `FacesEvent` to the specified `FacesListener`, by whatever mechanism is appropriate.

Methods inherited from class javax.faces.event.FacesEvent
`getComponent, getPhaseId, queue, setPhaseId`

Methods inherited from class java.util.EventObject
`getSource, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

ActionEvent

public ActionEvent(UIComponent component)

Construct a new event object from the specified source component and action command.

Parameters:: component - Source UIComponent for this event
Throws:: IllegalArgumentException - if component is null

Method Detail

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

Description copied from class: FacesEvent

Return true if this FacesListener is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class.

Specified by:: isAppropriateListener in class FacesEvent

Parameters:: listener - FacesListener to evaluate

processListener

public void processListener(FacesListener listener)