java.awt
Class ScrollPaneAdjustable

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.ScrollPaneAdjustable
All Implemented Interfaces:
Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class ScrollPaneAdjustable
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

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

Since:
1.4
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface java.awt.Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
HORIZONTAL sample code for java.awt.Adjustable.HORIZONTAL definition code for java.awt.Adjustable.HORIZONTAL , NO_ORIENTATION sample code for java.awt.Adjustable.NO_ORIENTATION definition code for java.awt.Adjustable.NO_ORIENTATION , VERTICAL sample code for java.awt.Adjustable.VERTICAL definition code for java.awt.Adjustable.VERTICAL
 
Method Summary
 void addAdjustmentListener sample code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) (AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
          Adds the specified adjustment listener to receive adjustment events from this ScrollPaneAdjustable.
 AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener [] getAdjustmentListeners sample code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() definition code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() ()
          Returns an array of all the adjustment listeners registered on this ScrollPaneAdjustable.
 int getBlockIncrement sample code for java.awt.ScrollPaneAdjustable.getBlockIncrement() definition code for java.awt.ScrollPaneAdjustable.getBlockIncrement() ()
          Gets the block value increment for the adjustable object.
 int getMaximum sample code for java.awt.ScrollPaneAdjustable.getMaximum() definition code for java.awt.ScrollPaneAdjustable.getMaximum() ()
          Gets the maximum value of the adjustable object.
 int getMinimum sample code for java.awt.ScrollPaneAdjustable.getMinimum() definition code for java.awt.ScrollPaneAdjustable.getMinimum() ()
          Gets the minimum value of the adjustable object.
 int getOrientation sample code for java.awt.ScrollPaneAdjustable.getOrientation() definition code for java.awt.ScrollPaneAdjustable.getOrientation() ()
          Returns the orientation of this scrollbar.
 int getUnitIncrement sample code for java.awt.ScrollPaneAdjustable.getUnitIncrement() definition code for java.awt.ScrollPaneAdjustable.getUnitIncrement() ()
          Gets the unit value increment for the adjustable object.
 int getValue sample code for java.awt.ScrollPaneAdjustable.getValue() definition code for java.awt.ScrollPaneAdjustable.getValue() ()
          Gets the current value of the adjustable object.
 boolean getValueIsAdjusting sample code for java.awt.ScrollPaneAdjustable.getValueIsAdjusting() definition code for java.awt.ScrollPaneAdjustable.getValueIsAdjusting() ()
          Returns true if the value is in the process of changing as a result of actions being taken by the user.
 int getVisibleAmount sample code for java.awt.ScrollPaneAdjustable.getVisibleAmount() definition code for java.awt.ScrollPaneAdjustable.getVisibleAmount() ()
          Gets the length of the proportional indicator.
 String sample code for java.lang.String definition code for java.lang.String paramString sample code for java.awt.ScrollPaneAdjustable.paramString() definition code for java.awt.ScrollPaneAdjustable.paramString() ()
          Returns a string representing the state of this scrollbar.
 void removeAdjustmentListener sample code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) (AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener  l)
          Removes the specified adjustment listener so that it no longer receives adjustment events from this ScrollPaneAdjustable.
 void setBlockIncrement sample code for java.awt.ScrollPaneAdjustable.setBlockIncrement(int) definition code for java.awt.ScrollPaneAdjustable.setBlockIncrement(int) (int b)
          Sets the block value increment for the adjustable object.
 void setMaximum sample code for java.awt.ScrollPaneAdjustable.setMaximum(int) definition code for java.awt.ScrollPaneAdjustable.setMaximum(int) (int max)
          This method should NOT be called by user code.
 void setMinimum sample code for java.awt.ScrollPaneAdjustable.setMinimum(int) definition code for java.awt.ScrollPaneAdjustable.setMinimum(int) (int min)
          This method should NOT be called by user code.
 void setUnitIncrement sample code for java.awt.ScrollPaneAdjustable.setUnitIncrement(int) definition code for java.awt.ScrollPaneAdjustable.setUnitIncrement(int) (int u)
          Sets the unit value increment for the adjustable object.
 void setValue sample code for java.awt.ScrollPaneAdjustable.setValue(int) definition code for java.awt.ScrollPaneAdjustable.setValue(int) (int v)
          Sets the value of this scrollbar to the specified value.
 void setValueIsAdjusting sample code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean) definition code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean) (boolean b)
          Sets the valueIsAdjusting property.
 void setVisibleAmount sample code for java.awt.ScrollPaneAdjustable.setVisibleAmount(int) definition code for java.awt.ScrollPaneAdjustable.setVisibleAmount(int) (int v)
          This method should NOT be called by user code.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.ScrollPaneAdjustable.toString() definition code for java.awt.ScrollPaneAdjustable.toString() ()
          Returns a string representation of this scrollbar and its values.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Method Detail

