Module java.desktop

Class 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
Assigning the value different from listed above will cause an unspecified behavior.

Since:
1.1
See Also:
Adjustable, AdjustmentListener, Serialized Form
  • Field Details

    • 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

      @Native public static final int UNIT_INCREMENT
      The unit increment adjustment type.
      See Also:
      Constant Field Values
    • UNIT_DECREMENT

      @Native public static final int UNIT_DECREMENT
      The unit decrement adjustment type.
      See Also:
      Constant Field Values
    • BLOCK_DECREMENT

      @Native public static final int BLOCK_DECREMENT
      The block decrement adjustment type.
      See Also:
      Constant Field Values
    • BLOCK_INCREMENT

      @Native public static final int BLOCK_INCREMENT
      The block increment adjustment type.
      See Also:
      Constant Field Values
    • TRACK

      @Native public static final int TRACK
      The absolute tracking adjustment type.
      See Also:
      Constant Field Values
  • Constructor Details

    • 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 - The Adjustable object where the event originated
      id - 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 adjustment
      Throws:
      IllegalArgumentException - if source 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 - The Adjustable object where the event originated
      id - 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 adjustment
      isAdjusting - A boolean that equals true if the event is one of a series of multiple adjusting events, otherwise false
      Throws:
      IllegalArgumentException - if source is null
      Since:
      1.4
      See Also:
      EventObject.getSource(), AWTEvent.getID(), getAdjustmentType(), getValue(), getValueIsAdjusting()
  • Method Details

    • 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
      Since:
      1.4