com.nttdocomo.ui
クラス TextBox

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行以上の場合は、文字列がその行数で表現しきれない場合、 縦スクロール表示になります。

[DoJa-3.0]
テキスト文字列に改行文字列("\n"あるいは"\r\n")が含まれていた場合、 改行して表示されます。 IMEにおいて改行を入力した場合、"\r\n"として取得されます。

[DoJa-3.0]
テキスト文字列には通常の文字列またはXStringの文字列が指定できます。 これらは排他的に動作します。 通常の文字列が設定されている場合にXStringの文字列を設定すると、 表示される文字列はXStringの内容に置き換わります。 このとき、getTextメソッドを呼び出すと、nullが返ります。 逆に、XStringの文字列が設定されている場合に通常の文字列を設定すると、 表示される文字列は通常の文字列の内容に置き換わります。 このとき、getXTextメソッドを呼び出すと、nullが返ります。 XStringの文字列が設定されている場合、編集することはできません。


フィールドの概要
static int ALPHA
          初期入力モードをアルファベット入力モードにすることを表します (=1)。
static int DISPLAY_ANY
          表示文字列をそのまま表示するモードにすることを表します (=0)。
static int DISPLAY_PASSWORD
          表示文字列を隠蔽するモード(パスワード入力モード)にすることを表します (=1)。
static int KANA
          初期入力モードをかな漢字入力モードにすることを表します (=2)。
static int NUMBER
          初期入力モードを数字入力モードにすることを表します (=0)。
 
コンストラクタの概要
TextBox(String text, int columns, int rows, int mode)
          初期文字列と桁数、行数、表示モードを指定してテキストボックスを生成します。
TextBox(XString xText, int columns, int rows, int mode)
           初期文字列(XString)と桁数、行数、表示モードを指定してテキストボックスを生成します。
 
メソッドの概要
 String getText()
          テキスト文字列を取得します。
 XString getXText()
           テキスト文字列(XString)を取得します。
 void requestFocus()
          コンポーネントにフォーカスをセットするよう要求します。
 void setEditable(boolean b)
          テキスト文字列を編集可能にするかどうかを設定します。
 void setEnabled(boolean b)
          コンポーネントを有効状態(ユーザ操作可能な状態)にしたり 無効状態(ユーザ操作不能な状態)にしたりします。
 void setInputMode(int mode)
          テキスト文字列の初期入力モードを設定します。
 void setText(String text)
          テキスト文字列を設定します。
 void setText(XString xText)
           テキスト文字列をXStringの文字列で設定します。
 
クラス com.nttdocomo.ui.Component から継承したメソッド
getHeight, getWidth, getX, getY, setBackground, setFont, setForeground, setLocation, setSize, setVisible
 
クラス 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(String text,
               int columns,
               int rows,
               int mode)
初期文字列と桁数、行数、表示モードを指定してテキストボックスを生成します。 生成時には、表示可能で、ユーザ操作可能になっています。 また、入力モードはかな漢字入力モードになっています。 表示可能、表示不能を設定するには、Component.setVisible(boolean)メソッドを使用します。 ユーザ操作可能、ユーザ操作不能を設定するには、setEnabled(boolean)メソッドを使用します。 入力モードを切り替えるには、setInputMode メソッドを使用します。

パラメータ:
text - 初期文字列を指定します。nullが指定された場合、空文字("")が設定されます。
columns - 桁数を指定します。桁数は、半角文字数で数えます。
rows - 行数を指定します。
mode - 文字列の表示モードを指定します。 DISPLAY_ANY または、DISPLAY_PASSWORD を指定します。
例外:
IllegalArgumentException - 引数 columns, rows に 0 未満の値が指定された場合に発生します。
IllegalArgumentException - 引数 mode に不正な値が指定された場合に発生します。

TextBox

public TextBox(XString xText,
               int columns,
               int rows,
               int mode)
初期文字列(XString)と桁数、行数、表示モードを指定してテキストボックスを生成します。 生成時には、表示可能で、編集不能になっています。 表示可能、表示不能を設定するには、Component.setVisible(boolean)メソッドを使用します。 XStringの文字列が設定されている限り、編集可能にはできません。