getOrientation sample code for java.awt.ScrollPaneAdjustable.getOrientation() definition code for java.awt.ScrollPaneAdjustable.getOrientation()

public int getOrientation()
Returns the orientation of this scrollbar.

Specified by:
getOrientation sample code for java.awt.Adjustable.getOrientation() definition code for java.awt.Adjustable.getOrientation() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the orientation of this scrollbar, either Adjustable.HORIZONTAL or Adjustable.VERTICAL

setMinimum sample code for java.awt.ScrollPaneAdjustable.setMinimum(int) definition code for java.awt.ScrollPaneAdjustable.setMinimum(int)

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.

Specified by:
setMinimum sample code for java.awt.Adjustable.setMinimum(int) definition code for java.awt.Adjustable.setMinimum(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
min - the minimum value
Throws:
AWTError - Always throws an error when called.

getMinimum sample code for java.awt.ScrollPaneAdjustable.getMinimum() definition code for java.awt.ScrollPaneAdjustable.getMinimum()

public int getMinimum()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getMinimum() definition code for java.awt.Adjustable.getMinimum()
Gets the minimum value of the adjustable object.

Specified by:
getMinimum sample code for java.awt.Adjustable.getMinimum() definition code for java.awt.Adjustable.getMinimum() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the minimum value of the adjustable object

setMaximum sample code for java.awt.ScrollPaneAdjustable.setMaximum(int) definition code for java.awt.ScrollPaneAdjustable.setMaximum(int)

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.

Specified by:
setMaximum sample code for java.awt.Adjustable.setMaximum(int) definition code for java.awt.Adjustable.setMaximum(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
max - the maximum value
Throws:
AWTError - Always throws an error when called.

getMaximum sample code for java.awt.ScrollPaneAdjustable.getMaximum() definition code for java.awt.ScrollPaneAdjustable.getMaximum()

public int getMaximum()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getMaximum() definition code for java.awt.Adjustable.getMaximum()
Gets the maximum value of the adjustable object.

Specified by:
getMaximum sample code for java.awt.Adjustable.getMaximum() definition code for java.awt.Adjustable.getMaximum() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the maximum value of the adjustable object

setUnitIncrement sample code for java.awt.ScrollPaneAdjustable.setUnitIncrement(int) definition code for java.awt.ScrollPaneAdjustable.setUnitIncrement(int)

public void setUnitIncrement(int u)
Description copied from interface: Adjustable sample code for java.awt.Adjustable.setUnitIncrement(int) definition code for java.awt.Adjustable.setUnitIncrement(int)
Sets the unit value increment for the adjustable object.

Specified by:
setUnitIncrement sample code for java.awt.Adjustable.setUnitIncrement(int) definition code for java.awt.Adjustable.setUnitIncrement(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
u - the unit increment

getUnitIncrement sample code for java.awt.ScrollPaneAdjustable.getUnitIncrement() definition code for java.awt.ScrollPaneAdjustable.getUnitIncrement()

public int getUnitIncrement()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getUnitIncrement() definition code for java.awt.Adjustable.getUnitIncrement()
Gets the unit value increment for the adjustable object.

Specified by:
getUnitIncrement sample code for java.awt.Adjustable.getUnitIncrement() definition code for java.awt.Adjustable.getUnitIncrement() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the unit value increment for the adjustable object

setBlockIncrement sample code for java.awt.ScrollPaneAdjustable.setBlockIncrement(int) definition code for java.awt.ScrollPaneAdjustable.setBlockIncrement(int)

public void setBlockIncrement(int b)
Description copied from interface: Adjustable sample code for java.awt.Adjustable.setBlockIncrement(int) definition code for java.awt.Adjustable.setBlockIncrement(int)
Sets the block value increment for the adjustable object.

Specified by:
setBlockIncrement sample code for java.awt.Adjustable.setBlockIncrement(int) definition code for java.awt.Adjustable.setBlockIncrement(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
b - the block increment

getBlockIncrement sample code for java.awt.ScrollPaneAdjustable.getBlockIncrement() definition code for java.awt.ScrollPaneAdjustable.getBlockIncrement()

public int getBlockIncrement()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getBlockIncrement() definition code for java.awt.Adjustable.getBlockIncrement()
Gets the block value increment for the adjustable object.

Specified by:
getBlockIncrement sample code for java.awt.Adjustable.getBlockIncrement() definition code for java.awt.Adjustable.getBlockIncrement() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the block value increment for the adjustable object

setVisibleAmount sample code for java.awt.ScrollPaneAdjustable.setVisibleAmount(int) definition code for java.awt.ScrollPaneAdjustable.setVisibleAmount(int)

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.

Specified by:
setVisibleAmount sample code for java.awt.Adjustable.setVisibleAmount(int) definition code for java.awt.Adjustable.setVisibleAmount(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
v - the length of the indicator
Throws:
AWTError - Always throws an error when called.

getVisibleAmount sample code for java.awt.ScrollPaneAdjustable.getVisibleAmount() definition code for java.awt.ScrollPaneAdjustable.getVisibleAmount()

public int getVisibleAmount()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getVisibleAmount() definition code for java.awt.Adjustable.getVisibleAmount()
Gets the length of the proportional indicator.

Specified by:
getVisibleAmount sample code for java.awt.Adjustable.getVisibleAmount() definition code for java.awt.Adjustable.getVisibleAmount() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the length of the proportional indicator

setValueIsAdjusting sample code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean) definition code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean)

public void setValueIsAdjusting(boolean b)
Sets the valueIsAdjusting property.

Parameters:
b - new adjustment-in-progress status
Since:
1.4
See Also:
getValueIsAdjusting() sample code for java.awt.ScrollPaneAdjustable.getValueIsAdjusting() definition code for java.awt.ScrollPaneAdjustable.getValueIsAdjusting()

getValueIsAdjusting sample code for java.awt.ScrollPaneAdjustable.getValueIsAdjusting() definition code for java.awt.ScrollPaneAdjustable.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
See Also:
setValueIsAdjusting(boolean) sample code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean) definition code for java.awt.ScrollPaneAdjustable.setValueIsAdjusting(boolean)

setValue sample code for java.awt.ScrollPaneAdjustable.setValue(int) definition code for java.awt.ScrollPaneAdjustable.setValue(int)

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.

Specified by:
setValue sample code for java.awt.Adjustable.setValue(int) definition code for java.awt.Adjustable.setValue(int) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
v - the new value of the scrollbar

getValue sample code for java.awt.ScrollPaneAdjustable.getValue() definition code for java.awt.ScrollPaneAdjustable.getValue()

public int getValue()
Description copied from interface: Adjustable sample code for java.awt.Adjustable.getValue() definition code for java.awt.Adjustable.getValue()
Gets the current value of the adjustable object.

Specified by:
getValue sample code for java.awt.Adjustable.getValue() definition code for java.awt.Adjustable.getValue() in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Returns:
the current value of the adjustable object

addAdjustmentListener sample code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener)

public void addAdjustmentListener(AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.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.

Specified by:
addAdjustmentListener sample code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
l - the adjustment listener.
See Also:
removeAdjustmentListener(java.awt.event.AdjustmentListener) sample code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) , getAdjustmentListeners() sample code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() definition code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() , AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener , AdjustmentEvent sample code for java.awt.event.AdjustmentEvent definition code for java.awt.event.AdjustmentEvent

removeAdjustmentListener sample code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener)

