javax.microedition.lcdui
クラス ImageItem

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

public class ImageItem
extends Item

Form あるいは Alert オブジェクトに対してイメージを加える際に使用するクラスです。

各 ImageItem オブジェクトは Image オブジェクトへの参照を含んでいます。 この Image は不変タイプでなければなりません（もし、不変タイプのオブジェクトではないなら、アプリケーションは常にそのオブジェクトに対して描画を行う可能性があります。 その描画が行われるたびに Form または Alert オブジェクトのアップデートが必要となってしまいます）。

イメージとして null を指定することができます。 この状態でさらにラベルにも null が設定されている場合、ImageItem はスクリーン上のスペースを使用しません。

各 ImageItem オブジェクトは次の定数から組み合わされるレイアウトが設定されています： LAYOUT_LEFT、LAYOUT_RIGHT、LAYOUT_CENTER、LAYOUT_NEWLINE_BEFORE、LAYOUT_NEWLINE_AFTER。 LAYOUT_LEFT ＋ LAYOUT_RIGHT は LAYOUT_CENTER と等価です。 LAYOUT_DEFAULT を指定すると、システムがこの ImageItem を配置するためにデフォルト・レイアウト・ポリシーを使用することを示します。 レイアウト・フィールドの値はヒントとして扱われます。 ディスプレイのサイズに制限があるような装置の場合、実装はレイアウトの指定を無視することがあるかもしれません。

レイアウトを指定する際の組み合わせは、いくつかの暗黙の規則があります。

• LAYOUT_DEFAULT は他の指定と組み合わせることができないわけではありませんが、値が 0 のため、LAYOUT_DEFAULT 自身の指定は意味を持ちません。
• LAYOUT_LEFT、LAYOUT_RIGHT、LAYOUT_CENTER の指定は排他使用です。
• LAYOUT_LEFT、LAYOUT_RIGHT、LAYOUT_CENTER を LAYOUT_NEWLINE_BEFORE あるいは LAYOUT_NEWLINE_AFTER と組み合わせることができます。

コンストラクタに渡す altText パラメータはイメージをスクリーンに表示できない場合に、イメージの代わりに表示する文字列を指定します。 このため必ずも altText が使用されるわけではありません。

LAYOUT_DEFAULT

public static final int LAYOUT_DEFAULT

イメージの「コンテナ」のデフォルトの書式を使用してレイアウトを行うことを示す定数（=0）です。

関連項目:

定数フィールド値

LAYOUT_LEFT

public static final int LAYOUT_LEFT

イメージを描画エリアの左端に置くことを示す定数（=1）です。

関連項目:

定数フィールド値

LAYOUT_RIGHT

public static final int LAYOUT_RIGHT

イメージを描画エリアの右端に置くことを示す定数（=2）です。

関連項目:

定数フィールド値

LAYOUT_CENTER

public static final int LAYOUT_CENTER

イメージを描画エリアの中央に置くことを示す定数（=3）です。

関連項目:

定数フィールド値

LAYOUT_NEWLINE_BEFORE

public static final int LAYOUT_NEWLINE_BEFORE

イメージを置く前に改行することを示す定数（=0x100）です。

関連項目:

定数フィールド値

LAYOUT_NEWLINE_AFTER

public static final int LAYOUT_NEWLINE_AFTER

イメージを置いてから改行することを示す定数（=0x200）です。

関連項目:

定数フィールド値

ImageItem

public ImageItem(String label,
                 Image img,
                 int layout,
                 String altText)

指定されたラベル、イメージ、レイアウト指定、代替テキスト文字列を受け取って新しい ImageItem を作成します。

パラメータ:

label - ラベル文字列を渡します。

img - 不変タイプのイメージを渡します。

layout - レイアウトを指定する値を渡します。

altText - イメージが表示できない場合に代わりに表示する文字列を渡します。

例外:

IllegalArgumentException - イメージが不変タイプではないかレイアウト指定が不正な場合に throw します。

getImage

public Image getImage()

ImageItem オブジェクトが保持しているイメージ、あるいは保持しているイメージが無い場合は null を返します。

戻り値:

image 保持しているイメージあるいは null を返します。

setImage

public void setImage(Image img)

ImageItem オブジェクトに新たな Image オブジェクトを設定します。 イメージは不変タイプでなければなりません。 img が null の場合、ImageItem オブジェクトはイメージを空状態にします。

パラメータ:

img - 新しく設定するイメージを渡します。

例外:

IllegalArgumentException - イメージが可変タイプの場合に throw します。

getAltText

public String getAltText()

イメージが表示できない場合に代わりに表示する文字列を返します。 代わりの文字列が設定されていない場合、null を返します。

戻り値:

代わりの文字列あるいは null を返します。

setAltText

public void setAltText(String altText)

イメージが表示できない場合に代わりに表示する文字列を設定します。 代わりの文字列を提供しない場合は null を渡します。

パラメータ:

altText - 新しく設定する代わりの文字列あるいは null を渡します。

getLayout

public int getLayout()

イメージを配置するためのレイアウト指定を返します。

戻り値:

設定されているレイアウト指定を返します。

setLayout

public void setLayout(int layout)

イメージを配置するためのレイアウト指定を設定します。

パラメータ:

layout - レイアウトを指定する定数を組み合わせた値を渡します。

例外:

IllegalArgumentException - 指定されたレイアウトが不正な場合に throw します。

setLabel

public void setLabel(String label)

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

オーバーライド:

クラス Item 内の setLabel

パラメータ:

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