Canvas (Star-1.2 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

com.docomostar.ui
クラス Canvas

Object
  com.docomostar.ui.Frame
      com.docomostar.ui.Canvas

public abstract class Canvas
extends Frame

低レベルAPIのための表示面を定義します。キャンバスクラスは、低レベル API で使用するフレームクラスです。キャンバスは、スクロール機能を持ちません。

このキャンバスに対して、初めて Display.setCurrent(Frame) メソッドが実行された場合、 init(Graphics) メソッド、及び paint(Graphics) メソッドがコールバックされます。二回目以降に Display.setCurrent(Frame) メソッドが実行された場合は、init(Graphics) メソッドはコールバックされず、 paint(Graphics) メソッドのみコールバックされます。

導入されたバージョン:: Star-1.0
関連項目:: Panel, Dialog

フィールドの概要

static int ALPHA
          IME 起動において、初期入力モードをアルファベット入力モードにすることを表します (=1)。

static int DISPLAY_ANY
          IME 起動において、表示文字列をそのまま表示するモードにすることを表します (=0)。

static int DISPLAY_PASSWORD
          IME 起動において、文字列を隠蔽して表示するモード (パスワード入力用の表示モード) にすることを表します (=1)。

static int HANGUL [iアプリオプションAPI]
          IME 起動において、初期入力モードを韓国語(ハングル文字)入力モードにすることを表します (=6)。

static int IME_CANCELED
          IMEイベントの通知において、入力がキャンセルされたことを表します(=1)。

static int IME_COMMITTED
          IMEイベントの通知において、入力が確定したことを表します(=0)。

static int KANA
          IME 起動において、初期入力モードをかな漢字入力モードにすることを表します (=2)。

static int NUMBER
          IME 起動において、初期入力モードを数字入力モードにすることを表します (=0)。

static int PORTUGUESE [iアプリオプションAPI]
          IME 起動において、初期入力モードをポルトガル語入力モードにすることを表します (=7)。

static int SIMPLIFIED_HANZI [iアプリオプションAPI]
          IME 起動において、初期入力モードを中国語(簡体字)入力モードにすることを表します (=4)。

static int TRADITIONAL_HANZI [iアプリオプションAPI]
          IME 起動において、初期入力モードを中国語(繁体字)入力モードにすることを表します (=3)。

クラス com.docomostar.ui.Frame から継承したフィールド

ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT, ARROW_UP, SELECT_KEY, SOFT_KEY_1, SOFT_KEY_2, SOFT_KEY_3, SOFT_KEY_4

コンストラクタの概要

Canvas()
          キャンバスオブジェクトを生成します。

メソッドの概要

Graphics getGraphics()
          キャンバスに描画するためのグラフィクスオブジェクトを取得します。

int getKeypadState()
          キーパッド状態を返すメソッドです。

int getKeypadState(int group) [iアプリオプションAPI]
           キーのグループを指定してキーパッド状態を取得します。

void imeOn(String text, int displayMode, int inputMode)
           キャンバスにおいてIMEを起動します。

void imeOn(String text, int displayMode, int inputMode, int inputSize) [iアプリオプションAPI]
          キャンバスにおいて、入力可能な文字数を制限して IME を起動します。

void init(Graphics g)
          キャンバスが初めてカレントに設定されるタイミングで一度だけ呼び出されるメソッドです。

abstract void paint(Graphics g)
          キャンバスに表示するために使用するメソッドです。

void processEvent(int type, int param)
          低レベルイベントが通知されたときに呼ばれるメソッドです。

void processIMEEvent(int type, String text)
          IMEイベントが通知されたときに呼ばれるメソッドです。

void repaint()
          キャンバス全体を再描画することを指示します。

void repaint(int x, int y, int width, int height)
           キャンバスの一部の矩形領域を再描画することを指示します。

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

getHeight, getWidth, setBackground, setSoftArrowLabel, setSoftLabel, setSoftLabelVisible

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

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

フィールドの詳細

IME_COMMITTED

public static final int IME_COMMITTED

IMEイベントの通知において、入力が確定したことを表します(=0)。
processIMEEvent メソッドのtype引数として使用されます。

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

IME_CANCELED

public static final int IME_CANCELED

IMEイベントの通知において、入力がキャンセルされたことを表します(=1)。
processIMEEvent メソッドのtype引数として使用されます。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

NUMBER

public static final int NUMBER

IME 起動において、初期入力モードを数字入力モードにすることを表します (=0)。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

ALPHA

public static final int ALPHA

IME 起動において、初期入力モードをアルファベット入力モードにすることを表します (=1)。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

KANA

public static final int KANA

IME 起動において、初期入力モードをかな漢字入力モードにすることを表します (=2)。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

TRADITIONAL_HANZI

public static final int TRADITIONAL_HANZI [iアプリオプションAPI]

IME 起動において、初期入力モードを中国語(繁体字)入力モードにすることを表します (=3)。
端末によってはサポートされない場合があります。

導入されたバージョン:: Star-1.2
関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

SIMPLIFIED_HANZI

public static final int SIMPLIFIED_HANZI [iアプリオプションAPI]

IME 起動において、初期入力モードを中国語(簡体字)入力モードにすることを表します (=4)。
端末によってはサポートされない場合があります。

導入されたバージョン:: Star-1.2
関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

HANGUL

public static final int HANGUL [iアプリオプションAPI]

IME 起動において、初期入力モードを韓国語(ハングル文字)入力モードにすることを表します (=6)。
端末によってはサポートされない場合があります。

導入されたバージョン:: Star-1.2
関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

PORTUGUESE

public static final int PORTUGUESE [iアプリオプションAPI]

IME 起動において、初期入力モードをポルトガル語入力モードにすることを表します (=7)。
端末によってはサポートされない場合があります。

導入されたバージョン:: Star-1.2
関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

DISPLAY_ANY

public static final int DISPLAY_ANY

IME 起動において、表示文字列をそのまま表示するモードにすることを表します (=0)。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

DISPLAY_PASSWORD

public static final int DISPLAY_PASSWORD

IME 起動において、文字列を隠蔽して表示するモード (パスワード入力用の表示モード) にすることを表します (=1)。

入力可能な文字種は、ブラウザにおけるパスワード入力用テキストボックスと同様です。

関連項目:: imeOn(String, int, int), imeOn(String, int, int, int), 定数フィールド値

コンストラクタの詳細

Canvas

public Canvas()

キャンバスオブジェクトを生成します。

メソッドの詳細

getGraphics

public Graphics getGraphics()

キャンバスに描画するためのグラフィクスオブジェクトを取得します。取得されたグラフィクスオブジェクトは初期状態になっています。 getGraphicsメソッドを呼び出すたびに新しいオブジェクトを生成して返します。

戻り値:: キャンバスに描画するためのグラフィクスオブジェクトを返します。

init

public void init(Graphics g)

キャンバスが初めてカレントに設定されるタイミングで一度だけ呼び出されるメソッドです。 paint(Graphics) メソッドの引数に渡される Graphics オブジェクトを初期化するために使用してください。

このメソッドは、オーバーライドしていない状態では何も処理を行いません。初期化処理を行う場合は、このメソッドをオーバーライドしてください。

引数で渡される Graphics オブジェクトは paint(Graphics) メソッドの引数と同一のオブジェクトです。

このメソッドと paint(Graphics) メソッドが同時にコールバックされることはありません。 Canvas が初めて Display.setCurrent(Frame) メソッドの引数に設定された場合、最初に init メソッドがコールバックされ、init メソッドの終了後に paint(Graphics) メソッドがコールバックされます。

パラメータ:: g - 描画に使用する Graphics オブジェクトが渡されます。
関連項目:: paint(Graphics), Display.setCurrent(Frame)

paint

public abstract void paint(Graphics g)

キャンバスに表示するために使用するメソッドです。このメソッドは、キャンバスが表示されるタイミングで呼び出されます。

引数で渡される Graphics オブジェクトには、毎回同一のオブジェクトが渡されます。渡されるオブジェクトは、init(Graphics g) メソッドの引数 g と同一のオブジェクトです。

パラメータ:: g - 描画に使用する Graphics オブジェクトが渡されます。
関連項目:: init(Graphics)

repaint

public void repaint()

キャンバス全体を再描画することを指示します。

repaint

public void repaint(int x,
                    int y,
                    int width,
                    int height)

キャンバスの一部の矩形領域を再描画することを指示します。再描画対象となる領域は、(x, y)-(x + width, y + height) で構成される矩形の内部領域(幅 width、高さ height)です。

このメソッドで指定する座標の考え方については Graphics クラスの説明を参照して下さい。

パラメータ:: x - 矩形の左上のX座標を指定します。; y - 矩形の左上のY座標を指定します。; width - 矩形の幅を指定します。; height - 矩形の高さを指定します。
例外:: IllegalArgumentException -
引数 width, height のどちらかまたは両方に 0 未満の値が指定された場合に発生します。

processEvent

public void processEvent(int type,
                         int param)

低レベルイベントが通知されたときに呼ばれるメソッドです。

パラメータ:: type - イベントのタイプが渡されます。; param - イベントのパラメータが渡されます。パラメータの意味はイベントによって異なります。パラメータを持たないイベントの場合は、0が渡されます。

getKeypadState

public int getKeypadState()

キーパッド状態を返すメソッドです。

getKeypadState(0) を呼び出したのと同じ振る舞いをします。

戻り値:: キーパッド状態を返します。

getKeypadState

public int getKeypadState(int group) [iアプリオプションAPI]

キーのグループを指定してキーパッド状態を取得します。 Display クラスで定義されるキーについて、それぞれ (キーの値 >> 5) がグループとなります。このメソッドでは、引数で指定されたグループに含まれるキー(最大 32 個)の状態を取得します。

戻り値の各ビットの位置がDisplayクラスで定義されているキーに対応します。ビットとキーの対応は、(1 << (キーの値 - グループ * 32)) となり、 MSBが (31 + グループ * 32) で、LSBが (0 + グループ * 32) に対応します。
例えば、グループ 0 を指定した場合、 KEY_0 に対応するビットは b0、KEY_1 に対応するビットは b1、KEY_SELECT に対応するビットは b20 になります。また、グループ 1 を指定した場合、 KEY_CLEAR に対応するビットは b0、KEY_MAIL に対応するビットは b1、KEY_SUB1 に対応するビットは b18 になります。

  b31                           b2  b1  b0
 +---+---+-------------||------+---+---+---+
 |   |   |                     |   |   |   |
 +---+---+-------------||------+---+---+---+

押された状態になっているキーに対応するビットは1に、押されていない状態になっているキーに対応するビットは0になっています。

アプリケーションプログラマは、タイマドリブンの処理中でこのメソッドを呼ぶか、 Display.KEY_PRESSED_EVENT, Display.KEY_RELEASED_EVENTのイベントが発生したときにこのメソッドを呼ぶかして、複数のキーの状態を取得します。
なお、デフォルトで有効となっていないキーのグループについては PhoneSystem.DEV_KEYPAD 属性を設定しないと Display.KEY_PRESSED_EVENT, Display.KEY_RELEASED_EVENTのイベントも発生しませんし、このメソッドによるキーパッド状態の取得も行うことができません。

キャンバスが表示されている、いないに関わらず、このメソッドを呼び出した場合、現在のキーパッドの状態が戻り値として返されます。

パラメータ:: group - キーパッド状態を取得するキーのグループを指定します。
戻り値:: キーパッド状態を返します。
関連項目:: PhoneSystem.DEV_KEYPAD
例外:: IllegalArgumentException -
引数 group に 0 未満の値が指定された場合に発生します。

imeOn

public void imeOn(String text,
                  int displayMode,
                  int inputMode)

キャンバスにおいてIMEを起動します。

このメソッドはブロックしないメソッドです。 IMEでの入力が完了するまで待つことはありません。 IMEでの入力が完了すると(キャンセルも含みます)、 processIMEEvent メソッドが呼ばれます。

このキャンバスがカレントフレームでない場合には、このメソッドの呼び出しは無視され、例外も発生しません。ダイアログが表示されている場合も同様です。

[Star-1.2 以降]
以下のいずれの場合においても、例外が発生することはありません。 IME が起動可能な別の初期入力モードで IME が起動します。ただし、IME がどの入力モードで起動するかは機種依存です。

端末がサポートしていない初期入力モードが指定された場合
マルチリンガル言語入力機能をサポートしている端末において、マルチリンガル言語入力機能設定が OFF であり、かつ、 NUMBER、ALPHA、KANA 以外の IME が起動可能な初期入力モードを指定した場合

パラメータ:

text - IMEに渡す初期文字列を指定します。 nullの場合、空文字列("")として扱われます。

displayMode - 文字列の表示モードを指定します。 DISPLAY_ANY またはDISPLAY_PASSWORD を指定します。

inputMode - 初期入力モードを指定します。次のいずれかを指定します。

NUMBER、ALPHA、KANA
[Star-1.2 以降]TRADITIONAL_HANZI、 SIMPLIFIED_HANZI、HANGUL、PORTUGUESE

例外:

IllegalStateException -
ミニアプリ実行時の Focused または Unfocused 状態で呼び出された場合に発生します。

IllegalArgumentException -
引数 displayMode、inputMode に不正な値が指定された場合に発生します。

UIException -
(BUSY_RESOURCE)
既にIMEが起動されている場合に発生します。

imeOn

public void imeOn(String text,
                  int displayMode,
                  int inputMode,
                  int inputSize) [iアプリオプションAPI]

キャンバスにおいて、入力可能な文字数を制限して IME を起動します。

このメソッドの振る舞いは、 IME に対してユーザが入力可能な文字数を制限できること以外は、 imeOn(String, int, int) の振る舞いと同じです。

入力文字数の制限値には半角文字数に換算した値を指定します。実装がサポートしている最大文字数より大きい値を指定した場合、最大文字数が指定されたことになります。

端末によっては、このメソッドをサポートしていない場合があります。その場合には、例外 UnsupportedOperationException が発生します。

パラメータ:

text - IMEに渡す初期文字列を指定します。 nullの場合、空文字列("")として扱われます。

displayMode - 文字列の表示モードを指定します。 DISPLAY_ANY またはDISPLAY_PASSWORD を指定します。

inputMode - 初期入力モードを指定します。次のいずれかを指定します。

NUMBER、ALPHA、KANA
[Star-1.2 以降]TRADITIONAL_HANZI、 SIMPLIFIED_HANZI、HANGUL、PORTUGUESE

inputSize - 入力文字数の制限値を指定します。

例外:

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

IllegalStateException -
ミニアプリ実行時の Focused または Unfocused 状態で呼び出された場合に発生します。

IllegalArgumentException -
引数 displayMode、inputMode に不正な値が指定された場合に発生します。

IllegalArgumentException -
引数 inputSize に 0 以下の値が指定された場合に発生します。

IllegalArgumentException -
引数 inputSize に指定された値が、引数 text に指定された文字列の文字数よりも小さい場合に発生します。

UIException -
(BUSY_RESOURCE)
既にIMEが起動されている場合に発生します。

processIMEEvent

public void processIMEEvent(int type,
                            String text)

IMEイベントが通知されたときに呼ばれるメソッドです。

このメソッドはimeOn メソッドにより起動されたIMEへの入力が確定した場合、またはキャンセルされた場合に呼び出されます。

入力がキャンセルされた場合には、引数 text はimeOnメソッドで渡した文字列です。 null を渡した場合、nullが返ります。入力が確定された場合には、引数 text に入力された文字列が返ります。何も入力されなかった場合、空文字列("")が渡されます。

パラメータ:: type - イベントのタイプが渡されます。; text - 入力された文字列が渡されます。

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ（その他に許諾者がある場合は当該許諾者も含めて）の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「ｉモード」、「ｉアプリ／アイアプリ」、「ｉ-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。

フィールドの概要
`static int`	`ALPHA` IME 起動において、初期入力モードをアルファベット入力モードにすることを表します (=1)。
`static int`	`DISPLAY_ANY` IME 起動において、表示文字列をそのまま表示するモードにすることを表します (=0)。
`static int`	`DISPLAY_PASSWORD` IME 起動において、文字列を隠蔽して表示するモード (パスワード入力用の表示モード) にすることを表します (=1)。
`static int`	`HANGUL [iアプリオプションAPI]` IME 起動において、初期入力モードを韓国語(ハングル文字)入力モードにすることを表します (=6)。
`static int`	`IME_CANCELED` IMEイベントの通知において、入力がキャンセルされたことを表します(=1)。
`static int`	`IME_COMMITTED` IMEイベントの通知において、入力が確定したことを表します(=0)。
`static int`	`KANA` IME 起動において、初期入力モードをかな漢字入力モードにすることを表します (=2)。
`static int`	`NUMBER` IME 起動において、初期入力モードを数字入力モードにすることを表します (=0)。
`static int`	`PORTUGUESE [iアプリオプションAPI]` IME 起動において、初期入力モードをポルトガル語入力モードにすることを表します (=7)。
`static int`	`SIMPLIFIED_HANZI [iアプリオプションAPI]` IME 起動において、初期入力モードを中国語(簡体字)入力モードにすることを表します (=4)。
`static int`	`TRADITIONAL_HANZI [iアプリオプションAPI]` IME 起動において、初期入力モードを中国語(繁体字)入力モードにすることを表します (=3)。

コンストラクタの概要
`Canvas()` キャンバスオブジェクトを生成します。

メソッドの概要
`Graphics`	`getGraphics()` キャンバスに描画するためのグラフィクスオブジェクトを取得します。
`int`	`getKeypadState()` キーパッド状態を返すメソッドです。
`int`	`getKeypadState(int group) [iアプリオプションAPI]` キーのグループを指定してキーパッド状態を取得します。
`void`	`imeOn(String text, int displayMode, int inputMode)` キャンバスにおいてIMEを起動します。
`void`	`imeOn(String text, int displayMode, int inputMode, int inputSize) [iアプリオプションAPI]` キャンバスにおいて、入力可能な文字数を制限して IME を起動します。
`void`	`init(Graphics g)` キャンバスが初めてカレントに設定されるタイミングで一度だけ呼び出されるメソッドです。
`abstract void`	`paint(Graphics g)` キャンバスに表示するために使用するメソッドです。
`void`	`processEvent(int type, int param)` 低レベルイベントが通知されたときに呼ばれるメソッドです。
`void`	`processIMEEvent(int type, String text)` IMEイベントが通知されたときに呼ばれるメソッドです。
`void`	`repaint()` キャンバス全体を再描画することを指示します。
`void`	`repaint(int x, int y, int width, int height)` キャンバスの一部の矩形領域を再描画することを指示します。

com.docomostar.ui クラス Canvas

IME_COMMITTED

IME_CANCELED

NUMBER

ALPHA

KANA

TRADITIONAL_HANZI

SIMPLIFIED_HANZI

HANGUL

PORTUGUESE

DISPLAY_ANY

DISPLAY_PASSWORD

Canvas

getGraphics

init

paint

repaint

repaint

processEvent

getKeypadState

getKeypadState

imeOn

imeOn

processIMEEvent

com.docomostar.ui
クラス Canvas