com.nttdocomo.ui.Component
com.nttdocomo.ui.TextBox
Object
テキスト入力コンポーネントを定義します。 テキストボックスクラスは、 高レベル API で使用するUI部品の一つで、 テキスト入力のためのコンポーネントです。
テキスト入力コンポーネントでは、 表示行数が1行の場合と2行以上の場合で動作が異なります。
[DoJa-3.0 (505i) 以降]
テキスト文字列には通常の文字列またはXStringの文字列が指定できます。
これらは排他的に動作します。
通常の文字列が設定されている場合にXStringの文字列を設定すると、
表示される文字列はXStringの内容に置き換わります。
このとき、getTextメソッドを呼び出すと、nullが返ります。
逆に、XStringの文字列が設定されている場合に通常の文字列を設定すると、
表示される文字列は通常の文字列の内容に置き換わります。
このとき、getXTextメソッドを呼び出すと、nullが返ります。
XStringの文字列が設定されている場合、編集することはできません。
setText(String)、setText(XString))
によるテキスト文字列の設定では、
制限数を超える文字列を設定することはできません。
| フィールドの概要 | |
static int |
ALPHA
初期入力モードをアルファベット入力モードにすることを表します (=1)。 |
static int |
DISPLAY_ANY
表示文字列をそのまま表示するモードにすることを表します (=0)。 |
static int |
DISPLAY_PASSWORD
文字列を隠蔽して表示するモード (パスワード入力用の表示モード) にすることを表します (=1)。 |
static int |
INPUTSIZE_UNLIMITED [iアプリオプションAPI]
入力文字数の制限値を無制限にすることを表します (=0)。 |
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 |
setInputSize(int inputSize) [iアプリオプションAPI]
テキスト文字列に入力可能な文字数を制限します。 |
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 |
| フィールドの詳細 |
public static final int NUMBER
public static final int ALPHA
public static final int KANA
public static final int DISPLAY_ANY
この表示モードに設定したテキストボックスのデフォルトの初期入力モードは、
かな漢字入力モード です。
public static final int DISPLAY_PASSWORD
文字列を隠蔽して表示するモード (パスワード入力用の表示モード) にすることを表します (=1)。
[DoJa-4.0 (901i) 以降]
この表示モードに設定したテキストボックスのデフォルトの初期入力モードは、
数字入力モードです。
また、その時に入力可能な文字種は、
ブラウザにおけるパスワード入力用テキストボックスと同様です。
public static final int INPUTSIZE_UNLIMITED [iアプリオプションAPI]
| コンストラクタの詳細 |
public TextBox(String text,
int columns,
int rows,
int mode)
初期文字列と桁数、行数、 表示モードを指定してテキストボックスを生成します。
生成時には、表示可能で、ユーザ操作可能になっています。
また、生成時の初期入力モードは、
引数に指定する表示モードにより異なります。
詳細は、各表示モード
(DISPLAY_ANY、DISPLAY_PASSWORD)
の説明を参照して下さい。
表示可能、表示不能を設定するには、Component.setVisible(boolean)
メソッドを使用します。
ユーザ操作可能、ユーザ操作不能を設定するには、
setEnabled(boolean) メソッドを使用します。
初期入力モードを切り替えるには、
setInputMode(int) メソッドを使用します。
text - 初期文字列を指定します。null が指定された場合、
空文字列("")が設定されます。columns - 桁数を指定します。桁数は、半角文字数で数えます。rows - 行数を指定します。mode - 文字列の表示モードを指定します。
DISPLAY_ANY または、DISPLAY_PASSWORD を指定します。
IllegalArgumentException -
引数 columns、rows に 0 未満の値が指定された場合に発生します。
IllegalArgumentException -
引数 mode に不正な値が指定された場合に発生します。
public TextBox(XString xText,
int columns,
int rows,
int mode)
Component.setVisible(boolean)
メソッドを使用します。
XString の文字列が設定されている限り、編集可能にはできません。
xText - 初期文字列をXStringで指定します。
null が指定された場合、
表示文字列には空文字("")が設定されます。columns - 桁数を指定します。桁数は、半角文字数で数えます。rows - 行数を指定します。mode - 文字列の表示モードを指定します。
DISPLAY_ANY または、DISPLAY_PASSWORD
を指定します。
IllegalArgumentException - 引数 columns、rows に 0 未満の値が指定された場合に発生します。
IllegalArgumentException - 引数 mode に不正な値が指定された場合に発生します。
| メソッドの詳細 |
public void setText(String text)
ComponentListener.TEXT_CHANGED)
が発生します。
[DoJa-3.0 (505i) 以降]
不可視、可視に関わらず、このメソッドの呼び出しにより、
テキスト文字列が設定されます。
ただし、イベントは可視の場合だけ発生します。
また、ユーザ操作可能/不能に関わらず、このメソッドは機能します。
[DoJa-4.1 (902i) 以降]
テキスト文字列に入力可能な文字数が制限されている場合、
引数 text に指定する文字列の文字数は制限値以内でなければなりません。
入力可能な文字数の制限値を超える文字列を指定した場合は、
例外 UIException(ILLEGAL_STATE) が発生します。
text - テキスト文字列を指定します。
null が指定された場合は空文字列("")が設定されます。
UIException - [DoJa-4.1 (902i) 以降]
引数 text に指定された文字列の文字数が、
入力可能な文字数の制限値より大きい場合に発生します
(ILLEGAL_STATE)。
public void setText(XString xText)
ComponentListener.TEXT_CHANGED)
が発生します。
このメソッドが呼び出されると、引数の値に関係なく、
自動的に編集不能状態に変更されます。
その後に setText(String) を呼び出して通常文字列を設定しても、
編集不能状態のままです。
不可視、可視に関わらず、このメソッドの呼び出しにより、 テキスト文字列が設定されます。 ただし、イベントは可視の場合だけ発生します。 また、ユーザ操作可能/不能に関わらず、このメソッドは機能します。
[DoJa-4.1 (902i) 以降]
テキスト文字列に入力可能な文字数が制限されている場合、
引数 xText に指定する文字列の文字数は制限値以内でなければなりません。
入力可能な文字数の制限値を超える文字列を指定した場合は、
例外 UIException(ILLEGAL_STATE) が発生します。
xText - XString のテキスト文字列を指定します。
null が指定された場合、
表示文字列には空文字列("")が設定されます。
UIException - [DoJa-4.1 (902i) 以降]
引数 xText に指定された文字列の文字数が、
入力可能な文字数の制限値より大きい場合に発生します
(ILLEGAL_STATE)。
public String getText()
public XString getXText()
TextBox(XString, int, int, int)
または
setText(XString) メソッドに渡された、XString を返します。
したがって、null が渡された場合には、空文字列ではなく null が返ります。
public void setInputMode(int mode)
テキスト文字列の初期入力モードを設定します。
初期入力モードとは、
入力メソッドを起動した時に最初に設定されるモードのことを表します。
デフォルトの初期入力モードは、
テキストボックス生成時に設定されている表示モードにより異なります。
詳細は、各表示モード
(DISPLAY_ANY、DISPLAY_PASSWORD)
の説明を参照して下さい。
入力可能文字種が制限されている表示モードでは、
指定した初期入力モードによっては、
入力できる文字が存在しない場合があります。
(例: 英数字しか入力できない表示モードのテキストボックスにおいて、
KANA を初期入力モードで指定した場合)
そのような初期入力モードを指定しても、
例外が発生することはありませんが、
その状態で FEP
が起動された場合にどのような振る舞いをするかは機種依存です。
ただし、その場合でも、
FEP 起動後に入力モードをユーザが切り換えることによって、
入力を続行することは可能です。
mode - 初期入力モードを指定します。
NUMBER、ALPHA、KANA
のいずれかを指定します。
IllegalArgumentException -
引数 mode に不正な値が指定された場合に発生します。
public void setInputSize(int inputSize) [iアプリオプションAPI]
入力文字数の制限値には半角文字数に換算した値を指定します。
実装がサポートしている最大文字数より大きい値を指定した場合は、
最大文字数が指定されたことになります。
既に設定されているテキスト文字列の文字数より小さい値を指定した場合は、
例外が発生します。
また、INPUTSIZE_UNLIMITED を指定した場合は、
入力文字数の制限値は無制限に設定されます。
端末によっては、このメソッドをサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。
inputSize - 入力文字数の制限値を指定します。
UnsupportedOperationException - 端末がこのメソッドをサポートしていない場合に発生します。
IllegalArgumentException - 引数 inputSize が負の場合に発生します。
UIException - 引数 inputSize に指定された値が、
既に設定されている入力文字列の文字数よりも小さい場合に発生します
(ILLEGAL_STATE)。
public void setEditable(boolean b)
[DoJa-3.0 (505i) 以降]
デフォルトでは文字列が String 型ならば編集可能、
XString 型ならば編集不能です。
テキスト文字列がString型である場合、不可視、可視に関係なく、
このメソッドを呼び出すことにより、
編集可能または編集不可能に設定できます。
テキスト文字列が XString 型である場合、
このメソッドを呼び出すと IllegalStateException をスローします。
b - 編集可能にする場合は true を、
そうでない場合は false を指定します。
IllegalStateException - [DoJa-3.0 (505i) 以降]
このオブジェクトに設定されているテキスト文字列が XString
型である場合に発生します。
public void setEnabled(boolean b)
Interactable の記述:
Interactable 内の setEnabledb - 有効状態にする場合は true を、無効状態にする場合は false を指定します。public void requestFocus()
Interactable の記述:
Interactable 内の requestFocus