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 が発生します。

[DoJa-1.0]
ミニマムスペックでは、リスナの起動はしません。
[DoJa-2.0]
ミニマムスペックでは、VISUAL_COMPLETE、VISUAL_PLAYING、VISUAL_STOPPEDの各イベントタイプの イベントが発生することを保証します。
[DoJa-2.0]
アニメーションの再生中にアプリケーションがサスペンドした場合、 再生は一時停止して、アプリケーションがレジュームしたら再生を再開します。

関連項目:

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

フィールドの詳細

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 までの値を使用しなければなりません。

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回分のループ終了ごとに このイベントが発生します。

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 - 再生中にこのメソッドを呼び出そうとした場合に発生します(ILLEGAL_STATE)。

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

UIException - 引数 image に端末で再生できないようなメディアイメージが指定された場合に発生します(UNSUPPORTED_FORMAT)。

setData

public void setData(MediaData data)

メディアデータをセットします。
端末によってはサポートされない場合があります。

定義:

インタフェース MediaPresenter 内の setData

パラメータ:

data - メディアデータを指定します。

例外:

UnsupportedOperationException - 端末がこのメソッドをサポートしていない場合に発生します。

UIException - 再生中にこのメソッドを呼び出そうとした場合に発生します(ILLEGAL_STATE)。

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

UIException - 引数 data に端末で再生できないようなメディアデータが指定された場合に発生します(UNSUPPORTED_FORMAT)。

getMediaResource

public MediaResource getMediaResource()

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

定義:

インタフェース MediaPresenter 内の getMediaResource

戻り値:

メディアリソースを返します。

play

public void play()

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

定義:

インタフェース MediaPresenter 内の play

例外:

UIException - メディアデータがセットされていない場合や、メディアデータが再生可能な状態でない場合に発生します(ILLEGAL_STATE)。

UIException - [DoJa-2.1] 通話中に呼び出された場合に発生します(BUSY_RESOURCE)。

stop

public void stop()

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

定義:

インタフェース MediaPresenter 内の stop

例外:

UIException - メディアデータがセットされていない場合に発生します(ILLEGAL_STATE)。

setAttribute

public void setAttribute(int attr,
                         int value)

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

定義:

インタフェース MediaPresenter 内の setAttribute

パラメータ:

attr - 設定する属性の種類を指定します。

value - 設定する属性の値を指定します。

例外:

IllegalArgumentException - [DoJa-2.0] 引数 attr で指定された有効な属性に対して、引数 value に不正な値が指定された場合に発生します。

setMediaListener

public void setMediaListener(MediaListener listener)

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

定義:

インタフェース MediaPresenter 内の setMediaListener

パラメータ:

listener - 登録するリスナを指定します。