Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.awt.event

Class ItemEvent

Implemented Interfaces:
Serializable
public class ItemEvent
extends AWTEvent
This event is generated when a selection item changes state. This is an abstraction that distills a large number of individual mouse or keyboard events into a simpler "item selected" and "item deselected" events.
Since:
1.1
See Also:
ItemSelectable, ItemListener, Serialized Form

Field Summary

static int
DESELECTED
This type indicates that the item was deselected.
static int
ITEM_FIRST
This is the first id in the event id range used by this class.
static int
ITEM_LAST
This is the last id in the event id range used by this class.
static int
ITEM_STATE_CHANGED
This event id indicates a state change occurred.
static int
SELECTED
This type indicates that the item was selected.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, 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, consumed, id

Fields inherited from class java.util.EventObject

source

Constructor Summary

ItemEvent(ItemSelectable source, int id, Object item, int stateChange)
Initializes a new instance of ItemEvent with the specified source, id, and state change constant.

Method Summary

Object
getItem()
Returns the item affected by this state change.
ItemSelectable
getItemSelectable()
This method returns the event source as an ItemSelectable.
int
getStateChange()
Returns the type of state change, either SELECTED or DESELECTED.
String
paramString()
Returns a string identifying this event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource, toString

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DESELECTED

public static final int DESELECTED
This type indicates that the item was deselected.
Field Value:
2

ITEM_FIRST

public static final int ITEM_FIRST
This is the first id in the event id range used by this class.
Field Value:
701

ITEM_LAST

public static final int ITEM_LAST
This is the last id in the event id range used by this class.
Field Value:
701

ITEM_STATE_CHANGED

public static final int ITEM_STATE_CHANGED
This event id indicates a state change occurred.
Field Value:
701

SELECTED

public static final int SELECTED
This type indicates that the item was selected.
Field Value:
1

Constructor Details

ItemEvent

public ItemEvent(ItemSelectable source,
                 int id,
                 Object item,
                 int stateChange)
Initializes a new instance of ItemEvent with the specified source, id, and state change constant. Note that an invalid id leads to unspecified results.
Parameters:
source - the source of the event
id - the event id
item - the item affected by the state change
stateChange - one of SELECTED or DESELECTED

Method Details

getItem

public Object getItem()
Returns the item affected by this state change.
Returns:
the item affected by this state change

getItemSelectable

public ItemSelectable getItemSelectable()
This method returns the event source as an ItemSelectable.
Returns:
the event source as an ItemSelected
Throws:
ClassCastException - if source is changed to a non-ItemSelectable

getStateChange

public int getStateChange()
Returns the type of state change, either SELECTED or DESELECTED.
Returns:
the type of state change

paramString

public String paramString()
Returns a string identifying this event. This is in the format: "ITEM_STATE_CHANGED,item=" + item + ",stateChange=" + (getStateChange() == DESELECTED ? "DESELECTED" : "SELECTED").
Overrides:
paramString in interface AWTEvent
Returns:
a string identifying this event
ItemEvent.java -- event for item state changes Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About