javax.microedition.lcdui
クラス Gauge

java.lang.Object
  javax.microedition.lcdui.Item
      javax.microedition.lcdui.Gauge

public class Gauge
extends Item

このクラスはフォームにおいて、意図した値の棒グラフを表示するアイテムを表すクラスです。 ゲージはオプションで対話に対応します。 オブジェクトが受け付ける値は、0 からアプリケーションによって設定された最大の値までの範囲の正数です。 アプリケーションが示す値はこの範囲に正規化されます。 デバイスが装備しているディスプレイに表現可能な視覚表現でアプリケーションがした値を表示します。 このため、複数の値が同一の視覚表現を示すことがあります。

例えば、１セット１０本の棒を使用してゲージの近似値を表示するデバイス上で、0 〜 99 の範囲のゲージオブジェクトを想像してみてください。 デバイスは 0 〜 9 の値を１本目の棒、10 〜 19 までの値を２本目の棒、20 〜 29 までの値を３本目の棒などで表現するでしょう。

ゲージは対話型であることも非対話型であることもあります。 アプリケーションは対話モードであるか否かに関わらず、いつでもゲージの値を設定および取得することができます。 実装は、オブジェクトが対話モードか否かで視覚表現を変更するかもしれません。

対話モードでは、ユーザーがゲージの値を変更することができます。 ユーザーは常にゲージの値を 1 ずつ増減させることができ、さらにより大きな単位で増減させる手段を提供することもあります。 ユーザーは設定された範囲外に値を移動させることはできません。 想定される制御手順は、アプリケーションが初期値を設定し、次にユーザーが値を変更可能に設定する、ということです。 アプリケーションはユーザーがゲージを操作している最中であっても値を変更することができます。

多くのケースでは、ユーザーが値を修正するための唯一の手段は、ボタン操作によって１単位で値を増減させることのみです。 このため、アプリケーションは少量の範囲の値を指定すべきです。

非対話モードでは、ユーザーはゲージの値を変更することはできません。 非対話モードのゲージの想定される用途は、処理に長時間かかるオペレーションにおいて、進捗状態を示す「プログレスインジケータ」としての役割です。 この場合、アプリケーションは定期的に setValue(int) メソッドを呼び出し、値をアップデートします。 プログレスインジケータとしてゲージを使用するアプリケーションは、一般に STOP コマンドを提供し、ユーザーが処理を停止できるようにすべきです。

Gauge

public Gauge(String label,
             boolean interactive,
             int maxValue,
             int initialValue)

指定されたラベル、対話モード、最大値と初期値のオブジェクトを構築します。 最大値は 0 以上の値で指定します。 負数の場合は IllegalArgumentException を throw します。 初期値は 0 〜 maxValue の範囲の値でなければなりません。 初期値が負数の場合 0 として取り扱います。 また初期値が maxValue よりも大きい場合、maxValue と同じ値として取り扱います。

パラメータ:

label - 設定するラベルを渡します。

interactive - ユーザーと対話可能なモードにする場合は true を、対話不可能なモードにする場合は false を渡します。

maxValue - ゲージの最大値を渡します。

initialValue - ゲージの初期値を渡します。

例外:

IllegalArgumentException - 最大値が不正な場合に throw します。

setValue

public void setValue(int value)

このゲージオブジェクトの値を設定します。 値が負数の場合、0 として取り扱います。 値が最大値以上の場合、最大値が指定されたものとして取り扱います。

パラメータ:

value - 新しく設定する値を渡します。

getValue

public int getValue()

このゲージオブジェクトに設定されている値を返します。

戻り値:

現在このゲージオブジェクトに設定されている値を返します。

setMaxValue

public void setMaxValue(int maxValue)

このゲージオブジェクトの最大値を設定します。 新しい最大値は負数であってはなりません。 負数の場合は IllegalArgumentException を throw します。 現在値が新しい最大値よりも大きな値の場合、現在値は新しい最大値と等しい値に修正されます。

パラメータ:

maxValue - 設定する新しい最大値を渡します。

例外:

IllegalArgumentException - 新しい最大値が不正な場合に throw します。

getMaxValue

public int getMaxValue()

このオブジェクトに設定されている最大値を返します。

戻り値:

設定されている最大値を返します。

isInteractive

public boolean isInteractive()

ゲージの値をユーザーが変更できるかどうかを返します。 変更できる場合は true を、変更できない場合は false を返します。

戻り値:

ユーザーが変更できる場合は true を、そうでなければ false を返します。

setLabel

public void setLabel(String label)

ラベルをこのアイテムに設定します。 ラベルに null が指定された場合、ラベルは設定されていない状態となります。

オーバーライド:

クラス Item 内の setLabel

パラメータ:

label - 設定するラベルあるいは null を渡します。