DojoDateTextBox ウィジェットは、日付または日付の一部が入るテキスト・ボックスを定義します。
このウィジェットは、Dojo dijit.form.DateTextBox 定義に基づいています。
以下に、サポートされるプロパティーを示します。
- contraints
- 関数の呼び出し中に引数として使用され、これによりユーザー入力の検査が行われる辞書。これらの関数は、
validators プロパティーによって参照され、
バリデーター関数と呼ばれます。
辞書の内容は、ユーザーのビジネス・ニーズに適合しています。以下に割り当て例を示します。
DateTextBox.constraints = new Dictionary
{ min=DateTimeLib.mdy(1, 1, 2011), max=DateTimeLib.currentDate()};
この場合、タイプ DATE の 2 つのキーである、max および min に値を設定します。
この設定によって、ユーザー入力が指定の日付範囲に制限されます。
- errorMessage
- 入力内容が存在するが無効である場合に表示されるメッセージ。
メッセージは、ユーザー用に用意された出力フィールドまたはツールチップに表示されます。
- formatLength
- 表示されるデータのフォーマット。
いずれか 1 つの formatLength 値の使用による効果は、そのロケールに限定されます。
いずれの場合にも、値は以下のいずれかとなります。それらについてここでは米国英語で説明します。
- DATEBOX_FORMAT_FULL
- 曜日を組み込みます。例えば、「Monday, March 16, 2009」となります。
- DATEBOX_FORMAT_LONG
- 日、月、および年を組み込みます。例えば、「March 16, 2009」となります。
- DATEBOX_FORMAT_MEDIUM
- 短縮された月名を組み込みます。例えば、「Mar 16, 2009」となります。
- DATEBOX_FORMAT_SHORT
- 数値フォーマットの日、月、および年を組み込みます。例えば、「03/16/2009」となります。
注: Rich UI エディターで使用されるロケールの設定については、『Rich UI の外観の設定』にある「言語」タブについての説明を参照してください。
デプロイメント時にランタイム・ロケールを設定するには、『EGL デプロイメント記述子での Rich UI デプロイメント項目の追加』を参照してください。
- inputRequired
- 入力が必要かどうかを示すブール値。この場合のエラー・メッセージは、inputRequiredMessage プロパティーの値です。
この検査は他のすべての検査に先行しますが、日付テキスト・ボックスがフォーカスを失った後にフォーカスを得た後にのみアクティブになります。
- inputRequiredMessage
- InputRequired プロパティーが true であり、日付テキスト・ボックスが空欄であり、フィールドがフォーカスを失った後にフォーカスを得た場合に表示されるストリング。
メッセージは、ユーザー用に用意された出力フィールドまたはツールチップに表示されます。
inputRequiredMessage プロパティーが存在しない場合、ロケールに応じて、エラー・メッセージのストリングは次のようになります。「この値は必須です。」
- placeholder
- Dojo 日付テキスト・ボックスに表示されるが、ユーザーがボックスをクリックするとすぐに削除されるストリング。
ボックスが空であり、ユーザーがそのボックスで作業していない場合にはいつでも、フィールドにこのストリングが再表示されます。
- promptMessage
- ユーザーに入力のプロンプトを出すストリング。日付テキスト・ボックスがフォーカスを得るときに、このストリングはユーザー用に提供されているツールチップ内のボックスの横に表示され、ユーザーが内容の追加または変更を開始するまで継続的に表示されます。
ストリング位置をさらに設定するには、tooltipPosition プロパティーを設定します。
- readOnly
- 日付テキスト・ボックスがユーザー入力から保護されるかどうかを示すブール値。
- selectOnClick
- ユーザーが日付テキスト・ボックスの外側からボックス内をクリックした場合の動作を示すブール値。
- FALSE (デフォルト)
- 日付テキスト・ボックスの内容は選択されません。
更新カーソルがクリック位置に表示されます。
- TRUE
- 日付テキスト・ボックスの内容が選択されます。
さらにクリックすると、クリック位置に更新カーソルが表示され、日付テキスト・ボックスの内容は選択された状態ではなくなります。
- text
- 使用中のデフォルト・フォーマットと一致するようにフォーマット設定されたストリング。
ウィジェット宣言でプロパティーを設定している場合、ストリングは defaultDateFormat ビルド記述子オプションの設定と一致している必要があります。
このプロパティーを実行時に設定する場合、ストリングは StrLib.defaultDateFormat システム関数の設定と一致している必要があります。これ自体のデフォルトは、defaultDateFormat ビルド記述子オプションの値になります。
defaultDateFormat オプションのデフォルト値は MM/dd/yyyy です。
- validators
- 配列要素の順序で呼び出されるバリデーター関数の配列。
指定された関数でユーザーの入力が検査をパスした場合、その関数は NULL またはブランクを戻して成功を示します。そしてその場合のみ、配列の次の関数が呼び出されます。ユーザーの入力が検査にパスしなかった場合、関数は非ブランクのストリングを戻して失敗を示します。
ウィジェットがフォーカスを失うと、一連のバリデーターが呼び出されます。
Dojo 日付テキスト・ボックスがコントローラーにより参照される場合は、ここで説明した関数とはまったく別の、コントローラー固有のバリデーター関数をコーディングできます。
コントローラー固有の関数は、フィールド固有の検査が成功した場合のみ、かつウィジェットがフォーカスを失った後でのみ、呼び出されます。
コントローラーの詳細については、『Rich UI の検査およびフォーマット設定』を参照してください。
フィールド固有のバリデーター関数はそれぞれ、以下の委譲パーツに適合しています。
Delegate Validator(input String in, constraints dictionary in)
returns(string?) end
- input
- ユーザー入力。
- constraints
- 正規表現を構成するため、またはバリデーター関数の内部で処理をガイドするために使用される情報を提供する辞書。
例えば、辞書はユーザーのセキュリティー・レベルを指定することがあります。
- string?
- NULL またはブランク (エラーの発生がない場合) または非ブランクのストリング (エラーの発生を示すため)。
DojoLib ライブラリーで提供される 1 つ以上の関数を、バリデーターから呼び出すこともあるかもしれません。
- value
- 日付変数。ただし自動変換によりストリングも使用できます。
以下の関数をサポートします。
- clear
- 現行値をクリアする。
- getValidState
- 内部使用専用です。
- showErrorIndicator
- ウィジェット内のエラー標識を設定またはクリアするブール値を受け入れます。以下に、関数プロトタイプを示します。
function showErrorIndicator(aboolean boolean in);
- showErrorMessage
- ウィジェットの近くのエラー・メッセージ・ツールチップに表示するエラー・メッセージを受け入れます。ツールチップは、ウィジェットがフォーカスを得たときに表示され、ウィジェットがフォーカスを失うと非表示になります。以下に、関数プロトタイプを示します。
function showErrorMessage(msg string in);
サポートされる他のプロパティーおよび関数は、『ウィジェットのプロパティーと関数』および『ウィジェット・スタイル』で説明されています。