iモード対応Java API: クラス VisualPresenter

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.nttdocomo.ui
クラス VisualPresenter

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

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

public class VisualPresenter
extends Component
implements MediaPresenter

表示可能なメディアデータの再生オブジェクトを定義します。メディア再生コンポーネントクラスは、スクリーンに表示するメディアデータを再生するための高レベル API のコンポーネントです。リスナを登録することによって、表示の状態の通知を受けることができます。端末で再生できないようなメディアデータをセットした場合の振舞は機種依存で、機種によっては UIException が発生する場合があります。属性の設定は、setAttribute メソッドを使用します。イメージを表示する位置を指定するために IMAGE_XPOS 、IMAGE_YPOS 属性を使用することができます。イメージ上のIMAGE_XPOS, IMAGE_YPOS で指定された位置がプレゼンタの左上角に来るように表示されます。アプリケーションプログラムでは、この値を変更することでイメージをスクロール表示することができます。

 		   IMAGE_XPOS

              +---+--------------+

              |                  |<-Image (MediaImage)

   IMAGE_YPOS +   +------------+ |

              |   | Visual     | |

              |   | Presenter  | |

              |   |            | |

              |   +------------+ |

              |                  |

              +------------------+

setData メソッドと setImage メソッドは、1 つのプレゼンタオブジェクトに対して排他的に使用します。 setData メソッドでデータを設定してからsetImage メソッドでイメージデータを設定したり、その逆をすることはできません。同じメソッドを複数回呼出した場合は、最後に設定したデータが有効になります。

ミニマムスペック

ミニマムスペックでは、リスナの起動はしません。
ミニマムスペックでは、setData メソッドを発行するとUnsupportedOperationException が発生します。

関連項目:: AudioPresenter

フィールドの概要

static int IMAGE_XPOS
          イメージを表示する位置(X 座標)を示す属性です(=1)。

static int IMAGE_YPOS
          イメージを表示する位置(Y 座標)を示す属性です(=2)。

protected static int MAX_VENDOR_ATTR
          ベンダ定義属性の種類の最大値(=127)。

protected static int MAX_VENDOR_VISUAL_EVENT
          ベンダ定義のイベントの最大値(=127)。

protected static int MIN_VENDOR_ATTR
          ベンダ定義属性の種類の最少値(=64)。

protected static int MIN_VENDOR_VISUAL_EVENT
          ベンダ定義のイベントの最少値(=64)。

static int VISUAL_COMPLETE
          再生が終了したことを示すイベントタイプです (=3)。

static int VISUAL_PLAYING
          再生が開始されたことを示すイベントタイプです (=1)。

static int VISUAL_STOPPED
          再生が中断されたことを示すイベントタイプです (=2)。

コンストラクタの概要

VisualPresenter()
          空のプレゼンタオブジェクトを生成します。

メソッドの概要

MediaResource getMediaResource()
          現在セットされているメディアリソースを取得します。

void play()
          メディアデータの再生を開始します。

void setAttribute(int attr, int value)
          再生方法に関する属性を設定します。

void setData(MediaData data)
          メディアデータをセットします。

void setImage(MediaImage image)
          メディアイメージをセットします。

void setMediaListener(MediaListener listener)
          リスナを登録します。

void stop()
          メディアデータの再生を停止します。

クラス 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

フィールドの詳細

VISUAL_PLAYING

public static final int VISUAL_PLAYING

再生が開始されたことを示すイベントタイプです (=1)。

VISUAL_STOPPED

public static final int VISUAL_STOPPED

再生が中断されたことを示すイベントタイプです (=2)。

VISUAL_COMPLETE

public static final int VISUAL_COMPLETE

再生が終了したことを示すイベントタイプです (=3)。ループ型メディアデータの場合は、1 回分のループ終了ごとにこのイベントが発生します。

IMAGE_XPOS

public static final int IMAGE_XPOS

