java.awt
class ScrollPaneAdjustable

java.lang.Object java.awt.ScrollPaneAdjustable

All Implemented Interfaces:

Adjustable, Serializable

public class ScrollPaneAdjustable
extends Object
implements Adjustable, Serializable

This class represents the state of a horizontal or vertical scrollbar of a ScrollPane. Objects of this class are returned by ScrollPane methods.

addAdjustmentListener

public synchronized void addAdjustmentListener(AdjustmentListener l)

Adds the specified adjustment listener to receive adjustment events from this ScrollPaneAdjustable. If l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters:

l - the adjustment listener.

getAdjustmentListeners

public synchronized AdjustmentListener[] getAdjustmentListeners()

Returns an array of all the adjustment listeners registered on this ScrollPaneAdjustable.

Returns:

all of this ScrollPaneAdjustable's AdjustmentListeners or an empty array if no adjustment listeners are currently registered

getBlockIncrement

public int getBlockIncrement()

getMaximum

public int getMaximum()

getMinimum

public int getMinimum()

getOrientation

public int getOrientation()

Returns the orientation of this scrollbar.

Returns:

the orientation of this scrollbar, either Adjustable.HORIZONTAL or Adjustable.VERTICAL

getUnitIncrement

public int getUnitIncrement()

getValue

public int getValue()

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns true if the value is in the process of changing as a result of actions being taken by the user.

Returns:

the value of the valueIsAdjusting property

getVisibleAmount

public int getVisibleAmount()

paramString

public String paramString()

Returns a string representing the state of this scrollbar. 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.

Returns:

the parameter string of this scrollbar.

removeAdjustmentListener

public synchronized void removeAdjustmentListener(AdjustmentListener l)

Removes the specified adjustment listener so that it no longer receives adjustment events from this ScrollPaneAdjustable. If l is null, no exception is thrown and no action is performed.

Refer to AWT Threading Issues for details on AWT's threading model.

Parameters:

l - the adjustment listener.

setBlockIncrement

public synchronized void setBlockIncrement(int b)

Parameters:

b

setMaximum

public void setMaximum(int max)

This method should NOT be called by user code. This method is public for this class to properly implement Adjustable interface.

Parameters:

max

setMinimum

public void setMinimum(int min)

This method should NOT be called by user code. This method is public for this class to properly implement Adjustable interface.

Parameters:

min

setUnitIncrement

public synchronized void setUnitIncrement(int u)

Parameters:

u

setValue

public void setValue(int v)

Sets the value of this scrollbar to the specified value.

If the value supplied is less than the current minimum or greater than the current maximum, then one of those values is substituted, as appropriate.

Parameters:

v - the new value of the scrollbar

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

Sets the valueIsAdjusting property.

Parameters:

b - new adjustment-in-progress status

setVisibleAmount

public void setVisibleAmount(int v)

This method should NOT be called by user code. This method is public for this class to properly implement Adjustable interface.

Parameters:

v

toString

public String toString()

Returns a string representation of this scrollbar and its values.

Overrides:

toString in class Object

Returns:

a string representation of this scrollbar.