各レコード・タイプについての説明を以下に記述します。レコード・タイプ内のフィールドには、 読み取り/書き込みが可能なものもあれば、読み取り専用のものもあります。読み取り専用のフィールドでは、ユーザーは、属性値の照会はできますが、変更することはできません。読み取り/書き込み可能フィールドでは、ユーザーは、属性値を照会および変更することができます。
Window タイプ
各 ConsoleUI では、複数のウィンドウを同時に開くことができます。 最初に開くデフォルトのウィンドウは、全画面ウィンドウであり、画面 と呼ばれます。それ以降に開くウィンドウは、 相互に積み重なって表示され、最上位ウィンドウがアクティブ・ウィンドウ です。 アクティブ・ウィンドウを閉じると、新たに最上位ウィンドウとなるウィンドウが、アクティブ・ウィンドウになります。
次の表は、Window フィールドの属性を定義します。 name 属性のみが必須です。
属性 | 型または列挙型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
color | colorKind | black | はい (可視の場合) | ウィンドウ内のテキストの色。 |
commentLine | 整数 | 画面: LAST - 1、その他: LAST | はい (可視の場合) | 特定の行がコメント用に予約されているかどうか。hasCommentLine = yes の場合、コメント用に使用されるウィンドウ行があります。 |
formLine | (正の) 整数 画面の下部から始まる行番号を指定するのに、負の整数を使用できます。行の値は、実行時にのみ検証されます。 |
3 | はい (可視の場合) | 書式が開始されるウィンドウ行。 |
hasBorder | ブール | no | はい (可視の場合) | ウィンドウに枠があるかどうか。 |
hasComment Line | ブール | yes | はい (可視の場合) | コメント用に予約されている行があるかどうか。 |
highlight | highlightKind | black | はい (可視の場合) | ウィンドウ・テキストに適用される強調表示。 |
intensity | intensityKind | 通常輝度 | はい (可視の場合) | ウィンドウ・テキストに適用される輝度 (ボールド)。 |
menuLine | (正の) 整数 画面の下部から始まる行番号を指定するのに、負の整数を使用できます。ウィンドウのサイズ内での行の値は、実行時にのみ検証されます。 |
1 | はい (可視の場合) | メニューが開始されるウィンドウ行。 |
messageLine | (正の) 整数 画面の下部から始まる行番号を指定するのに、負の整数を使用できます。行の値は、実行時にのみ検証されます。 |
2 | はい (可視の場合) | メッセージ用に予約されるウィンドウ行。 |
name | string | なし | はい | ウィンドウの名前。 |
position | integer[2] ゼロ (0) より大きい正の整数で、ディスプレイ装置の物理的寸法内でなければなりません。 |
[1,1] | はい | ディスプレイ内の左上隅の位置。 |
promptLine | (正の) 整数 画面の下部から始まる行番号を指定するのに、負の整数を使用できます。ウィンドウのサイズ内での行の値は、実行時にのみ検証されます。 |
1 | はい (可視の場合) | プロンプト用に予約されるウィンドウ行。 |
size | integer[2] ゼロ (0) より大きい正の整数で、ディスプレイ装置の物理的寸法内でなければなりません。 |
なし | はい | ウィンドウの行数および列数。未指定の場合、サイズは実行時に計算されます。 |
PresentationAttributes タイプ
PresentationAttributes は、ウィンドウ内のテキストの外観を定義します。
次の表は、PresentationAttributes フィールドの属性を定義します。これらの属性のうち、必須の属性はありません。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
color | colorKind | white | いいえ | テキスト・メッセージの色。 |
highlight | highlight Kind | なし | いいえ | テキスト・メッセージに適用される強調表示。
以下の任意の属性を組み合わせることができます。
|
intensity | intensity Kind | 通常輝度 | いいえ | テキスト・メッセージに適用される輝度。 |
ConsoleForm タイプ
ConsoleForm は、ウィンドウ内の書式のプロパティーを定義するレコードです。各ウィンドウでは、個々の ConsoleForm を表示することができます。
次の表は、ConsoleForm プロパティーの属性を定義します。これらの属性のうち、必須の属性はありません。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
delimiters | char[3] | "[]|" | はい | フィールドを区切るために使用される文字。左大括弧「[」と右大括弧「]」が必要です。2 つのフィールドを 1 つのスペースだけで区切る場合は、パイプ (|) を使用します。 |
formSize | integer[2] | なし | はい | 書式のサイズ (行、列)。 |
name | string | name が未指定の場合、EGL により名前が付けられます。 | はい | 書式の名前。 |
showBrackets | ブール | yes | はい | 大括弧により、フィールドが区切られます。 |
ConsoleField
ConsoleField プロパティーは、書式に対して表示されるすべての属性を定義します。
次の表は、ConsoleField プロパティーの属性を定義します。 これらの属性のうち、fieldLen 属性と position 属性のみが必須です。
プロパティー名 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
columns | 整数 | 1 | はい | 列数。コンソール配列フィールドでのみ有効です。 |
fieldLen | 整数 | すべての書式制御文字と共に型宣言の最大値を表示するのに必要なバイト数。 | はい | フィールドによって占有される列数。 |
linesBetween Rows | 整数 | 0 | はい | 各行間の行数。コンソール配列フィールドでのみ有効です。 |
orientIndex Across | ブール | いいえ | はい | 書式内でのフィールドの向き。コンソール配列フィールドでのみ有効です。 |
position | integer[2] | [1,1] | はい | 書式内でのフィールドの位置。 |
segments | integer[3][] | はい | 各フィールド・セグメントの位置および長さの集合。NULL でない場合、位置および長さはオーバーライドされます。 | |
spacesBetween Columns | 整数 | 1 | はい | 列間のスペースの数。コンソール配列フィールドでのみ有効です。 |
validValues | validValue Specification | はい (表示される場合) | この書式フィールドへの入力に有効な値のリストを保持します。 |
次の表は、ConsoleField フィールドの属性を定義します。 name 属性のみが必須です。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
align | alignKind | 型によって異なる | はい | フィールドの値の位置合わせを指定します。
|
autonext | ブール | なし | はい | フィールドにデータが入力されている場合、カーソルが次のフィールドに移動するかどうかを指定します。 autonext = yes の場合、カーソルは次のフィールドに移動します。 |
binding | ストリング | "" | はい (表示される場合) | このフィールドにバインドされているデータ項目への参照を保持します。 |
caseFormat | case Format Kind | デフォルトの Case | いいえ | 値を小文字から大文字へ、または大文字から小文字へ強制的に変換するかどうかを指定します。この属性が選択されている場合、フィールドが更新されて新規の値が実装されます。 |
color | colorKind | 白 | いいえ | テキスト書式フィールドと同様。
色を動的にいつでも設定できます。 ユーザーとの対話中にフィールドが更新されるか、フォーカスを取得した場合、書式フィールドには新規の表示属性が表示されます。 |
commentKey | ストリング | なし | はい | リソース内でコメント・テキストを検索するためのキー。 |
comment | ストリング | なし | はい | このフィールドのコメント・テキスト。コメント・テキストは、カーソルがフィールド内にあるときは、コメント行に表示されます。 |
dataType | ストリング | "" | はい | 書式フィールドがデータ項目にバインドされていない場合、この書式フィールドのデータ型を定義します。constructQuery に必須です。 |
dateFormat | ストリング | はい | 指定された日付形式にフィールドをフォーマット設定します。
可能な値は、以下のとおりです。
|
|
editor | ストリング | なし | はい | フィールドの LOB 型の編集に使用されます。 |
helpMsgKey | ストリング | "" | いいえ | リソース・ファイルからヘルプ・テキストをルックアップするキー。help と helpMsgKey の両方が存在する場合、help が優先されます。 |
help | ストリング | "" | いいえ | KEY_HELP キーが押されるときに、ユーザーに対して表示されるテキスト。help と helpMsgKey の両方が存在する場合、help が優先されます。 |
highlight | デフォルトの Highlight | なし | いいえ | テキスト書式フィールドと同様。
色を動的にいつでも設定できます。 ユーザーとの対話中にフィールドが更新されるか、フォーカスを取得した場合、書式フィールドには新規の表示属性が表示されます。 |
initialValueKey | ストリング | なし | はい | initialValue をルックアップするために使用されるキー。 |
initialValue | ストリング | なし | はい | フィールドの開始表示値。 |
inputRequired | ブール | 偽 | はい | 設定されている場合、ユーザーはこのフィールドに値を入力する必要があり、このフィールドを空白にすることはできません。 |
intensity | 通常輝度 | なし | いいえ | テキスト書式フィールドと同様。
色を動的にいつでも設定できます。 ユーザーとの対話中にフィールドが更新されるか、フォーカスを取得した場合、書式フィールドには新規の表示属性が表示されます。 |
isBoolean | ブール | no | はい | フィールドがブール値を表すことを示します。
この値は、各国語によって異なる文字 (1 文字フィールド)、または「yes」または「no」の語として表されます。
内部では、数値フィールドの場合は次のとおりです。
|
masked | ブール | なし | はい | 設定されている場合、フィールド内の各文字は単一アスタリスク (*) として表示されます。 |
minimumInput | 整数 | no | はい | ユーザーが入力する値に存在する必要がある最小文字数を指定します。 |
name | ストリング | なし | はい | フィールドの名前。 |
numericFormat | ストリング | はい | 指定された数値形式にフィールドをフォーマット設定します。
可能な文字は、以下のとおりです。
|
|
pattern | ストリング | はい | データ・フォーマットおよびエントリーのパターンを指定します。 | |
protect | ブール | なし | いいえ | yes の場合、ユーザーはフィールドにデータを入力できません。no の場合、ユーザーはフィールドにデータを入力できます。 |
SQLColumnName | ストリング | "" | いいえ | データベース・テーブル内の列の名前を表すストリング値。 この情報は構造体の照会中に使用され、これに含まれる列名は、生成済み SQL ストリング内で使用されます。 存在する場合、この値は dataType 列名の値より優先します。 |
timeFormat | ストリング | はい | 指定された時刻形式にフィールドをフォーマット設定します。
可能な値は、以下のとおりです。
|
|
timeStampFormat | ストリング | はい | 指定されたタイム・スタンプ・フォーマットにフィールドをフォーマット設定します。
可能な値は、以下のとおりです。
|
|
value | ストリング | なし | はい | そのフィールドに対する現行のディスプレイ・バッファー・コンテンツ。 |
verify | ブール | 偽 | はい | この値が設定されている場合、ユーザーがフィールドを変更すると、このフィールドを終了する前に、同じ値を再入力するように求めるプロンプトがユーザーに出されます。 |
wordWrap | 整数 | なし | はい | 複数セグメント・フィールドで、値を分割する方法。
|
Menu
各ウィンドウは、無限数の menuitems を持つ、個々の Menu を表示できます。 エンド・ユーザーは、メニュー内を移動して、適切なメニュー項目を選択します。これにより、EGL プログラム内のメニュー項目に関連付けられた on_event アクションが実行されます。
次の表は、Menu フィールドの属性を定義します。 これらの属性のうち、labelText 属性と labelKey 属性のみが必須です。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
labelText | ストリング | はい (OpenUI の実行中) | 表示内のメニューの名前。 | |
labelKey | ストリング | はい (OpenUI の実行中) | リソース内のメニュー・タイトルをルックアップするキー。 label に値が指定された場合、labelKey は無視されます。 | |
menu Items | menu Item[] | いいえ | このメニュー内で関連した menuItems の動的配列を含みます。menuItems が実装されない場合、構文 menu.MenuItems.addElement(menuItem) を使用してメニュー項目を追加する必要があります。openUI がメニュー・オブジェクトと一緒に呼び出されたときに、メニュー項目が存在しない場合、ランタイム・エラーがスローされます。 |
MenuItem
MenuItem のすべての属性により、menu が定義されます。
次の表は、MenuItem フィールドの属性を定義します。 name 属性のみが必須です。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
accelerators | string[] | はい | 項目を活動化するアクセラレーター (キー・ストローク) の名前。 | |
commentKey | ストリング | はい | リソース内のコメントをルックアップするキー。comment が指定されている場合、この値は無視されます。 | |
comment | ストリング | はい | ディスプレイ内で項目が選択されたときに、コメント行に表示されるテキスト。 | |
helpMsgKey | ストリング | はい | リソース内のヘルプをルックアップするキー。help が指定されている場合、この値は無視されます。 | |
help | ストリング | はい | ヘルプ・キーが選択されているときに表示されるテキスト。 | |
labelKey | ストリング | はい | リソース内のラベルをルックアップするキー。 labelText が指定されている場合、この値は無視されます。 | |
labelText | ストリング | はい | 項目の表示名。 | |
name | ストリング | はい | 項目の名前。この名前は、OnEvent の処理中に使用されます。 この名前が指定されていない場合、内部アルゴリズムにより名前が計算されます。 |
Prompt
次の表は、Prompt フィールドの属性を定義します。 これらの属性のうち、messageKey 属性と responseAttr 属性のみが必須です。
属性 | 型 | デフォルトの振る舞い | 読み取り専用かどうか | 説明 |
---|---|---|---|---|
isChar | ブール | 偽 | はい | ユーザーにより入力された先頭文字が応答変数に置かれるかどうかを示します。
isChar = 偽 (false) の場合、ユーザーによって入力された文字は応答変数に置かれます。 isChar = 真 (true) の場合、ユーザーによって入力された文字は応答変数に置かれません。 |
message | ストリング | 偽 | いいえ | openUI (prompt) 文の間、ユーザーに対して表示されるリテラル・ストリング値。 |
messageKey | console Field | なし | はい | リソース・バンドル内のメッセージをルックアップするために使用されるキー値。messageKey と message の両方が指定されている場合、messageKey は無視されます。 |
response Attr | console Field | なし | はい | ユーザー入力を受け入れる際に使用される表示属性。 |