ItemEvent (Sample Document)

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
  - - java.awt.event.ItemEvent

All Implemented Interfaces:

java.io.Serializable

public class ItemEvent extends AWTEvent
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".
An unspecified behavior will be caused if the id parameter of any particular ItemEvent instance is not in the range from ITEM_FIRST to ITEM_LAST.
The stateChange of any ItemEvent instance takes one of the following values:
- ItemEvent.SELECTED
- ItemEvent.DESELECTED
Assigning the value different from listed above will cause an unspecified behavior.
Since:

1.1

See Also:
ItemSelectable, ItemListener, Tutorial: Writing an Item Listener, Serialized Form

Fields
	Modifier and Type	Field and Description
	ACTION_EVENT_MASK	`static long` ACTION_EVENT_MASK The event mask for selecting action events. public static final long ACTION_EVENT_MASK The event mask for selecting action events. See Also: Constant Field Values
	ADJUSTMENT_EVENT_MASK	`static long` ADJUSTMENT_EVENT_MASK The event mask for selecting adjustment events. public static final long ADJUSTMENT_EVENT_MASK The event mask for selecting adjustment events. See Also: Constant Field Values
	COMPONENT_EVENT_MASK	`static long` COMPONENT_EVENT_MASK The event mask for selecting component events. public static final long COMPONENT_EVENT_MASK The event mask for selecting component events. See Also: Constant Field Values
	consumed	`protected boolean` consumed 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. protected boolean consumed 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. Semantic events always have a 'true' value since they were generated by the peer in response to a low-level event. See Also: `AWTEvent.consume()`, `AWTEvent.isConsumed()`
	CONTAINER_EVENT_MASK	`static long` CONTAINER_EVENT_MASK The event mask for selecting container events. public static final long CONTAINER_EVENT_MASK The event mask for selecting container events. See Also: Constant Field Values
	DESELECTED	`static int` DESELECTED This state-change-value indicates that a selected item was deselected. public static final int DESELECTED This state-change-value indicates that a selected item was deselected. See Also: Constant Field Values
	FOCUS_EVENT_MASK	`static long` FOCUS_EVENT_MASK The event mask for selecting focus events. public static final long FOCUS_EVENT_MASK The event mask for selecting focus events. See Also: Constant Field Values
	HIERARCHY_BOUNDS_EVENT_MASK	`static long` HIERARCHY_BOUNDS_EVENT_MASK The event mask for selecting hierarchy bounds events. public static final long HIERARCHY_BOUNDS_EVENT_MASK The event mask for selecting hierarchy bounds events. See Also: Constant Field Values
	HIERARCHY_EVENT_MASK	`static long` HIERARCHY_EVENT_MASK The event mask for selecting hierarchy events. public static final long HIERARCHY_EVENT_MASK The event mask for selecting hierarchy events. See Also: Constant Field Values
	id	`protected int` id The event's id. protected int id The event's id. See Also: `AWTEvent.getID()`, `AWTEvent.AWTEvent(java.lang.Object, int)`
	INPUT_METHOD_EVENT_MASK	`static long` INPUT_METHOD_EVENT_MASK The event mask for selecting input method events. public static final long INPUT_METHOD_EVENT_MASK The event mask for selecting input method events. See Also: Constant Field Values
	INVOCATION_EVENT_MASK	`static long` INVOCATION_EVENT_MASK The event mask for selecting invocation events. public static final long INVOCATION_EVENT_MASK The event mask for selecting invocation events. See Also: Constant Field Values
	ITEM_EVENT_MASK	`static long` ITEM_EVENT_MASK The event mask for selecting item events. public static final long ITEM_EVENT_MASK The event mask for selecting item events. See Also: Constant Field Values
	ITEM_FIRST	`static int` ITEM_FIRST The first number in the range of ids used for item events. public static final int ITEM_FIRST The first number in the range of ids used for item events. See Also: Constant Field Values
	ITEM_LAST	`static int` ITEM_LAST The last number in the range of ids used for item events. public static final int ITEM_LAST The last number in the range of ids used for item events. See Also: Constant Field Values
	ITEM_STATE_CHANGED	`static int` ITEM_STATE_CHANGED This event id indicates that an item's state changed. public static final int ITEM_STATE_CHANGED This event id indicates that an item's state changed. See Also: Constant Field Values
	KEY_EVENT_MASK	`static long` KEY_EVENT_MASK The event mask for selecting key events. public static final long KEY_EVENT_MASK The event mask for selecting key events. See Also: Constant Field Values
	MOUSE_EVENT_MASK	`static long` MOUSE_EVENT_MASK The event mask for selecting mouse events. public static final long MOUSE_EVENT_MASK The event mask for selecting mouse events. See Also: Constant Field Values
	MOUSE_MOTION_EVENT_MASK	`static long` MOUSE_MOTION_EVENT_MASK The event mask for selecting mouse motion events. public static final long MOUSE_MOTION_EVENT_MASK The event mask for selecting mouse motion events. See Also: Constant Field Values
	MOUSE_WHEEL_EVENT_MASK	`static long` MOUSE_WHEEL_EVENT_MASK The event mask for selecting mouse wheel events. public static final long MOUSE_WHEEL_EVENT_MASK The event mask for selecting mouse wheel events. Since: 1.4 See Also: Constant Field Values
	PAINT_EVENT_MASK	`static long` PAINT_EVENT_MASK The event mask for selecting paint events. public static final long PAINT_EVENT_MASK The event mask for selecting paint events. See Also: Constant Field Values
	RESERVED_ID_MAX	`static int` RESERVED_ID_MAX The maximum value for reserved AWT event IDs. public static final int RESERVED_ID_MAX The maximum value for reserved AWT event IDs. Programs defining their own event IDs should use IDs greater than this value. See Also: Constant Field Values
	SELECTED	`static int` SELECTED This state-change value indicates that an item was selected. public static final int SELECTED This state-change value indicates that an item was selected. See Also: Constant Field Values
	source	`protected java.lang.Object` source The object on which the Event initially occurred. protected transient java.lang.Object source The object on which the Event initially occurred.
	TEXT_EVENT_MASK	`static long` TEXT_EVENT_MASK The event mask for selecting text events. public static final long TEXT_EVENT_MASK The event mask for selecting text events. See Also: Constant Field Values
	WINDOW_EVENT_MASK	`static long` WINDOW_EVENT_MASK The event mask for selecting window events. public static final long WINDOW_EVENT_MASK The event mask for selecting window events. See Also: Constant Field Values
	WINDOW_FOCUS_EVENT_MASK	`static long` WINDOW_FOCUS_EVENT_MASK The event mask for selecting window focus events. public static final long WINDOW_FOCUS_EVENT_MASK The event mask for selecting window focus events. Since: 1.4 See Also: Constant Field Values
	WINDOW_STATE_EVENT_MASK	`static long` WINDOW_STATE_EVENT_MASK The event mask for selecting window state events. public static final long WINDOW_STATE_EVENT_MASK The event mask for selecting window state events. Since: 1.4 See Also: Constant Field Values

