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

Safe:

See Also:

Serialized Form

Field Summary

static int	DESELECTED Enabled: This state-change-value indicates that a selected item was deselected.
(package private) Object	item The item whose selection state has changed.
static int	ITEM_FIRST Enabled: The first number in the range of ids used for item events.
static int	ITEM_LAST Enabled: The last number in the range of ids used for item events.
static int	ITEM_STATE_CHANGED Enabled: This event id indicates that an item's state changed.
static int	SELECTED Enabled: This state-change value indicates that an item was selected.
private static long	serialVersionUID
(package private) int	stateChange stateChange indicates whether the item was selected or deselected.

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

ItemEvent(ItemSelectable source, int id, Object item, int stateChange)
Suppressed: Constructs an ItemEvent object.

Method Summary

Object	getItem() Enabled: Returns the item affected by the event.
ItemSelectable	getItemSelectable() Enabled: Returns the originator of the event.
int	getStateChange() Enabled: Returns the type of state change (selected or deselected).
String	paramString() Suppressed: Returns a parameter string identifying this item 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

Enabled: The first number in the range of ids used for item events.

ITEM_LAST

public static final int ITEM_LAST

Enabled: The last number in the range of ids used for item events.

ITEM_STATE_CHANGED

public static final int ITEM_STATE_CHANGED

Enabled: This event id indicates that an item's state changed.

SELECTED

public static final int SELECTED

Enabled: This state-change value indicates that an item was selected.

DESELECTED

public static final int DESELECTED

Enabled: This state-change-value indicates that a selected item was deselected.

item

Object item

The item whose selection state has changed.

See Also:

getItem()

stateChange

int stateChange

stateChange indicates whether the item was selected or deselected.

See Also:

getStateChange()

serialVersionUID

private static final long serialVersionUID

Constructor Detail

ItemEvent

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

Suppressed: Constructs an ItemEvent object.

Note that passing in an invalid id results in unspecified behavior.

Parameters:

source - the ItemSelectable object that originated the event

id - an integer that identifies the event type

item - an object -- the item affected by the event

stateChange - an integer that indicates whether the item was selected or deselected

Method Detail

getItemSelectable

public ItemSelectable getItemSelectable()

Enabled: Returns the originator of the event.

Returns:

the ItemSelectable object that originated the event.

getItem

public Object getItem()

Enabled: Returns the item affected by the event.

Returns:

the item (object) that was affected by the event

getStateChange

public int getStateChange()

Enabled: Returns the type of state change (selected or deselected).

Returns:

an integer that indicates whether the item was selected or deselected

See Also:

SELECTED, DESELECTED

paramString

public String paramString()

Suppressed: Returns a parameter string identifying this item event. This method is useful for event-logging and for debugging.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying the event and its attributes