public void removeAdjustmentListener(AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.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.

Specified by:
removeAdjustmentListener sample code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.Adjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) in interface Adjustable sample code for java.awt.Adjustable definition code for java.awt.Adjustable
Parameters:
l - the adjustment listener.
Since:
JDK1.1
See Also:
addAdjustmentListener(java.awt.event.AdjustmentListener) sample code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) , getAdjustmentListeners() sample code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() definition code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() , AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener , AdjustmentEvent sample code for java.awt.event.AdjustmentEvent definition code for java.awt.event.AdjustmentEvent

getAdjustmentListeners sample code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners() definition code for java.awt.ScrollPaneAdjustable.getAdjustmentListeners()

public AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.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
Since:
1.4
See Also:
addAdjustmentListener(java.awt.event.AdjustmentListener) sample code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.addAdjustmentListener(java.awt.event.AdjustmentListener) , removeAdjustmentListener(java.awt.event.AdjustmentListener) sample code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) definition code for java.awt.ScrollPaneAdjustable.removeAdjustmentListener(java.awt.event.AdjustmentListener) , AdjustmentListener sample code for java.awt.event.AdjustmentListener definition code for java.awt.event.AdjustmentListener , AdjustmentEvent sample code for java.awt.event.AdjustmentEvent definition code for java.awt.event.AdjustmentEvent

toString sample code for java.awt.ScrollPaneAdjustable.toString() definition code for java.awt.ScrollPaneAdjustable.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns a string representation of this scrollbar and its values.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this scrollbar.

paramString sample code for java.awt.ScrollPaneAdjustable.paramString() definition code for java.awt.ScrollPaneAdjustable.paramString()

public String sample code for java.lang.String definition code for java.lang.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.