Constructors
	Constructor and Description
	ItemEvent	ItemEvent(ItemSelectable source, int id, java.lang.Object item, int stateChange) Constructs an `ItemEvent` object. public ItemEvent(ItemSelectable source, int id, java.lang.Object item, int stateChange) Constructs an `ItemEvent` object. This method throws an `IllegalArgumentException` if `source` is `null`. Parameters: `source` - The `ItemSelectable` object that originated the event `id` - The integer that identifies the event type. For information on allowable values, see the class description for `ItemEvent` `item` - An object -- the item affected by the event `stateChange` - An integer that indicates whether the item was selected or deselected. For information on allowable values, see the class description for `ItemEvent` Throws: `java.lang.IllegalArgumentException` - if `source` is null See Also: `getItemSelectable()`, `AWTEvent.getID()`, `getStateChange()`

Methods
	Modifier and Type	Method and Description
	consume	`protected void` consume() Consumes this event, if this event can be consumed. protected void consume() Description copied from class: `AWTEvent` Consumes this event, if this event can be consumed. Only low-level, system events can be consumed
	getID	`int` getID() Returns the event type. public int getID() Description copied from class: `AWTEvent` Returns the event type.
	getItem	`java.lang.Object` getItem() Returns the item affected by the event. public java.lang.Object getItem() Returns the item affected by the event. Returns: the item (object) that was affected by the event
	getItemSelectable	`ItemSelectable` getItemSelectable() Returns the originator of the event. public ItemSelectable getItemSelectable() Returns the originator of the event. Returns: the ItemSelectable object that originated the event.
	getSource	`java.lang.Object` getSource() The object on which the Event initially occurred. public java.lang.Object getSource() Description copied from class: `java.util.EventObject` The object on which the Event initially occurred. Returns: The object on which the Event initially occurred.
	getStateChange	`int` getStateChange() Returns the type of state change (selected or deselected). public int getStateChange() 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`
	isConsumed	`protected boolean` isConsumed() Returns whether this event has been consumed. protected boolean isConsumed() Description copied from class: `AWTEvent` Returns whether this event has been consumed.
	paramString	`java.lang.String` paramString() Returns a parameter string identifying this item event. public java.lang.String paramString() 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
	setSource	`void` setSource(java.lang.Object newSource) Retargets an event to a new source. public void setSource(java.lang.Object newSource) Description copied from class: `AWTEvent` Retargets an event to a new source. This method is typically used to retarget an event to a lightweight child Component of the original heavyweight source. This method is intended to be used only by event targeting subsystems, such as client-defined KeyboardFocusManagers. It is not for general client use. Parameters: `newSource` - the new Object to which the event should be dispatched Since: 1.4
	toString	`java.lang.String` toString() Returns a String representation of this object. public java.lang.String toString() Description copied from class: `AWTEvent` Returns a String representation of this object. Overrides: `toString` in class `java.util.EventObject` Returns: A a String representation of this EventObject.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

SourceForge

Class ItemEvent

Methods inherited from class java.lang.Object