com.emarson.lemonade.bluelemon.midp1
Class Gauge

java.lang.Object
  com.emarson.lemonade.bluelemon.midp1.Gauge

public class Gauge
extends Object

This class delivers the functionality of the MIDP1 Gauge Java class to the Bluelemon environment.

Use GaugeFactory to instantiate this class.

Method Summary

String	getLabel() Gets the label of this Gauge object.
Number	getMaxValue() Gets the maximum value of this Gauge object.
Number	getValue() Gets the current value of this Gauge object.
void	increment() Increments the current value of this Gauge object.
Boolean	isInteractive() Tells whether the user is allowed to change the value of the Gauge.
void	setLabel(String label) Sets the label of the Gauge.
void	setMaxValue(Number value) Sets the maximum value of this Gauge object.
void	setValue(Number value) Sets the value of this Gauge object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLabel

public String getLabel()

Gets the label of this Gauge object.

Returns:

the label String

Usage examples:

   <blue:call object="gauge" method="getLabel"
              toVariable="label"/>
 

getMaxValue

public Number getMaxValue()

Gets the maximum value of this Gauge object.

Returns:

the maximum value of the Gauge

Usage examples:

   <blue:call object="gauge" method="getMaxValue"
              toVariable="maxValue"/>
 

getValue

public Number getValue()

Gets the current value of this Gauge object.

Returns:

current value of the Gauge

Usage examples:

   <blue:call object="gauge" method="getValue"
              toVariable="value"/>
 

increment

public void increment()

Increments the current value of this Gauge object.

Usage examples:

   <blue:call object="gauge" method="increment"/>
 

isInteractive

public Boolean isInteractive()

Tells whether the user is allowed to change the value of the Gauge.

Returns:

a Boolean indicating whether the Gauge is interactive

Usage examples:

   <blue:call object="gauge" method="isInteractive"
              toVariable="gaugeIsInteractive"/>
 

setLabel

public void setLabel(String label)

Sets the label of the Gauge.

Parameters:

the - label String

Usage examples:

   <blue:call object="gauge" method="setLabel">
     <blue:argument type="String" value="label"/>
   </blue:call>
 

setMaxValue

public void setMaxValue(Number value)

Sets the maximum value of this Gauge object.

Parameters:

value - the new maximum value

Usage examples:

   <blue:call object="gauge" method="setMaxValue">
     <blue:argument type="byte" value="18"/>
   </blue:call>
 

setValue

public void setValue(Number value)

Sets the value of this Gauge object.

Parameters:

value - the new value

Usage examples:

   <blue:call object="gauge" method="setValue">
     <blue:argument type="byte" value="5"/>
   </blue:call>