com.nttdocomo.ui
クラス ImageButton

java.lang.Object
  |
  +--com.nttdocomo.ui.Component
        |
        +--com.nttdocomo.ui.ImageButton

すべての実装インタフェース:

Interactable

public final class ImageButton

extends Component

implements Interactable

イメージをはりつけることができるボタンを定義します。 イメージボタンクラスは、高レベル API で使用する UI 部品の一つで、 静止画像を表示するプッシュボタンを表すコンポーネントです。 静止画像が設定されていないイメージラベルは、背景色で塗りつぶされます。

コンポーネントのサイズが指定されているとき、 イメージのサイズがコンポーネントのサイズより小さい場合、 イメージはコンポーネントの中央に表示されます。 また、コンポーネントのサイズがイメージのサイズより小さい場合、 イメージは左上からコンポーネントのサイズ分だけクリッピングして表示されます。

このクラスのインスタンスが生存している間、このインスタンスが参照しているImageクラスの インスタンスを利用不可能な状態にしてはいけません。すなわち、MediaImageのインスタンスから getImageメソッドでイメージオブジェクトをとりだした場合、ImageButtonのインスタンスの 使用がおわってから、unuseメソッド, disposeメソッドを呼び出してください。

 ...
 MediaImage img = MediaManager.getImage( ... );
 img.use();
 ImageButton button = new ImageButton(img.getImage());
 ...
 // buttonの使用が終了 
 img.unuse();
 img.dispose();
 ...

なお、設定されているImageクラスのインスタンスが保持するイメージが無効になっている場合、 イメージは描画されません。そのとき、ボタンは背景色で塗りつぶされます。

導入されたバージョン:

DoJa-2.0

関連項目:

Button, ImageLabel

コンストラクタの概要

ImageButton()
ラベル画像が空のイメージボタンを生成します。

ImageButton(Image image)
ラベル画像を指定してイメージボタンを生成します。

メソッドの概要

void	requestFocus() イメージボタンにフォーカスをセットするよう要求します。
void	setEnabled(boolean b) イメージボタンをユーザ操作可能にしたりユーザ操作不能にしたりします。
void	setImage(Image image) イメージボタンのラベル画像を設定します。

クラス com.nttdocomo.ui.Component から継承したメソッド

getHeight, getWidth, getX, getY, setBackground, setForeground, setLocation, setSize, setVisible

クラス java.lang.Object から継承したメソッド

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

コンストラクタの詳細

ImageButton

public ImageButton()

ラベル画像が空のイメージボタンを生成します。 生成時は、表示可能で、ユーザ操作可能になっています。 表示可能、表示不能を設定するには、setVisibleメソッドを使用します。 ユーザ操作可能、ユーザ操作不能を設定するには、setEnabledメソッドを使用します。

ImageButton

public ImageButton(Image image)

ラベル画像を指定してイメージボタンを生成します。 生成時は、表示可能で、ユーザ操作可能になっています。 表示可能、表示不能を設定するには、setVisibleメソッドを使用します。 ユーザ操作可能、ユーザ操作不能を設定するには、setEnabledメソッドを使用します。

パラメータ:

image - ラベル画像を指定します。

例外:

NullPointerException - 引数 image に null が指定された場合に発生します。

UIException - 引数 image に既に dispose されているイメージが指定された場合に発生します(ILLEGAL_STATE)。

メソッドの詳細

requestFocus

public void requestFocus()

イメージボタンにフォーカスをセットするよう要求します。 イメージボタンをaddメソッドでパネルに追加する以前に発行された要求は無視されます。

定義:

インタフェース Interactable 内の requestFocus

setEnabled

public void setEnabled(boolean b)

イメージボタンをユーザ操作可能にしたりユーザ操作不能にしたりします。 デフォルトではユーザ操作可能です。

定義:

インタフェース Interactable 内の setEnabled

パラメータ:

b - ユーザ操作可能にする場合は true を、ユーザ操作不能にする場合は false を指定します。

setImage

public void setImage(Image image)

イメージボタンのラベル画像を設定します。

パラメータ:

image - ラベル画像を指定します。

例外:

NullPointerException - 引数 image に null が指定された場合に発生します。

UIException - 引数 image に既に dispose されているイメージが指定された場合に発生します(ILLEGAL_STATE)。