All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.eou.toolkit.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 adjustValue(int)
Adjust the value for the gauge to present by a relative amount.
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 setMaximum(int)
Set the maximum of the current range.
o setMinimum(int)
Set the minimum of the current range.
o setValue(int)
Set the value for the gauge to present.
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 adjustValue 
 public abstract void adjustValue(int valueChange)
Adjust the value for the gauge to present by a relative amount.

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

o getValue 
 public abstract int 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 setMinimum 
 public abstract void setMinimum(int minimum)
Set the minimum of the current range.

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

o setMaximum 
 public abstract void setMaximum(int maximum)
Set the maximum of the current range.

o getMaximum 
 public abstract int 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