com.nttdocomo.ui
クラス TextBox

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

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

Interactable

public final class TextBox

extends Component

implements Interactable

テキスト入力コンポーネントを定義します。 テキストボックスクラスは、 高レベル API で使用するUI部品の一つで、テキスト入力のためのコンポーネントです。

テキスト入力コンポーネントでは、表示行数が1行の場合と2行以上の場合で動作が異なります。

表示行数が1行の場合

表示行数が1行の場合は、縦スクロール表示しません。
[DoJa-1.0]

1行に文字列が表示しきれない場合、どのように表示するかは機種依存です。
[DoJa-2.0]

1行に文字列が表示しきれない場合、表示できない部分を切り捨てて表示します。

表示行数が2行以上の場合

表示行数が2行以上の場合は、文字列がその行数で表現しきれない場合、 縦スクロール表示になります。

フィールドの概要

static int	ALPHA 初期入力モードをアルファベット入力モードにすることを表します (=1)。
static int	DISPLAY_ANY 表示文字列をそのまま表示するモードにすることを表します (=0)。
static int	DISPLAY_PASSWORD 表示文字列を隠蔽するモード(パスワード入力モード)にすることを表します (=1)。
static int	KANA 初期入力モードをかな漢字入力モードにすることを表します (=2)。
static int	NUMBER 初期入力モードを数字入力モードにすることを表します (=0)。

コンストラクタの概要

TextBox(java.lang.String text, int columns, int rows, int mode)
初期文字列と桁数、行数、表示モードを指定してテキストボックスを生成します。

メソッドの概要

java.lang.String	getText() テキスト文字列を取得します。
void	requestFocus() テキストボックスにフォーカスをセットするよう要求します。
void	setEditable(boolean b) テキスト文字列を編集可能にするかどうかを設定します。
void	setEnabled(boolean b) テキストボックスをユーザ操作可能にしたりユーザ操作不能にしたりします。
void	setInputMode(int mode) テキスト文字列の初期入力モードを設定します。
void	setText(java.lang.String text) テキスト文字列を設定します。

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

フィールドの詳細

NUMBER

public static final int NUMBER

初期入力モードを数字入力モードにすることを表します (=0)。

ALPHA

public static final int ALPHA

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

KANA

public static final int KANA

初期入力モードをかな漢字入力モードにすることを表します (=2)。

DISPLAY_ANY

public static final int DISPLAY_ANY

表示文字列をそのまま表示するモードにすることを表します (=0)。

DISPLAY_PASSWORD

public static final int DISPLAY_PASSWORD

表示文字列を隠蔽するモード(パスワード入力モード)にすることを表します (=1)。

コンストラクタの詳細

TextBox

public TextBox(java.lang.String text,
               int columns,
               int rows,
               int mode)

初期文字列と桁数、行数、表示モードを指定してテキストボックスを生成します。 生成時には、表示可能で、ユーザ操作可能になっています。 また、入力モードはかな漢字入力モードになっています。 表示可能、表示不能を設定するには、setVisibleメソッドを使用します。 ユーザ操作可能、ユーザ操作不能を設定するには、setEnabledメソッドを使用します。 入力モードを切り替えるには、setInputMode メソッドを使用します。

パラメータ:

text - 初期文字列を指定します。nullが指定された場合、空文字("")が設定されます。

columns - 桁数を指定します。桁数は、半角文字数で数えます。

rows - 行数を指定します。

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

例外:

IllegalArgumentException - 引数 columns, rows に 0 未満の値が指定された場合、引数 mode に不正な値が指定された場合に発生します。

メソッドの詳細

setEnabled

public void setEnabled(boolean b)

テキストボックスをユーザ操作可能にしたりユーザ操作不能にしたりします。 コンポーネントが可視、不可視に関わらず、このメソッドを呼び出して状態を 変更することができます。 デフォルトではユーザ操作可能です。

定義:

インタフェース Interactable 内の setEnabled

パラメータ:

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

requestFocus

public void requestFocus()

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

定義:

インタフェース Interactable 内の requestFocus

setText

public void setText(java.lang.String text)

テキスト文字列を設定します。 編集不能になっている場合でも、このメソッドによりテキスト文字列が設定できます。 なお、パスワード入力モードになっている場合は、このメソッドにより文字列を設定された 場合、表示される文字列は、エコーキャラクタ(*など)が設定文字分だけ表示されます (内部では設定された文字列を保持しています)。 文字列を設定すると、コンポーネントイベント(TEXT_CHANGED)が発生します。

パラメータ:

text - テキスト文字列を指定します。 null が指定された場合は空文字列("")が設定されます。

getText

public java.lang.String getText()

テキスト文字列を取得します。

戻り値:

テキスト文字列を返します。

setInputMode

public void setInputMode(int mode)

テキスト文字列の初期入力モードを設定します。 初期入力モードとは、入力メソッドを起動した時に最初に設定されるモードのことを表します。 デフォルトではかな漢字入力モードです。

パラメータ:

mode - 初期入力モードを指定します。NUMBER, ALPHA, KANA のいずれかを指定します。

例外:

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

setEditable

public void setEditable(boolean b)

テキスト文字列を編集可能にするかどうかを設定します。 デフォルトでは編集可能です。 不可視、可視に関係なく、このメソッドを呼び出すことにより、編集可能または編集不可能に 設定できます。

パラメータ:

b - 編集可能にする場合は true を、そうでない場合は false を指定します。