All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface COM.ibm.beans.gauge.Gauge

public interface Gauge

This interface is designed to provide a common protocol for display components which present a single value from a numeric range to the user. It includes methods to set and query the gauge value and the current range, and to wait until the display synchronizes. Many gauges will not immediately display a new value when set, but will commence some animation until the display is synchronized with the value set.


Variable Index

 o copyright
Ensures that the short copyright string appears in the class file.

Method Index

 o getMaximum()
Return the maximum of the current range.
 o getMinimum()
Return the minimum of the current range.
 o getValue()
Return the current value of the gauge.
 o setRange(long, long)
Set the range for the gauge to present.
 o setValue(long)
Set the value for the gauge to present.
 o setValueAndRange(long, long, long)
Set the value for the gauge to present, together with the range to present it in.
 o synchronize()
Wait until the gauge is synchronized.

Variables

 o copyright

 public static final String copyright
Ensures that the short copyright string appears in the class file.

Methods

 o setValue

 public abstract void setValue(long value)
Set the value for the gauge to present.

 o setValueAndRange

 public abstract void setValueAndRange(long value,
                                       long minimum,
                                       long maximum)
Set the value for the gauge to present, together with the range to present it in.

 o getValue

 public abstract long getValue()
Return the current value of the gauge. Note that this may not be the value currently displayed to the user, if the gauge display is not yet synchronized.

 o setRange

 public abstract void setRange(long minimum,
                               long maximum)
Set the range for the gauge to present.

 o getMinimum

 public abstract long getMinimum()
Return the minimum of the current range.

 o getMaximum

 public abstract long getMaximum()
Return the maximum of the current range.

 o synchronize

 public abstract void synchronize()
Wait until the gauge is synchronized. The gauge is synchronized when the value actually displayed matches the current gauge value.

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Copyright © Taligent, Inc. 1996 - 1997.
Copyright
© IBM Corporation 1996 - 1997.
All Rights Reserved.