Class sgraphics.Adjustment
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class sgraphics.Adjustment

java.lang.Object
   |
   +----java.util.Observable
           |
           +----sgraphics.Adjustment

public class Adjustment
extends Observable
An adjustment is two segments that represent the possible and current range of values for a bounded value, such as would be used for scrolling.

Adjustment supports transactions. Calls made outside a transaction take affect immediately.


Constructor Index

 o Adjustment()

Method Index

 o begin()
Begin a transaction.
 o cancel()
Cancel a transaction.
 o commit()
End a transaction.
 o constrain(float)
Modify the given coordinate if necessary to keep it within the adjustment's settings.
 o getAdjustmentConstraint()
Get the constraint used to constrain the scroll region.
 o getLargeScroll()
Get the page forward and backward ammount.
 o getSettings()
Retrieve the current settings of the adjustment.
 o getSmallScroll()
Get the scroll forward and backward ammount.
 o pageBackward()
 o pageForward()
 o scaleTo(float)
Request that the adjustment change its current length, effectively scaling the adjustment so that it covers more or less of the total segment.
 o scrollBackward()
 o scrollBegin()
 o scrollBy(float)
Request that the adjustment change its lower position to add the given delta (which may be negative).
 o scrollEnd()
 o scrollForward()
 o scrollTo(float)
Request that the adjustment change its lower position to the given coordinate.
 o setAdjustmentConstraint(AdjustmentConstraint)
Set the constraint used to constrain the scroll region.
 o setLargeScroll(float)
Set the page forward and backward ammount.
 o setSmallScroll(float)
Set the scroll forward and backward ammount.

Constructors

 o Adjustment
  public Adjustment()

Methods

 o begin
  public abstract void begin()
Begin a transaction.
 o commit
  public abstract void commit()
End a transaction.
 o cancel
  public abstract void cancel()
Cancel a transaction.
 o setAdjustmentConstraint
  public abstract void setAdjustmentConstraint(AdjustmentConstraint constraint)
Set the constraint used to constrain the scroll region.
 o getAdjustmentConstraint
  public abstract AdjustmentConstraint getAdjustmentConstraint()
Get the constraint used to constrain the scroll region.
 o constrain
  public abstract float constrain(float constraint)
Modify the given coordinate if necessary to keep it within the adjustment's settings. If the given value is below the adjustment's lower bound, then set it to the lower bound. If the given value plus the current length is large than the adjustment's upper bound, then set it to be the upper bound minus the current length.
 o getSettings
  public abstract AdjustmentSettings getSettings()
Retrieve the current settings of the adjustment.
 o scaleTo
  public abstract void scaleTo(float length)
Request that the adjustment change its current length, effectively scaling the adjustment so that it covers more or less of the total segment.
 o scrollBy
  public abstract void scrollBy(float delta)
Request that the adjustment change its lower position to add the given delta (which may be negative).
 o scrollForward
  public abstract void scrollForward()
 o scrollBackward
  public abstract void scrollBackward()
 o pageForward
  public abstract void pageForward()
 o pageBackward
  public abstract void pageBackward()
 o scrollBegin
  public abstract void scrollBegin()
 o scrollEnd
  public abstract void scrollEnd()
 o scrollTo
  public abstract void scrollTo(float lower)
Request that the adjustment change its lower position to the given coordinate.
 o setSmallScroll
  public abstract void setSmallScroll(float size)
Set the scroll forward and backward ammount.
 o getSmallScroll
  public abstract float getSmallScroll()
Get the scroll forward and backward ammount.
 o setLargeScroll
  public abstract void setLargeScroll(float size)
Set the page forward and backward ammount.
 o getLargeScroll
  public abstract float getLargeScroll()
Get the page forward and backward ammount.

All Packages  Class Hierarchy  This Package  Previous  Next  Index