パラメータ:
xText - 初期文字列をXStringで指定します。 nullが指定された場合、表示文字列には空文字("")が設定されます。
columns - 桁数を指定します。桁数は、半角文字数で数えます。
rows - 行数を指定します。
mode - 文字列の表示モードを指定します。 DISPLAY_ANY または、DISPLAY_PASSWORD を指定します。
例外:
IllegalArgumentException - 引数 columns, rows に 0 未満の値が指定された場合に発生します。
IllegalArgumentException - 引数 mode に不正な値が指定された場合に発生します。
導入されたバージョン:
DoJa-3.0
メソッドの詳細

setText

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


[DoJa-3.0]
不可視、可視に関わらず、このメソッドの呼び出しにより、テキスト文字列が設定されます。 ただし、イベントは可視の場合だけ発生します。 また、ユーザ操作可能/不能に関わらず、このメソッドは機能します。

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

setText

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

このメソッドが呼び出されると、引数の値に関係なく、 自動的に編集不能状態に変更されます。

不可視、可視に関わらず、このメソッドの呼び出しにより、 テキスト文字列が設定されます。 ただし、イベントは可視の場合だけ発生します。 また、ユーザ操作可能/不能に関わらず、このメソッドは機能します。

パラメータ:
xText - XStringのテキスト文字列を指定します。 null が指定された場合、表示文字列には空文字列("")が設定されます。
導入されたバージョン:
DoJa-3.0

getText

public String getText()
テキスト文字列を取得します。

戻り値:
テキスト文字列を返します。
[DoJa-3.0]
テキスト文字列がXStringである場合、 nullが返ります。

getXText

public XString getXText()
テキスト文字列(XString)を取得します。
コンストラクタTextBox(XString, int, int, int) または setText(XString)メソッドに渡された、 XStringを返します。 したがって、nullが渡された場合には、空文字列ではなくnullが返ります。

戻り値:
テキスト文字列(XString)を返します。 テキスト文字列が通常文字列である場合、nullが返ります。
導入されたバージョン:
DoJa-3.0

setInputMode

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

パラメータ:
mode - 初期入力モードを指定します。NUMBER, ALPHA, KANA のいずれかを指定します。
例外:
IllegalArgumentException - 引数 mode に不正な値が指定された場合に発生します。

setEditable

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

[DoJa-3.0]
デフォルトでは文字列がString型ならば編集可能、 XString型ならば編集不能です。 テキスト文字列がString型である場合、不可視、可視に関係なく、 このメソッドを呼び出すことにより、 編集可能または編集不可能に設定できます。 テキスト文字列がXString型である場合、 このメソッドを呼び出すとIllegalStateExceptionをスローします。

パラメータ:
b - 編集可能にする場合は true を、 そうでない場合は false を指定します。
例外:
IllegalStateException - [DoJa-3.0] このオブジェクトに設定されているテキスト文字列がXString型である場合に発生します。

setEnabled

public void setEnabled(boolean b)
インタフェース Interactable の記述:
コンポーネントを有効状態(ユーザ操作可能な状態)にしたり 無効状態(ユーザ操作不能な状態)にしたりします。 コンポーネントが可視、不可視に関わらずこのメソッドを発行することができ、 コンポーネントの状態を変更することができます。 コンポーネント生成時は有効状態です。

定義:
インタフェース Interactable 内の setEnabled
パラメータ:
b - 有効状態にする場合は true を、無効状態にする場合は false を指定します。

requestFocus

public void requestFocus()
インタフェース Interactable の記述:
コンポーネントにフォーカスをセットするよう要求します。 コンポーネントをパネルに追加する以前に発行された要求は無視されます。 また、コンポーネントが不可視の場合、無効状態(ユーザ操作不能な状態)の場合もフォーカスはセットされません。

定義:
インタフェース Interactable 内の requestFocus


NTT DoCoMo,Inc.

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

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

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