Class AdjustmentEvent
java.lang.Object
java.util.EventObject
java.awt.AWTEvent
java.awt.event.AdjustmentEvent
- All Implemented Interfaces:
Serializable
The adjustment event emitted by Adjustable objects like
Scrollbar
and ScrollPane
.
When the user changes the value of the scrolling component,
it receives an instance of AdjustmentEvent
.
An unspecified behavior will be caused if the id
parameter
of any particular AdjustmentEvent
instance is not
in the range from ADJUSTMENT_FIRST
to ADJUSTMENT_LAST
.
The type
of any AdjustmentEvent
instance takes one of the following
values:
-
UNIT_INCREMENT
-
UNIT_DECREMENT
-
BLOCK_INCREMENT
-
BLOCK_DECREMENT
-
TRACK
- Since:
- 1.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Marks the first integer id for the range of adjustment event ids.static final int
Marks the last integer id for the range of adjustment event ids.static final int
The adjustment value changed event.static final int
The block decrement adjustment type.static final int
The block increment adjustment type.static final int
The absolute tracking adjustment type.static final int
The unit decrement adjustment type.static final int
The unit increment adjustment type.Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, 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
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionAdjustmentEvent
(Adjustable source, int id, int type, int value) Constructs anAdjustmentEvent
object with the specifiedAdjustable
source, event type, adjustment type, and value.AdjustmentEvent
(Adjustable source, int id, int type, int value, boolean isAdjusting) Constructs anAdjustmentEvent
object with the specified Adjustable source, event type, adjustment type, and value. -
Method Summary
Modifier and TypeMethodDescriptionReturns theAdjustable
object where this event originated.int
Returns the type of adjustment which caused the value changed event.int
getValue()
Returns the current value in the adjustment event.boolean
Returnstrue
if this is one of multiple adjustment events.Returns a string representing the state of thisEvent
.Methods inherited from class java.util.EventObject
getSource
-
Field Details
-
ADJUSTMENT_FIRST
public static final int ADJUSTMENT_FIRSTMarks the first integer id for the range of adjustment event ids.- See Also:
-
ADJUSTMENT_LAST
public static final int ADJUSTMENT_LASTMarks the last integer id for the range of adjustment event ids.- See Also:
-
ADJUSTMENT_VALUE_CHANGED
public static final int ADJUSTMENT_VALUE_CHANGEDThe adjustment value changed event.- See Also:
-
UNIT_INCREMENT
-
UNIT_DECREMENT
-
BLOCK_DECREMENT
-
BLOCK_INCREMENT
-
TRACK
-
-
Constructor Details
-
AdjustmentEvent
Constructs anAdjustmentEvent
object with the specifiedAdjustable
source, event type, adjustment type, and value.This method throws an
IllegalArgumentException
ifsource
isnull
.- Parameters:
source
- TheAdjustable
object where the event originatedid
- An integer indicating the type of event. For information on allowable values, see the class description forAdjustmentEvent
type
- An integer indicating the adjustment type. For information on allowable values, see the class description forAdjustmentEvent
value
- The current value of the adjustment- Throws:
IllegalArgumentException
- ifsource
is null- See Also:
-
AdjustmentEvent
Constructs anAdjustmentEvent
object with the specified Adjustable source, event type, adjustment type, and value.This method throws an
IllegalArgumentException
ifsource
isnull
.- Parameters:
source
- TheAdjustable
object where the event originatedid
- An integer indicating the type of event. For information on allowable values, see the class description forAdjustmentEvent
type
- An integer indicating the adjustment type. For information on allowable values, see the class description forAdjustmentEvent
value
- The current value of the adjustmentisAdjusting
- A boolean that equalstrue
if the event is one of a series of multiple adjusting events, otherwisefalse
- Throws:
IllegalArgumentException
- ifsource
is null- Since:
- 1.4
- See Also:
-
-
Method Details
-
getAdjustable
Returns theAdjustable
object where this event originated.- Returns:
- the
Adjustable
object where this event originated
-
getValue
public int getValue()Returns the current value in the adjustment event.- Returns:
- the current value in the adjustment event
-
getAdjustmentType
public int getAdjustmentType()Returns the type of adjustment which caused the value changed event. It will have one of the following values:- Returns:
- one of the adjustment values listed above
-
getValueIsAdjusting
public boolean getValueIsAdjusting()Returnstrue
if this is one of multiple adjustment events.- Returns:
true
if this is one of multiple adjustment events, otherwise returnsfalse
- Since:
- 1.4
-
paramString
Description copied from class:AWTEvent
Returns a string representing the state of thisEvent
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull
.- Overrides:
paramString
in classAWTEvent
- Returns:
- a string representation of this event
-