com.sun.dtv.lwuit.events
Class ActionEvent

java.lang.Object
  com.sun.dtv.lwuit.events.ActionEvent

public class ActionEvent
extends Object

Event object delivered when an ActionListener callback is invoked.

Constructor Summary

ActionEvent(Object source)
Creates a new instance of ActionEvent.

ActionEvent(Object source, int keyEvent)
Creates a new instance of ActionEvent.

Method Summary

void	consume() Consume the event indicating that it was handled thus preventing other action listeners from handling/receiving the event.
Command	getCommand() If this event was sent as a result of a command action this method returns that command.
int	getKeyEvent() If this event was triggered by a key press this method will return the appropriate keycode.
Object	getSource() The element that triggered the action event, useful for decoupling event handling code.
boolean	isConsumed() Returns true if the event was consumed thus indicating that it was handled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionEvent

public ActionEvent(Object source)

Creates a new instance of ActionEvent.

Parameters:

source - element for the action event

ActionEvent

public ActionEvent(Object source,
                   int keyEvent)

Creates a new instance of ActionEvent.

Parameters:

source - element for the action event

keyEvent - the key that triggered the event

Method Detail

getSource

public Object getSource()

The element that triggered the action event, useful for decoupling event handling code.

Returns:

the element that triggered the action event

getKeyEvent

public int getKeyEvent()

If this event was triggered by a key press this method will return the appropriate keycode.

Returns:

the key that triggered the event

getCommand

public Command getCommand()

If this event was sent as a result of a command action this method returns that command.

Returns:

the command action that triggered the action event

consume

public void consume()

Consume the event indicating that it was handled thus preventing other action listeners from handling/receiving the event.

isConsumed

public boolean isConsumed()

Returns true if the event was consumed thus indicating that it was handled. This prevents other action listeners from handling/receiving the event.

Returns:

true if event is consumed, false otherwise