AdjustmentEvent
Class AdjustmentEvent
- java.lang.Object
-
- java.util.EventObject
-
- java.awt.AWTEvent
-
- java.awt.event.AdjustmentEvent
- All Implemented Interfaces:
- Serializable
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
- Since:
- 1.1
- See Also:
-
Adjustable
,AdjustmentListener
, Serialized Form
Fields
ADJUSTMENT_FIRST
public static final int ADJUSTMENT_FIRST
Marks the first integer id for the range of adjustment event ids.
ADJUSTMENT_LAST
public static final int ADJUSTMENT_LAST
Marks the last integer id for the range of adjustment event ids.
ADJUSTMENT_VALUE_CHANGED
public static final int ADJUSTMENT_VALUE_CHANGED
The adjustment value changed event.
UNIT_INCREMENT
@Native public static final int UNIT_INCREMENT
The unit increment adjustment type.
UNIT_DECREMENT
@Native public static final int UNIT_DECREMENT
The unit decrement adjustment type.
BLOCK_DECREMENT
@Native public static final int BLOCK_DECREMENT
The block decrement adjustment type.
BLOCK_INCREMENT
@Native public static final int BLOCK_INCREMENT
The block increment adjustment type.
TRACK
@Native public static final int TRACK
The absolute tracking adjustment type.
Constructors
AdjustmentEvent
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
.
- Parameters:
-
source
- TheAdjustable
object where the event originated -
id
- 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:
-
EventObject.getSource()
,AWTEvent.getID()
,getAdjustmentType()
,getValue()
AdjustmentEvent
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
.
- Parameters:
-
source
- TheAdjustable
object where the event originated -
id
- 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 -
isAdjusting
- 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:
-
EventObject.getSource()
,AWTEvent.getID()
,getAdjustmentType()
,getValue()
,getValueIsAdjusting()
Methods
getAdjustable
public Adjustable getAdjustable()
Returns the Adjustable
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()
Returns true
if this is one of multiple adjustment events.
- Returns:
-
true
if this is one of multiple adjustment events, otherwise returnsfalse
- Since:
- 1.4
paramString
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
.
- Overrides:
-
paramString
in classAWTEvent
- Returns:
- a string representation of this event
© 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.