PictureLight (DoJa 3.5 (オプションAPIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

概要: 入れ子 | フィールド | コンストラクタ | メソッド

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

com.nttdocomo.opt.device
クラス PictureLight

Object
  |
  +--com.nttdocomo.opt.device.PictureLight

public class PictureLight
extends Object

ピクチャーライトを定義します。通常の発光と、一定時間の高輝度発光が可能です。高輝度発光を行うと、次に高輝度発光を行うまでにしばらく時間が必要で、その間は高輝度発光を行おうとしても高輝度発光されません。

導入されたバージョン:: DoJa-3.0

フィールドの概要

static int FLASH_LONG
           高輝度発光時間の一つで、長い時間を表します(=3)。

static int FLASH_MIDDLE
           高輝度発光時間の一つで、中程度の時間を表します(=2)。

static int FLASH_SHORT
           高輝度発光時間の一つで、短い時間を表します(=1)。

コンストラクタの概要

protected PictureLight()
           アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの概要

void flash()
           高輝度発光を行います。

int getColor()
           ピクチャーライトの色を取得します。

static PictureLight getPictureLight()
           ピクチャーライトオブジェクトを取得します。

int getTime()
           高輝度発光時間を取得します。

boolean isFlashBusy()
           高輝度発光の状態を取得します。

boolean isLightOn()
           ピクチャーライトの点灯状態を取得します。

void light(boolean b)
           ピクチャーライトの点灯状態を設定します。

void setColor(int color)
           ピクチャーライトの色を設定します。

void setTime(int time)
           高輝度発光時間を設定します。

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

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

フィールドの詳細

FLASH_SHORT

public static final int FLASH_SHORT

高輝度発光時間の一つで、短い時間を表します(=1)。

関連項目:: 定数フィールド値

FLASH_MIDDLE

public static final int FLASH_MIDDLE

高輝度発光時間の一つで、中程度の時間を表します(=2)。

関連項目:: 定数フィールド値

FLASH_LONG

public static final int FLASH_LONG

高輝度発光時間の一つで、長い時間を表します(=3)。

関連項目:: 定数フィールド値

コンストラクタの詳細

PictureLight

protected PictureLight()

アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの詳細

getPictureLight

public static PictureLight getPictureLight()

ピクチャーライトオブジェクトを取得します。デフォルトでは、色は白色(Graphics.getColorOfRGB(255,255,255)の値)、高輝度発行時間は中程度(FLASH_MIDDLE)に設定されています。

戻り値:: ピクチャーライトオブジェクトを返します。端末がピクチャーライトを持たない場合はnullを返します。

light

public void light(boolean b)

ピクチャーライトの点灯状態を設定します。
点灯状態や高輝度発光状態の時に点灯しようとしたり、消灯状態のときに消灯しようとしても何も起こりません。高輝度発光状態の時に消灯しようとした場合は高輝度発光を中止して消灯します。

パラメータ:: b - ピクチャーライトを点灯する場合はtrueを、消灯する場合はfalseを指定します。

isLightOn

public boolean isLightOn()

ピクチャーライトの点灯状態を取得します。

戻り値:: ピクチャーライトが点灯または高輝度発光している場合は trueを、そうでない場合は false を返します。

setColor

public void setColor(int color)

ピクチャーライトの色を設定します。設定した色に最も近い色で点灯します。色は Graphics.getColorOfRGB() メソッドで取得した値を指定します。
点灯中に色を設定した場合は色が変化します。高輝度発光中に設定した場合は無視されます。

パラメータ:: color - ピクチャーライトの色を指定します。
例外:: IllegalArgumentException - 引数 color に不正な値が指定された場合に発生します。

getColor

public int getColor()

ピクチャーライトの色を取得します。 setColor(int)メソッドで指定された値を返します。

戻り値:: ピクチャーライトの色を返します。

flash

public void flash()

高輝度発光を行います。設定された色で、指定された時間の間、高輝度発光を行います。
ピクチャーライトが消灯中に呼ばれた場合は、点灯状態にした後に高輝度発光を行います。高輝度発光中、あるいは、高輝度発光後に次に高輝度発光を行うことが可能になるまでの間はこのメソッドを呼び出しても何も行いません。高輝度発光が可能かどうかはisFlashBusy()メソッドで取得することができます。

isFlashBusy

public boolean isFlashBusy()

高輝度発光の状態を取得します。高輝度発光を行うと次に高輝度発光を行うまでにしばらく時間が必要で、まだ次の発光ができない場合は true が返ります。次の発光が可能になった場合は false が返ります。
消灯中に呼ばれた場合も false が返ります。

戻り値:: 高輝度発光の状態を返します。

setTime

public void setTime(int time)

高輝度発光時間を設定します。値は FLASH_SHORT, FLASH_MIDDLE, FLASH_LONG のいずれかです。具体的な発光時間は機種依存です。
高輝度発光中に設定した場合は無視されます。

パラメータ:: time - 高輝度発光時間を指定します。
例外:: IllegalArgumentException - 引数 time に不正な値が指定された場合に発生します。

getTime

public int getTime()

高輝度発光時間を取得します。値は FLASH_SHORT, FLASH_MIDDLE, FLASH_LONG のいずれかです。

戻り値:: 高輝度発光時間を返します。

概要