javax.microedition.lcdui
クラス ImageItem

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

public class ImageItem
extends Item

イメージを格納することができる Item です。

それぞれの ImageItem オブジェクトは Image への参照を含みます。 この Image は不変タイプでも可変タイプでもかまいません。 Image が可変タイプならば、ImageItem は setImage の呼び出しによって渡された Image の内容のスナップショットを生成するという結果をもたらします。 ImageItem が表示される際は常にこのスナップショットを使用します。 その後アプリケーションが Image に描画を行ったとしても、スナップショットは次の setImage の呼び出しまで変更しません。 ImageItem のコンテナがカレントの表示対象になるか、または目に見えるようになる時にスナップショットをアップデートしません（これは各 Displayable と各 Item がディスプレイに表示されたり非表示になったりする際に、アプリケーションが正確に制御することができないためです）。

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

ImageItem はオリジナルの定義を MIDP 1.0 に持つレイアウト指示を含みます。 これらのレイアウト指示は Item クラスへ移動し、現在は全ての Item に適用されています。宣言は ImageItem の後方互換性を維持する目的で残されています。

イメージが表示キャパシティを超える時に、イメージに代わって表示する文字列を altText パラメータで指定します。 altText パラメータは null であることがあります。

導入されたバージョン:

MIDP 1.0

LAYOUT_DEFAULT

public static final int LAYOUT_DEFAULT

Item.LAYOUT_DEFAULT を参照してください。

LAYOUT_DEFAULT には値として 0 が割り当てられています。

関連項目:

定数フィールド値

LAYOUT_LEFT

public static final int LAYOUT_LEFT

Item.LAYOUT_LEFT を参照してください。

LAYOUT_LEFT には値として 1 が割り当てられています。

関連項目:

定数フィールド値

LAYOUT_RIGHT

public static final int LAYOUT_RIGHT

Item.LAYOUT_RIGHT を参照してください。

LAYOUT_RIGHT には値として 2 が割り当てられています。

関連項目:

定数フィールド値

LAYOUT_CENTER

public static final int LAYOUT_CENTER

Item.LAYOUT_CENTER を参照してください。

LAYOUT_CENTER には値として 3 が割り当てられています。

関連項目:

定数フィールド値

LAYOUT_NEWLINE_BEFORE

public static final int LAYOUT_NEWLINE_BEFORE

Item.LAYOUT_NEWLINE_BEFORE を参照してください。

LAYOUT_NEWLINE_BEFORE には値として 0x100 が割り当てられています。

関連項目:

定数フィールド値

LAYOUT_NEWLINE_AFTER

public static final int LAYOUT_NEWLINE_AFTER

Item.LAYOUT_NEWLINE_AFTER を参照してください。

LAYOUT_NEWLINE_AFTER には値として 0x200 が割り当てられています。

関連項目:

定数フィールド値

ImageItem

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

指定されたラベル、イメージ、レイアウト指定、代替テキスト文字列を受け取って新しい ImageItem を作成します。 このコンストラクタを呼び出すのは以下と記述と等価です。

     ImageItem(label, image, layout, altText, PLAIN);

パラメータ:

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

img - 不変タイプあるいは可変タイプのイメージを渡します。

layout - layout による指定が不正な場合に throw します。

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

例外:

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

ImageItem

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

指定されたラベル、イメージ、レイアウト指定、代替テキスト文字列を受け取って新しい ImageItem を作成します。 ラベルまたは大体テキスト文字列は提供されるか null かもしれません。

appearanceMode（外観モードを参照）は、この ImageItem に対するアプリケーションが意図する用途のプラットホームへのヒントです。 アプリケーションは、ハイパーリンクやボタンのような振る舞いを提供するために、デフォルト Command をこの ImageItem に関連付け、ItemCommandListener をこの ImageItem に加えるべきです。

以下にボタンとして ImageItem を用いる例を示します。

     ImageItem imgItem = 
         new ImageItem("Default: ", img,     
                       Item.LAYOUT_CENTER, null,    
                       Item.BUTTON);
     imgItem.setDefaultCommand(
         new Command("Set", Command.ITEM, 1);
     // icl は ItemCommandListener です
     imgItem.setItemCommandListener(icl);

パラメータ:

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

img - 不変タイプあるいは可変タイプのイメージを渡します。

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

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

appearanceMode - ImageItem の外観モード（Item.PLAIN、Item.HYPERLINK、または Item.BUTTON のいずれか１つ）を渡します。

例外:

IllegalArgumentException - appearanceMode が不正あるいは layout による指定が不正な場合に throw します。

導入されたバージョン:

MIDP 2.0

getImage

public Image getImage()

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

戻り値:

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

setImage

public void setImage(Image img)

ImageItem に入れる Image オブジェクトを設定します。 イメージは可変タイプあるいは不変タイプのいずれでもかまいません。 img が null ならば、ImageItem は空に設定します。 img が可変タイプなら、setImage の呼び出しによって渡された img の内容のスナップショットを生成するという結果をもたらします。 ImageItem が表示される際は常にこのスナップショットを使用します。 img がすでにこの ImageItem の Image であるなら、img の内容の新しいスナップショットを生成するという結果をもたらします。 したがって、ImageItem に格納した可変タイプのイメージに描画を行った後、アプリケーションは以下の呼び出しを行うことができます。

     imageItem.setImage(imageItem.getImage());

Image に関する ImageItem のスナップショットをリフレッシュをすることができます。

ImageItem がディスプレイに表示されている時に setImage が呼び出されてスナップショットが更新されるなら、実装は可能になり次第すぐに新しいスナップショットで表示を更新します。

パラメータ:

img - この ImageItem のための Image、または Image がないことを示す null を渡します。

例外:

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

関連項目:

getImage()

getAltText

public String getAltText()

イメージがそれを表示するデバイスのキャパシティを超える場合に代わりに表示する文字列を返します。 代わりの文字列が設定されていない場合、null を返します。

戻り値:

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

関連項目:

setAltText(java.lang.String)

setAltText

public void setAltText(String altText)

イメージがそれを表示するデバイスのキャパシティを超える場合に代わりに表示する文字列を設定します。 代わりの文字列を提供しない場合は null を渡します。

パラメータ:

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

関連項目:

getAltText()

getLayout

public int getLayout()

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

オーバーライド:

クラス Item 内の getLayout

戻り値:

設定されているレイアウト指定の組み合わせ値を返します。

関連項目:

setLayout(int)

setLayout

public void setLayout(int layout)

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

オーバーライド:

クラス Item 内の setLayout

パラメータ:

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

例外:

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

関連項目:

getLayout()

getAppearanceMode

public int getAppearanceMode()

ImageItem の外観モードを返します。 外観モードを参照してください。

戻り値:

外観モード値（Item.PLAIN、Item.HYPERLINK、または Item.BUTTON のうち１つ）を返します。

導入されたバージョン:

MIDP 2.0