java.awt.event
Class AdjustmentEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byjava.awt.AWTEvent
          extended byjava.awt.event.AdjustmentEvent
All Implemented Interfaces:
Serializable

public class AdjustmentEvent
extends AWTEvent

The adjustment event emitted by Adjustable objects.

Since:
1.1
Author:
Amy Fowler
See Also:
Adjustable, AdjustmentListener, Serialized Form

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

See Also:
Constant Field Values

ADJUSTMENT_LAST

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

See Also:
Constant Field Values

ADJUSTMENT_VALUE_CHANGED

public static final int ADJUSTMENT_VALUE_CHANGED
The adjustment value changed event.

See Also:
Constant Field Values

UNIT_INCREMENT

public static final int UNIT_INCREMENT
The unit increment adjustment type.

See Also:
Constant Field Values

UNIT_DECREMENT

public static final int UNIT_DECREMENT
The unit decrement adjustment type.

See Also:
Constant Field Values

BLOCK_DECREMENT

public static final int BLOCK_DECREMENT
The block decrement adjustment type.

See Also:
Constant Field Values

BLOCK_INCREMENT

public static final int BLOCK_INCREMENT
The block increment adjustment type.

See Also:
Constant Field Values

TRACK

public static final int TRACK
The absolute tracking adjustment type.

See Also:
Constant Field Values

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
See Also:
Constant Field Values
Constructor Detail

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.

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)
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()
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 returns false

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 class AWTEvent
Returns:
a string representation of this event