java.awt.event
Class AdjustmentEvent

java.lang.Object
  extended by java.util.EventObject
      extended by java.awt.AWTEvent
          extended by java.awt.event.AdjustmentEvent
All 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, 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
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, setSource, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ADJUSTMENT_FIRST

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

See Also:
Constant Field Values

ADJUSTMENT_LAST

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

See Also:
Constant Field Values

ADJUSTMENT_VALUE_CHANGED

public static final int ADJUSTMENT_VALUE_CHANGED
This is the id indicating an adjustment value changed.

See Also:
Constant Field Values

UNIT_INCREMENT

public static final int UNIT_INCREMENT
Adjustment type for unit increments.

See Also:
Constant Field Values

UNIT_DECREMENT

public static final int UNIT_DECREMENT
Adjustment type for unit decrements.

See Also:
Constant Field Values

BLOCK_DECREMENT

public static final int BLOCK_DECREMENT
Adjustment type for block decrements.

See Also:
Constant Field Values

BLOCK_INCREMENT

public static final int BLOCK_INCREMENT
Adjustment type for block increments.

See Also:
Constant Field Values

TRACK

public static final int TRACK
Adjustment type for tracking adjustments.

See Also:
Constant Field Values
Constructor Detail

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 Detail

getAdjustable

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

Returns:
the Adjustable source of the event

getValue

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

Returns:
the value 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

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 class AWTEvent
Returns:
a string that describes the event