イメージを表示する位置(X 座標)を示す属性です(=1)。

IMAGE_YPOS

public static final int IMAGE_YPOS

イメージを表示する位置(Y 座標)を示す属性です(=2)。

MIN_VENDOR_ATTR

protected static final int MIN_VENDOR_ATTR

ベンダ定義属性の種類の最少値(=64)。ベンダ定義の属性を定義する場合は、 MIN_VENDOR_ATTR から、 MAX_VENDOR_ATTR までの値を使用しなければなりません。

MAX_VENDOR_ATTR

protected static final int MAX_VENDOR_ATTR

ベンダ定義属性の種類の最大値(=127)。ベンダ定義の属性を定義する場合は、 MIN_VENDOR_ATTR から、 MAX_VENDOR_ATTR までの値を使用しなければなりません。

MIN_VENDOR_VISUAL_EVENT

protected static final int MIN_VENDOR_VISUAL_EVENT

ベンダ定義のイベントの最少値(=64)。ベンダ定義のイベントを定義する場合は、 MIN_VENDOR_VISUAL_EVENT から、 MAX_VENDOR_VISUAL_EVENT までの値を使用しなければなりません。

MAX_VENDOR_VISUAL_EVENT

protected static final int MAX_VENDOR_VISUAL_EVENT

ベンダ定義のイベントの最大値(=127)。ベンダ定義のイベントを定義する場合は、 MIN_VENDOR_VISUAL_EVENT から、 MAX_VENDOR_VISUAL_EVENT までの値を使用しなければなりません。

コンストラクタの詳細

VisualPresenter

public VisualPresenter()

空のプレゼンタオブジェクトを生成します。

メソッドの詳細

setImage

public void setImage(MediaImage image)

メディアイメージをセットします。

パラメータ:: image - メディアイメージを指定します。
例外:: UIException - 端末で再生できないようなメディアデータをセットした場合に発生する場合があります (UNSUPPORTED_FORMAT)。また、再生中に、このメソッドを呼び出そうとしたときに発生します(ILLEGAL_STATE)。

setData

public void setData(MediaData data)

メディアデータをセットします。

定義:: インタフェース MediaPresenter 内の setData

パラメータ:: data - メディアデータを指定します。
例外:: UIException - 端末で再生できないようなメディアデータをセットした場合に発生する場合があります (UNSUPPORTED_FORMAT)。また、再生中に、このメソッドを呼び出そうとしたときに発生します(ILLEGAL_STATE)。

getMediaResource

public MediaResource getMediaResource()

現在セットされているメディアリソースを取得します。

定義:: インタフェース MediaPresenter 内の getMediaResource

戻り値:: メディアリソースを返します。

play

public void play()

メディアデータの再生を開始します。データを最後まで再生したら自動的に停止します。プレゼンタが実際に表示される前にplay メソッドが呼び出された場合、実際にプレゼンタが表示されてからメディアデータの再生が開始されます。再生中に、play メソッドが呼ばれた場合、 stop メソッドが呼ばれてから再び再生を開始します。

定義:: インタフェース MediaPresenter 内の play

stop

public void stop()

メディアデータの再生を停止します。停止しているときに、stop メソッドが呼ばれた場合、何もしません。

定義:: インタフェース MediaPresenter 内の stop

setAttribute

public void setAttribute(int attr,
                         int value)

再生方法に関する属性を設定します。

定義:: インタフェース MediaPresenter 内の setAttribute

パラメータ:: sttr - 設定する属性の種類を指定します。; value - 設定する属性の値を指定します。

setMediaListener

public void setMediaListener(MediaListener listener)

リスナを登録します。プレゼンタに登録できるリスナは1 つだけです。このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。リスナオブジェクトとして null を指定すると、リスナの登録を削除します。

定義:: インタフェース MediaPresenter 内の setMediaListener

パラメータ:: listener - 登録するリスナ

概要