All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.event.ItemEvent 

java.lang.Object
    |
    +----java.util.EventObject
            |
            +----java.awt.AWTEvent
                    |
                    +----java.awt.event.ItemEvent
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 de-selected. 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, Reference: The Java Class Libraries (update file)

Variable Index

o DESELECTED
This state-change-value indicates that a selected item was un-selected.
o ITEM_FIRST
The first number in the range of ids used for item events.
o ITEM_LAST
The last number in the range of ids used for item events.
o ITEM_STATE_CHANGED
This event id indicates that an item's state changed.
o SELECTED
This state-change value indicates that an item was selected.

Constructor Index

o ItemEvent(ItemSelectable, int, Object, int)
Constructs an ItemEvent object.

Method Index

o getItem()
Returns the item affected by the event.
o getItemSelectable()
Returns the originator of the event.
o getStateChange()
Returns the type of state change (selected or deselected).
o paramString()
Returns a parameter string identifying this item event.

Variables

o ITEM_FIRST 
public static final int ITEM_FIRST
The first number in the range of ids used for item events.

o ITEM_LAST 
public static final int ITEM_LAST
The last number in the range of ids used for item events.

o ITEM_STATE_CHANGED 
public static final int ITEM_STATE_CHANGED
This event id indicates that an item's state changed.

o SELECTED 
public static final int SELECTED
This state-change value indicates that an item was selected.

o DESELECTED 
public static final int DESELECTED
This state-change-value indicates that a selected item was un-selected.

Constructors

o ItemEvent 
public ItemEvent(ItemSelectable source,
                 int id,
                 Object item,
                 int stateChange)
Constructs an ItemEvent object.

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

Methods

o getItemSelectable 
public ItemSelectable getItemSelectable()
Returns the originator of the event.

Returns:
the ItemSelectable object that originated the event.
o getItem 
public Object getItem()
Returns the item affected by the event.

Returns:
the item (object) that was affected by the event
o getStateChange 
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
o paramString 
public String paramString()
Returns a parameter string identifying this item event. This method is useful for event-logging and for debugging.

Returns:
a string identifying the event and its attributes
Overrides:
paramString in class AWTEvent
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature