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 AdjustmentEvent

Implemented Interfaces:
Serializable
public class AdjustmentEvent
extends AWTEvent
This class represents an event that is generated when an adjustable value is changed.
Since:
1.1
See Also:
Adjustable, AdjustmentListener, Serialized Form

Field Summary

static int
ADJUSTMENT_FIRST
This is the first id in the range of ids used by adjustment events.
static int
ADJUSTMENT_LAST
This is the last id in the range of ids used by adjustment events.
static int
ADJUSTMENT_VALUE_CHANGED
This is the id indicating an adjustment value changed.
static int
BLOCK_DECREMENT
Adjustment type for block decrements.
static int
BLOCK_INCREMENT
Adjustment type for block increments.
static int
TRACK
Adjustment type for tracking adjustments.
static int
UNIT_DECREMENT
Adjustment type for unit decrements.
static int
UNIT_INCREMENT
Adjustment type for unit increments.

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

AdjustmentEvent(Adjustable source, int id, int type, int value)
Initializes an instance of AdjustmentEvent with the specified source, id, type, and value.
AdjustmentEvent(Adjustable source, int id, int type, int value, boolean isAdjusting)
Initializes an instance of AdjustmentEvent with the specified source, id, type, and value.

Method Summary

Adjustable
getAdjustable()
This method returns the source of the event as an Adjustable.
int
getAdjustmentType()
Returns the type of the event, which will be one of UNIT_INCREMENT, UNIT_DECREMENT, BLOCK_INCREMENT, BLOCK_DECREMENT, or TRACK.
int
getValue()
Returns the new value of the adjustable object.
boolean
getValueIsAdjusting()
Test if this event is part of a sequence of multiple adjustements.
String
paramString()
Returns a string that describes the 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

ADJUSTMENT_FIRST

public static final int ADJUSTMENT_FIRST
This is the first id in the range of ids used by adjustment events.
Field Value:
601

ADJUSTMENT_LAST

public static final int ADJUSTMENT_LAST
This is the last id in the range of ids used by adjustment events.
Field Value:
601

ADJUSTMENT_VALUE_CHANGED

public static final int ADJUSTMENT_VALUE_CHANGED
This is the id indicating an adjustment value changed.
Field Value:
601

BLOCK_DECREMENT

public static final int BLOCK_DECREMENT
Adjustment type for block decrements.
Field Value:
3

BLOCK_INCREMENT

public static final int BLOCK_INCREMENT
Adjustment type for block increments.
Field Value:
4

TRACK

public static final int TRACK
Adjustment type for tracking adjustments.
Field Value:
5

UNIT_DECREMENT

public static final int UNIT_DECREMENT
Adjustment type for unit decrements.
Field Value:
2

UNIT_INCREMENT

public static final int UNIT_INCREMENT
Adjustment type for unit increments.
Field Value:
1

Constructor Details

AdjustmentEvent

public AdjustmentEvent(Adjustable source,
                       int id,
                       int type,
                       int value)
Initializes an instance of AdjustmentEvent with the specified source, id, type, and value. Note that an invalid id leads to unspecified results.
Parameters:
source - the source of the event
id - the event id
type - the event type, one of the constants of this class
value - the value of the adjustment
Throws:
IllegalArgumentException - if source is null

AdjustmentEvent

public AdjustmentEvent(Adjustable source,
                       int id,
                       int type,
                       int value,
                       boolean isAdjusting)
Initializes an instance of AdjustmentEvent with the specified source, id, type, and value. Note that an invalid id leads to unspecified results.
Parameters:
source - the source of the event
id - the event id
type - the event type, one of the constants of this class
value - the value of the adjustment
isAdjusting - if this event is in a chain of adjustments
Throws:
IllegalArgumentException - if source is null
Since:
1.4

Method Details

getAdjustable

public Adjustable getAdjustable()
This method returns the source of the event as an Adjustable.
Returns:
the Adjustable source of the event

getAdjustmentType

public int getAdjustmentType()
Returns the type of the event, which will be one of UNIT_INCREMENT, UNIT_DECREMENT, BLOCK_INCREMENT, BLOCK_DECREMENT, or TRACK.
Returns:
the type of the event

getValue

public int getValue()
Returns the new value of the adjustable object.
Returns:
the value of the event

getValueIsAdjusting

public boolean getValueIsAdjusting()
Test if this event is part of a sequence of multiple adjustements.
Returns:
true if this is not the last adjustment
Since:
1.4

paramString

public String paramString()
Returns a string that describes the event. This is in the format "ADJUSTMENT_VALUE_CHANGED,adjType=" + <type> + ",value=" + getValue() + ",isAdjusting=" + getValueIsAdjusting(), where type is the name of the constant returned by getAdjustmentType().
Overrides:
paramString in interface AWTEvent
Returns:
a string that describes the event
AdjustmentEvent.java -- an adjustable value was changed Copyright (C) 1999, 2002, 2004, 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