java.awt.event
Class AdjustmentEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--java.awt.event.AdjustmentEvent
All Implemented Interfaces:
Serializable

public class AdjustmentEvent
extends AWTEvent

Safe:

See Also:
Serialized Form

Field Summary
(package private)  Adjustable adjustable
          The adjustable object that fired the event.
static int ADJUSTMENT_FIRST
          Enabled: Marks the first integer id for the range of adjustment event ids.
static int ADJUSTMENT_LAST
          Enabled: Marks the last integer id for the range of adjustment event ids.
static int ADJUSTMENT_VALUE_CHANGED
          Enabled: The adjustment value changed event.
(package private)  int adjustmentType
          The adjustmentType describes how the adjustable object value has changed.
static int BLOCK_DECREMENT
          Enabled: The block decrement adjustment type.
static int BLOCK_INCREMENT
          Enabled: The block increment adjustment type.
(package private)  boolean isAdjusting
          The isAdjusting is true if the event is one of the series of multiple adjustment events.
private static long serialVersionUID
           
static int TRACK
          Enabled: The absolute tracking adjustment type.
static int UNIT_DECREMENT
          Enabled: The unit decrement adjustment type.
static int UNIT_INCREMENT
          Enabled: The unit increment adjustment type.
(package private)  int value
          value will contain the new value of the adjustable object.
 
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)
          Suppressed: Constructs an AdjustmentEvent object with the specified Adjustable source, event type, adjustment type, and value.
AdjustmentEvent(Adjustable source, int id, int type, int value, boolean isAdjusting)
          Suppressed: Constructs an AdjustmentEvent object with the specified Adjustable source, event type, adjustment type, and value.
 
Method Summary
 Adjustable getAdjustable()
          Enabled: Returns the Adjustable object where this event originated.
 int getAdjustmentType()
          Enabled: Returns the type of adjustment which caused the value changed event.
 int getValue()
          Enabled: Returns the current value in the adjustment event.
 boolean getValueIsAdjusting()
          Enabled: Returns true if this is one of multiple adjustment events.
 String paramString()
          Suppressed:
 
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
Enabled: Marks the first integer id for the range of adjustment event ids.


ADJUSTMENT_LAST

public static final int ADJUSTMENT_LAST
Enabled: Marks the last integer id for the range of adjustment event ids.


ADJUSTMENT_VALUE_CHANGED

public static final int ADJUSTMENT_VALUE_CHANGED
Enabled: The adjustment value changed event.


UNIT_INCREMENT

public static final int UNIT_INCREMENT
Enabled: The unit increment adjustment type.


UNIT_DECREMENT

public static final int UNIT_DECREMENT
Enabled: The unit decrement adjustment type.


BLOCK_DECREMENT

public static final int BLOCK_DECREMENT
Enabled: The block decrement adjustment type.


BLOCK_INCREMENT

public static final int BLOCK_INCREMENT
Enabled: The block increment adjustment type.


TRACK

public static final int TRACK
Enabled: The absolute tracking adjustment type.


adjustable

Adjustable adjustable
The adjustable object that fired the event.

See Also:
getAdjustable()

value

int value
value will contain the new value of the adjustable object. This value will always be in a range associated adjustable object.

See Also:
getValue()

adjustmentType

int adjustmentType
The adjustmentType describes how the adjustable object value has changed. This value can be increased/decreased by a block or unit amount where the block is associated with page increments/decrements, and a unit is associated with line increments/decrements.

See Also:
getAdjustmentType()

isAdjusting

boolean isAdjusting
The isAdjusting is true if the event is one of the series of multiple adjustment events.

Since:
1.4
See Also:
getValueIsAdjusting()

serialVersionUID

private static final long serialVersionUID
Constructor Detail

AdjustmentEvent

public AdjustmentEvent(Adjustable source,
                       int id,
                       int type,
                       int value)
Suppressed: Constructs an AdjustmentEvent object with the specified Adjustable source, event type, adjustment type, and value.

Note that passing in an invalid id results in unspecified behavior.

Parameters:
source - the Adjustable object where the event originated
id - the event type
type - the adjustment type
value - the current value of the adjustment

AdjustmentEvent

public AdjustmentEvent(Adjustable source,
                       int id,
                       int type,
                       int value,
                       boolean isAdjusting)
Suppressed: Constructs an AdjustmentEvent object with the specified Adjustable source, event type, adjustment type, and value.

Note that passing in an invalid id results in unspecified behavior.

Parameters:
source - the Adjustable object where the event originated
id - the event type
type - the adjustment type
value - the current value of the adjustment
isAdjusting - true if the event is one of a series of multiple adjusting events, otherwise false
Method Detail

getAdjustable

public Adjustable getAdjustable()
Enabled: Returns the Adjustable object where this event originated.

Returns:
the Adjustable object where this event originated

getValue

public int getValue()
Enabled: Returns the current value in the adjustment event.

Returns:
the current value in the adjustment event

getAdjustmentType

public int getAdjustmentType()
Enabled: 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()
Enabled: Returns true if this is one of multiple adjustment events.

Returns:
true if this is one of multiple adjustment events, otherwise returns false

paramString

public String paramString()
Suppressed:

Overrides:
paramString in class AWTEvent
Returns:
a string representation of this event


comments?