Home » openjdk-7 » java » awt » event » [javadoc | source]
java.awt.event
public class: ItemEvent [javadoc | source]
java.lang.Object
   java.util.EventObject
      java.awt.AWTEvent
         java.awt.event.ItemEvent

All Implemented Interfaces:
    Serializable

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 {@code id} parameter of any particular {@code ItemEvent} instance is not in the range from {@code ITEM_FIRST} to {@code ITEM_LAST}.

The {@code stateChange} of any {@code ItemEvent} instance takes one of the following values:

Assigning the value different from listed above will cause an unspecified behavior.
Field Summary
public static final  int ITEM_FIRST    The first 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. 
public static final  int ITEM_STATE_CHANGED    This event id indicates that an item's state changed. 
public static final  int SELECTED    This state-change value indicates that an item was selected. 
public static final  int DESELECTED    This state-change-value indicates that a selected item was deselected. 
 Object item    The item whose selection state has changed. 
 int stateChange    stateChange indicates whether the item was selected or deselected. 
Fields inherited from java.awt.AWTEvent:
id,  consumed,  focusManagerIsDispatching,  isPosted,  COMPONENT_EVENT_MASK,  CONTAINER_EVENT_MASK,  FOCUS_EVENT_MASK,  KEY_EVENT_MASK,  MOUSE_EVENT_MASK,  MOUSE_MOTION_EVENT_MASK,  WINDOW_EVENT_MASK,  ACTION_EVENT_MASK,  ADJUSTMENT_EVENT_MASK,  ITEM_EVENT_MASK,  TEXT_EVENT_MASK,  INPUT_METHOD_EVENT_MASK,  INPUT_METHODS_ENABLED_MASK,  PAINT_EVENT_MASK,  INVOCATION_EVENT_MASK,  HIERARCHY_EVENT_MASK,  HIERARCHY_BOUNDS_EVENT_MASK,  MOUSE_WHEEL_EVENT_MASK,  WINDOW_STATE_EVENT_MASK,  WINDOW_FOCUS_EVENT_MASK,  RESERVED_ID_MAX
Fields inherited from java.util.EventObject:
source
Constructor:
 public ItemEvent(ItemSelectable source,
    int id,
    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:
    IllegalArgumentException - if source is null
    Also see:
    getItemSelectable()
    getID()
    getStateChange()
Method from java.awt.event.ItemEvent Summary:
getItem,   getItemSelectable,   getStateChange,   paramString
Methods from java.awt.AWTEvent:
consume,   convertToOld,   copyPrivateDataInto,   dispatched,   getAccessControlContext,   getID,   isConsumed,   paramString,   setSource,   toString
Methods from java.util.EventObject:
getSource,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.event.ItemEvent Detail:
 public Object getItem() 
    Returns the item affected by the event.
 public ItemSelectable getItemSelectable() 
    Returns the originator of the event.
 public int getStateChange() 
    Returns the type of state change (selected or deselected).
 public String paramString() 
    Returns a parameter string identifying this item event. This method is useful for event-logging and for debugging.