ItemEvent JDK 1.6)

Description

public class ItemEvent

A semantic event which indicates that an item was selected or deselected.

A semantic event which indicates that an item was selected or deselected. This high-level event is generated by an ItemSelectable object (such as a List) when an item is selected or deselected by the user. The event is passed to every ItemListener object which registered to receive such events using the component's addItemListener method.

The object that implements the ItemListener interface gets this ItemEvent when the event occurs. The listener is spared the details of processing individual mouse movements and mouse clicks, and can instead process a "meaningful" (semantic) event like "item selected" or "item deselected".

See also: ItemSelectable ItemListener Tutorial: Writing an Item Listener

Constructors

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

Constructs an ItemEvent object.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
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
Throws:
- IllegalArgumentException - if source is null

Methods

Hide/Show inherited methods

protected void consume () [Inherited From AWTEvent]

Consumes this event, if this event can be consumed.

public int getID () [Inherited From AWTEvent]

Returns the event type.

public Object getItem ()

Returns the item affected by the event.

public ItemSelectable getItemSelectable ()

Returns the originator of the event.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public int getStateChange ()

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

protected boolean isConsumed () [Inherited From AWTEvent]

Returns whether this event has been consumed.

public String paramString () [Overrides AWTEvent]

Returns a parameter string identifying this item event.

public void setSource (Object newSource) [Inherited From AWTEvent]

Retargets an event to a new source.

public String toString () [Inherited From AWTEvent]

Returns a String representation of this object.

Fields

Hide/Show inherited fields

publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]

The event mask for selecting action events.

publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]

The event mask for selecting adjustment events.

publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]

The event mask for selecting component events.

protected boolean consumed [Inherited From AWTEvent]

Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.

publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]

The event mask for selecting container events.

publicfinalstatic int DESELECTED = "2"

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

publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]

The event mask for selecting focus events.

publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]

The event mask for selecting hierarchy bounds events.

publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]

The event mask for selecting hierarchy events.

protected int id [Inherited From AWTEvent]

The event's id.

publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]

The event mask for selecting input method events.

publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]

The event mask for selecting invocation events.

pack-private Object item

The item whose selection state has changed.

publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]

The event mask for selecting item events.

publicfinalstatic int ITEM_FIRST = "701"

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

publicfinalstatic int ITEM_LAST = "701"

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

publicfinalstatic int ITEM_STATE_CHANGED = "701"

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

publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]

The event mask for selecting key events.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]

The event mask for selecting mouse motion events.

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]

The event mask for selecting paint events.

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

publicfinalstatic int SELECTED = "1"

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

protectedtransient Object source [Inherited From EventObject]

The object on which the Event initially occurred.

pack-private int stateChange

stateChange indicates whether the item was selected or deselected.

stateChange indicates whether the item
was selected or deselected.
Serial:
See Also: ItemEvent.getStateChange(),

publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]

The event mask for selecting text events.

publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]

The event mask for selecting window events.

publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]

The event mask for selecting window focus events.

publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]

The event mask for selecting window state events.