java.awt.event

Class ItemEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

java.awt.event.ItemEvent

All Implemented Interfaces:

Serializable

public class ItemEvent
extends AWTEvent

This event is generated when a selection item changes state. This is an abstraction that distills a large number of individual mouse or keyboard events into a simpler "item selected" and "item deselected" events.

Since:

1.1

See Also:

ItemSelectable, ItemListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESELECTED This type indicates that the item was deselected.
static int	ITEM_FIRST This is the first id in the event id range used by this class.
static int	ITEM_LAST This is the last id in the event id range used by this class.
static int	ITEM_STATE_CHANGED This event id indicates a state change occurred.
static int	SELECTED This type indicates that the item was selected.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, 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 and Description
ItemEvent(ItemSelectable source, int id, Object item, int stateChange) Initializes a new instance of ItemEvent with the specified source, id, and state change constant.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getItem() Returns the item affected by this state change.
ItemSelectable	getItemSelectable() This method returns the event source as an ItemSelectable.
int	getStateChange() Returns the type of state change, either SELECTED or DESELECTED.
String	paramString() Returns a string identifying this event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, 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

Field Detail

ITEM_FIRST

public static final int ITEM_FIRST

This is the first id in the event id range used by this class.

See Also:

Constant Field Values

ITEM_LAST

public static final int ITEM_LAST

This is the last id in the event id range used by this class.

See Also:

Constant Field Values

ITEM_STATE_CHANGED

public static final int ITEM_STATE_CHANGED

This event id indicates a state change occurred.

See Also:

Constant Field Values

SELECTED

public static final int SELECTED

This type indicates that the item was selected.

See Also:

Constant Field Values

DESELECTED

public static final int DESELECTED

This type indicates that the item was deselected.

See Also:

Constant Field Values

Constructor Detail

ItemEvent

public ItemEvent(ItemSelectable source,
         int id,
         Object item,
         int stateChange)

Initializes a new instance of ItemEvent with the specified source, id, and state change constant. Note that an invalid id leads to unspecified results.

Parameters:

source - the source of the event

id - the event id

item - the item affected by the state change

stateChange - one of SELECTED or DESELECTED

Method Detail

getItemSelectable

public ItemSelectable getItemSelectable()

This method returns the event source as an ItemSelectable.

Returns:

the event source as an ItemSelected

Throws:

ClassCastException - if source is changed to a non-ItemSelectable

getItem

public Object getItem()

Returns the item affected by this state change.

Returns:

the item affected by this state change

getStateChange

public int getStateChange()

Returns the type of state change, either SELECTED or DESELECTED.

Returns:

the type of state change

paramString

public String paramString()

Returns a string identifying this event. This is in the format: "ITEM_STATE_CHANGED,item=" + item + ",stateChange=" + (getStateChange() == DESELECTED ? "DESELECTED" : "SELECTED").

Overrides:

paramString in class AWTEvent

Returns:

a string identifying this event