DojoTextField ウィジェットは、単一行のテキストを含むテキスト・ボックスを定義します。
このウィジェットは、Dojo dijit.form.ValidationTextBox 定義に基づいています。
以下に、サポートされるプロパティーを示します。
- constraints
- 関数の呼び出し中に引数として使用され、これによりユーザー入力の検査が行われる辞書。これらの関数は、
validators プロパティーによって参照され、
バリデーター関数と呼ばれます。
辞書の内容は、ユーザーのビジネス・ニーズに適合しています。以下に割り当て例を示します。
constraints = new Dictionary{timeFormat = "hh:mm:ss"}
この場合、ユーザーの入力が、間にコロンを挟んで、時間、分、および秒を示すように形式設定されていなければ、バリデーター関数はエラー・メッセージを戻すことがあります。
- inputRequired
- 入力が必要かどうかを示すブール値。この場合のエラー・メッセージは、inputRequiredMessage プロパティーの値です。
この検査は他のすべての検査に先行しますが、フィールドがフォーカスを失った後にフォーカスを得た後にのみアクティブになります。
- inputRequiredMessage
- InputRequired プロパティーが true であり、テキスト・フィールドが空欄であり、フィールドがフォーカスを失った後にフォーカスを得た場合に表示されるストリング。
メッセージは、ユーザー用に用意された出力フィールドに表示されます。
inputRequiredMessage プロパティーが存在しない場合、ロケールに応じて、エラー・メッセージのストリングは次のようになります。「この値は必須です。」
注: Rich UI エディターで使用されるロケールの設定については、『Rich UI の外観の設定』にある「言語」タブについての説明を参照してください。
デプロイメント時にランタイム・ロケールを設定するには、『EGL デプロイメント記述子での Rich UI デプロイメント項目の追加』を参照してください。
- maxLength
- フィールドに入力可能な文字の最大数。
- placeholder
- Dojo テキスト・フィールドに表示されるが、ユーザーがフィールドをクリックするとすぐに削除されるストリング。
フィールドが空であり、ユーザーがそのボックスで作業していない場合にはいつでも、フィールドにこのストリングが再表示されます。
- promptMessage
- ユーザーに入力のプロンプトを出すストリング。テキスト・フィールドがフォーカスを得るときに、このストリングはユーザー用に提供されている出力フィールド内のテキスト・フィールドの横に表示され、ユーザーが内容の追加または変更を開始するまで継続的に表示されます。
ストリング位置をさらに設定するには、tooltipPosition プロパティーを設定します。
- readOnly
- テキスト・フィールドがユーザー入力から保護されるかどうかを示すブール値。
- selectOnClick
- ユーザーがテキスト・フィールドの外側からフィールド内をクリックした場合の動作を示すブール値。
- FALSE (デフォルト)
- テキスト・フィールドの内容は選択されません。
更新カーソルがクリック位置に表示されます。
- TRUE
- テキスト・フィールドの内容が選択されます。
さらにクリックすると、クリック位置に更新カーソルが表示され、テキスト・フィールドの内容は選択された状態ではなくなります。
- text
- Dojo テキスト・フィールドのストリング内容。
- textCase
- ユーザーが入力を終了して他のフィールドにナビゲートするときの、入力テキストの大文字/小文字の処理を示すストリング定数。
以下のいずれかの値。
- CASE_NONE (デフォルト)
- ユーザーのストリングは変更されないままです。
- UPPER_CASE
- ユーザーのストリングは大文字に設定されます。
- LOWER_CASE
- ユーザーのストリングは小文字に設定されます。
- PROPER_CASE
- 各単語の先頭文字が (そのストリングがタイトルであるかのように) 大文字に設定されます。
- tooltipPosition
- 優先度が高い方から低い方の順に、一連のメッセージの順位を指定するストリング定数の配列。
EGL ランタイム・コードは、配列内の各定数を順に試行します。
ウィンドウまたはスクロール移動域のスペースが不足しない限り、配列内の特定の定数に対して必要に応じてメッセージが表示されます。
スペースが不十分である場合、ハンドラーは配列内の次の定数で表される指示を試行します。
以下のような定数が有効です。
- TOOLTIP_AFTER
- メッセージはテキスト・フィールドの右側に表示されます。
- TOOLTIP_BEFORE
- メッセージはテキスト・フィールドの左側に表示されます。
- TOOLTIP_ABOVE
- メッセージはテキスト・フィールドの上方に表示されます。
- BELOW
- メッセージはテキスト・フィールドの下方に表示されます。
スペース上の理由で使用可能な値がない場合、メッセージはフィールドの上方に表示されます。
値を指定しない場合、tooltipPosition の値は [DojoLib.AFTER, DojoLib.BEFORE] になります。
- trim
- ユーザーが入力を終了して他のフィールドにナビゲートするときに、先行ブランクおよび末尾ブランクを削除するかどうかを示すブール値。
- validators
- ユーザーの各キー・ストロークに応答して、配列要素の順序で呼び出されるバリデーター関数の配列。
指定された関数でユーザーの入力が検査をパスした場合、その関数は NULL またはブランクを戻して成功を示します。そしてその場合のみ、配列の次の関数が呼び出されます。ユーザーの入力が検査にパスしなかった場合、関数は非ブランクのストリングを戻して失敗を示します。
各キー・ストロークで、一連のバリデーターが呼び出されます。
Dojo テキスト・フィールドがコントローラーにより参照される場合は、ここで説明した関数とはまったく別の、コントローラー固有のバリデーター関数をコーディングできます。
コントローラー固有の関数は、フィールド固有の検査が成功した場合のみ、かつウィジェットがフォーカスを失った後でのみ、呼び出されます。
コントローラーの詳細については、『Rich UI の検査およびフォーマット設定』を参照してください。
フィールド固有のバリデーター関数はそれぞれ、以下の委譲パーツに適合しています。
Delegate Validator(input String in, constraints dictionary in)
returns(string?) end
- input
- 収集されたユーザーの入力。同じ Dojo テキスト・フィールドにおける前のキー・ストロークからの文字も含まれます。
- constraints
- 正規表現を構成するため、またはバリデーター関数の内部で処理をガイドするために使用される情報を提供する辞書。
例えば、辞書はユーザーのセキュリティー・レベルを指定することがあります。
- string?
- NULL またはブランク (エラーの発生がない場合) または非ブランクのストリング (エラーの発生を示すため)。
DojoLib ライブラリーで提供される 1 つ以上の関数を、バリデーターから呼び出すこともあるかもしれません。
以下の関数は、EGL Dojo ウィジェット・タイプに固有であり、『Rich UI の検査およびフォーマット設定』にリストされているビュー・レベルの検査をサポートします。
- getValidState
- 内部使用専用です。
- showErrorIndicator
- ウィジェット内のエラー標識を設定またはクリアするブール値を受け入れます。以下に、関数プロトタイプを示します。
function showErrorIndicator(aboolean boolean in);
- showErrorMessage
- ウィジェットの近くのエラー・メッセージ・ツールチップに表示するエラー・メッセージを受け入れます。ツールチップは、ウィジェットがフォーカスを得たときに表示され、ウィジェットがフォーカスを失うと非表示になります。以下に、関数プロトタイプを示します。
function showErrorMessage(msg string in);
サポートされる他のプロパティーおよび関数は、『ウィジェットのプロパティーと関数』および『ウィジェット・スタイル』で説明されています。