Package org.pentaho.reporting.libraries.designtime.swing

Class ConsumableActionEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

java.awt.event.ActionEvent

org.pentaho.reporting.libraries.designtime.swing.ConsumableActionEvent

All Implemented Interfaces:

Serializable

public class ConsumableActionEvent
extends ActionEvent

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.event.ActionEvent

ACTION_FIRST, ACTION_LAST, ACTION_PERFORMED, ALT_MASK, CTRL_MASK, META_MASK, SHIFT_MASK

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ConsumableActionEvent(Object source, int id, String command)	Constructs an ActionEvent object.
ConsumableActionEvent(Object source, int id, String command, int modifiers)	Constructs an ActionEvent object with modifier keys.
ConsumableActionEvent(Object source, int id, String command, long when, int modifiers)	Constructs an ActionEvent object with the specified modifier keys and timestamp.

Method Summary

Modifier and Type	Method	Description
void	consume()	Consumes this event, if this event can be consumed.
boolean	isConsumed()	Returns whether this event has been consumed.

Methods inherited from class java.awt.event.ActionEvent

getActionCommand, getModifiers, getWhen, paramString

Methods inherited from class java.awt.AWTEvent

getID, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumableActionEvent

public ConsumableActionEvent(Object source,
                             int id,
                             String command)

Constructs an ActionEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:

source - the object that originated the event

id - an integer that identifies the event

command - a string that may specify a command (possibly one of several) associated with the event

Throws:

IllegalArgumentException - if source is null

ConsumableActionEvent

public ConsumableActionEvent(Object source,
                             int id,
                             String command,
                             int modifiers)

Constructs an ActionEvent object with modifier keys.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:

source - the object that originated the event

id - an integer that identifies the event

command - a string that may specify a command (possibly one of several) associated with the event

modifiers - the modifier keys held down during this action

Throws:

IllegalArgumentException - if source is null

ConsumableActionEvent

public ConsumableActionEvent(Object source,
                             int id,
                             String command,
                             long when,
                             int modifiers)

Constructs an ActionEvent object with the specified modifier keys and timestamp.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null. A null command string is legal, but not recommended.

Parameters:

source - the object that originated the event

id - an integer that identifies the event

command - a string that may specify a command (possibly one of several) associated with the event

when - the time the event occurred

modifiers - the modifier keys held down during this action

Throws:

IllegalArgumentException - if source is null

Since:

1.4

Method Detail

isConsumed

public boolean isConsumed()

Returns whether this event has been consumed.

Overrides:

isConsumed in class AWTEvent

consume

public void consume()

Consumes this event, if this event can be consumed. Only low-level, system events can be consumed

Overrides:

consume in class AWTEvent