DojoTimeTextBox ウィジェットは、時刻値が入るテキスト・ボックスを定義します。
このウィジェットは、Dojo dijit.form.TimeTextBox 定義に基づいています。
ユーザーがウィジェットをクリックすると、時刻のグラフィカル・リストである時刻選択メニュー が表示されます。
ユーザーは、リストされている時刻を選択して、ボックスに表示される値を更新することができます。
visibleIncrement および visibleRange プロパティーを設定して、時刻選択メニューをカスタマイズできます。さらに、value および timePattern プロパティーを設定して、時刻テキスト・ボックスに表示される時刻値をカスタマイズできます。
以下に示すのは、DojoTimeTextBox でサポートされるプロパティーです。
- constraints
- 関数の呼び出し中に引数として使用され、これによりユーザー入力の検査が行われる辞書。これらの関数は、
validators プロパティーによって参照され、
バリデーター関数と呼ばれます。
辞書の内容は、ユーザーのビジネス・ニーズに適合しています。以下に割り当て例を示します。
constraints = new Dictionary{minimumHour = "11:30 AM"}};
この場合、ユーザーが 11:30 AM より前の時刻を指定すると、バリデーター関数はエラー・メッセージを戻すことがあります。
- errorMessage
- 入力内容が存在するが無効である場合に表示されるメッセージ。
メッセージは、ユーザー用に用意された出力フィールドまたはツールチップに表示されます。
- inputRequired
- 入力が必要かどうかを示すブール値。この場合のエラー・メッセージは、inputRequiredMessage プロパティーの値です。
この検査は他のすべての検査に先行しますが、フィールドがフォーカスを失った後にフォーカスを得た後にのみアクティブになります。
- inputRequiredMessage
- InputRequired プロパティーが true であり、時刻テキスト・ボックスが空欄であり、ボックスがフォーカスを失った後にフォーカスを得た場合に表示されるストリング。
メッセージは、ユーザー用に用意された出力フィールドまたはツールチップに表示されます。
inputRequiredMessage プロパティーが存在しない場合、ロケールに応じて、エラー・メッセージのストリングは次のようになります。「この値は必須です。」
- placeholder
- 時刻テキスト・ボックスに表示されるが、ユーザーがボックスをクリックするとすぐに削除されるストリング。
ボックスが空であり、ユーザーがそのボックスで作業していない場合にはいつでも、時刻テキスト・ボックスにこのストリングが再表示されます。
- promptMessage
- ユーザーに入力のプロンプトを出すストリング。時刻テキスト・ボックスがフォーカスを得るときに、このストリングはユーザー用に提供されているツールチップ内のボックスの横に表示され、ユーザーが内容の追加または変更を開始するまで継続的に表示されます。
ストリング位置をさらに設定するには、tooltipPosition プロパティーを設定します。
- readOnly
- 時刻テキスト・ボックスがユーザー入力から保護されるかどうかを示すブール値。
- selectOnClick
- ユーザーが時刻テキスト・ボックスの外側からボックス内をクリックした場合の動作を示すブール値。
- FALSE (デフォルト)
- 時刻テキスト・ボックスの内容は選択されません。
更新カーソルがクリック位置に表示されます。
- TRUE
- 時刻テキスト・ボックスの内容が選択されます。
さらにクリックすると、クリック位置に更新カーソルが表示され、時刻テキスト・ボックスの内容は選択された状態ではなくなります。
- text
- 使用中のデフォルト・フォーマットと一致するようにフォーマット設定されたストリング。
ウィジェット宣言でプロパティーを設定している場合、ストリングは defaultTimeFormat ビルド記述子オプションの設定と一致していなければなりません。
このプロパティーを実行時に設定する場合、ストリングは StrLib.defaultTimeFormat システム関数の設定と一致していなければなりません。これ自体のデフォルトは、defaultTimeFormat ビルド記述子オプションの値になります。
defaultTimeFormat オプションのデフォルト値は HH:mm:ss です。
- timePattern
- 時刻の表示形式を示すストリング定数。
- TIMEBOX_FORMAT_12HR
- 12:00 AM から 11:59 AM および 12:00 PM から 11:59 PM の範囲で形式設定された時刻を表示します。
- TIMEBOX_FORMAT_24HR
- 24 時間表示時刻を表示します。
- validators
- 配列要素の順序で呼び出されるバリデーター関数の配列。
指定された関数でユーザーの入力が検査をパスした場合、その関数は NULL またはブランクを戻して成功を示します。そしてその場合のみ、配列の次の関数が呼び出されます。ユーザーの入力が検査にパスしなかった場合、関数は非ブランクのストリングを戻して失敗を示します。
ウィジェットがフォーカスを失うと、一連のバリデーターが呼び出されます。
Dojo 時刻テキスト・ボックスがコントローラーにより参照される場合は、ここで説明した関数とはまったく別の、コントローラー固有のバリデーター関数をコーディングできます。
コントローラー固有の関数は、フィールド固有の検査が成功した場合のみ、かつウィジェットがフォーカスを失った後でのみ、呼び出されます。
コントローラーの詳細については、『Rich UI の検査およびフォーマット設定』を参照してください。
フィールド固有のバリデーター関数はそれぞれ、以下の委譲パーツに適合しています。
Delegate Validator(input String in, constraints dictionary in)
returns(string?) end
- input
- ユーザー入力。
- constraints
- 正規表現を構成するため、またはバリデーター関数の内部で処理をガイドするために使用される情報を提供する辞書。
例えば、辞書はユーザーのセキュリティー・レベルを指定することがあります。
- string?
- NULL またはブランク (エラーの発生がない場合) または非ブランクのストリング (エラーの発生を示すため)。
DojoLib ライブラリーで提供される 1 つ以上の関数を、バリデーターから呼び出すこともあるかもしれません。
- value
- 時刻変数。ただし自動変換によりストリングも使用できます。
- visibleIncrement
- 時刻選択メニューに表示される増分。時刻のグラフィカル・リスト。
以下のいずれかの定数です。
- TIMEBOX_ONE_QUARTER (デフォルト。15 分刻みの増分で表示します)
- TIMEBOX_FIVE_MINUTES
- TIMEBOX_HALF_HOUR
- TIMEBOX_ONE_HOUR
- TIMEBOX_TWO_HOURS
- TIMEBOX_THREE_HOURS
- TIMEBOX_FIVE_HOURS
- TIMEBOX_TEN_HOURS
- TIMEBOX_TWELVE_HOURS
- TIMEBOX_FULL_DAY (24 時間刻みの増分で表示します)
- visibleRange
- 時刻選択メニューで表示する時刻の範囲。
ユーザーは必要に応じて別の時刻にスクロールすることができます。
定数は、visibleIncrement プロパティーの定数と同じです。
以下の関数は、EGL Dojo ウィジェット・タイプに固有であり、『Rich UI の検査およびフォーマット設定』にリストされているビュー・レベルの検査をサポートします。
- getValidState
- 内部使用専用です。
- showErrorIndicator
- ウィジェット内のエラー標識を設定またはクリアするブール値を受け入れます。以下に、関数プロトタイプを示します。
function showErrorIndicator(aboolean boolean in);
- showErrorMessage
- ウィジェットの近くのエラー・メッセージ・ツールチップに表示するエラー・メッセージを受け入れます。ツールチップは、ウィジェットがフォーカスを得たときに表示され、ウィジェットがフォーカスを失うと非表示になります。以下に、関数プロトタイプを示します。
function showErrorMessage(msg string in);
サポートされる他のプロパティーおよび関数は、『ウィジェットのプロパティーと関数』および『ウィジェット・スタイル』で説明されています。