public class AdjustmentEvent extends AWTEvent
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
Adjustable
, AdjustmentListener
, Serialized Formpublic static final int ADJUSTMENT_FIRST
Marks the first integer id for the range of adjustment event ids.
public static final int ADJUSTMENT_LAST
Marks the last integer id for the range of adjustment event ids.
public static final int ADJUSTMENT_VALUE_CHANGED
The adjustment value changed event.
@Native public static final int UNIT_INCREMENT
The unit increment adjustment type.
@Native public static final int UNIT_DECREMENT
The unit decrement adjustment type.
@Native public static final int BLOCK_DECREMENT
The block decrement adjustment type.
@Native public static final int BLOCK_INCREMENT
The block increment adjustment type.
@Native public static final int TRACK
The absolute tracking adjustment type.
public AdjustmentEvent(Adjustable source, int id, int type, int value)
Constructs an AdjustmentEvent
object with the specified Adjustable
source, event type, adjustment type, and value.
This method throws an IllegalArgumentException
if source
is null
.
source
- The Adjustable
object where the event originatedid
- An integer indicating the type of event. For information on allowable values, see the class description for AdjustmentEvent
type
- An integer indicating the adjustment type. For information on allowable values, see the class description for AdjustmentEvent
value
- The current value of the adjustmentIllegalArgumentException
- if source
is nullEventObject.getSource()
, AWTEvent.getID()
, getAdjustmentType()
, getValue()
public AdjustmentEvent(Adjustable source, int id, int type, int value, boolean isAdjusting)
Constructs an AdjustmentEvent
object with the specified Adjustable source, event type, adjustment type, and value.
This method throws an IllegalArgumentException
if source
is null
.
source
- The Adjustable
object where the event originatedid
- An integer indicating the type of event. For information on allowable values, see the class description for AdjustmentEvent
type
- An integer indicating the adjustment type. For information on allowable values, see the class description for AdjustmentEvent
value
- The current value of the adjustmentisAdjusting
- A boolean that equals true
if the event is one of a series of multiple adjusting events, otherwise false
IllegalArgumentException
- if source
is nullEventObject.getSource()
, AWTEvent.getID()
, getAdjustmentType()
, getValue()
, getValueIsAdjusting()
public Adjustable getAdjustable()
Returns the Adjustable
object where this event originated.
Adjustable
object where this event originatedpublic int getValue()
Returns the current value in the adjustment event.
public int getAdjustmentType()
Returns the type of adjustment which caused the value changed event. It will have one of the following values:
public boolean getValueIsAdjusting()
Returns true
if this is one of multiple adjustment events.
true
if this is one of multiple adjustment events, otherwise returns false
public String paramString()
Description copied from class: AWTEvent
Returns a string representing the state of this Event
. 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 be null
.
paramString
in class AWTEvent
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.