EGL ライブラリー consoleLib

consoleLib ライブラリーは、EGL プログラムにコンソール UI 機能を提供します。 consoleLib 修飾子 (例えば、consoleLib.activateWindow()) の使用はオプションです。

次の表に、consoleLib の関数と変数をリストします。

表 1. consoleLib の関数
関数 説明
activateWindow (window ) 指定されたウィンドウをアクティブ・ウィンドウにし、consoleLib activeWindow 変数を更新します。
activateWindowByName (name) 指定されたウィンドウをアクティブ・ウィンドウにし、consoleLib activeWindow 変数を更新します。
cancelArrayDelete () BEFORE_DELETE openUI イベント・コード・ブロックの実行中に、進行中の削除操作を中断します。
cancelArrayInsert () BEFORE_INSERT openUI イベント・コード・ブロックの実行中に、進行中の挿入操作を中断します。
clearActiveForm () すべてのフィールドのディスプレイ・バッファーをクリアします。
clearActiveWindow () 表示されているすべての素材をアクティブ・ウィンドウから除去します。
clearFields ([consoleField{, consoleField}]) アクティブな書式で指定されたフィールドのディスプレイ・バッファーをクリアします。 フィールドが指定されていない場合、その書式のすべてのフィールドがクリアされます。
clearFieldsByName (fieldName{, fieldName}) アクティブな書式で指定されたフィールドのディスプレイ・バッファーをクリアします。 フィールドが指定されていない場合、その書式のすべてのフィールドがクリアされます。
clearForm (consoleForm) すべてのフィールドのディスプレイ・バッファーをクリアします。
clearWindow (window) 表示されているすべての素材を指定のウィンドウから除去します。
clearWindowByName (name) 表示されているすべての素材を指定のウィンドウから除去します。
closeActiveWindow () 画面からウィンドウをクリアし、 そのウィンドウに関連したリソースを解放し、以前にアクティブであったウィンドウをアクティブにします。
closeWindow (window) 画面からウィンドウをクリアし、 そのウィンドウに関連したリソースを解放し、以前にアクティブであったウィンドウをアクティブにします。
closeWindowByName (name) 画面からウィンドウをクリアし、 そのウィンドウに関連したリソースを解放し、以前にアクティブであったウィンドウをアクティブにします。
result = currentArrayCount () 現在のアクティブな書式に関連付けられている動的配列の要素数を戻します。
result = currentArrayDataLine () openUI 文の処理中またはその直後に画面配列の現在行に表示される、 プログラム配列内のプログラム・レコードの番号を戻します。
result = currentArrayScreenLine () openUI 文の処理中に画面配列内の現在の画面レコードの番号を戻します。
displayAtLine (text, line) アクティブ・ウィンドウ内の指定場所にストリングを表示します。
displayAtPosition (text, line, column) アクティブ・ウィンドウ内の指定場所にストリングを表示します。
displayError (msg) エラー・ウィンドウを作成し、表示し、 そのウィンドウ内にエラー・メッセージを表示します。
displayFields ([consoleField{, consoleField}]) コンソールに対する書式フィールド値を表示します。
displayFieldsByName (consoleFieldName{, consoleFieldName}) コンソールに対する書式フィールド値を表示します。
displayForm (consoleForm) アクティブ・ウィンドウに書式を表示します。
displayFormByName (formName) アクティブ・ウィンドウに書式を表示します。
displayLineMode (text) 書式/ウィンドウ・モードではなく、行モードでストリングを表示します。
displayMessage (msg) アクティブ・ウィンドウ内の指定場所にストリングを表示し、 そのアクティブ・ウィンドウの messageLine プロパティーを使用して、 ストリングの表示場所を識別します。
drawBox (row, column, depth, width) 指定のロケーションと寸法で、 アクティブ・ウィンドウに長方形を描画します。
drawBoxWithColor (row, column, depth, width, color) 指定のロケーション、寸法、および色で、 アクティブ・ウィンドウに長方形を描画します。
result = getKey () 入力からキーを読み取り、そのキーの整数コードを戻します。
result = getKeyCode (keyName) ストリング内の指定のキーのキー整数コードを戻します。
result = getKeyName (keyCode) 整数キー・コードを表す名前を戻します。
gotoField (consoleField) 指定の書式フィールドにカーソルを移動します。
gotoFieldByName (name) 指定の書式フィールドにカーソルを移動します。
gotoMenuItem (item) 指定のメニュー項目にメニュー・カーソルを移動します。
gotoMenuItemByName (name) 指定のメニュー項目にメニュー・カーソルを移動します。
hideAllMenuItems () 現在表示されているメニュー内のすべてのメニュー項目を非表示にします。
hideErrorWindow () エラー・ウィンドウを非表示にします。
hideMenuItem (item) ユーザーが選択できないように指定のメニュー項目を非表示にします。
hideMenuItemByName (name) ユーザーが選択できないように指定のメニュー項目を非表示にします。
result = isCurrentField (consoleField) カーソルが指定の書式フィールド内にある場合、YES を戻します。
result = isCurrentFieldByName (name) カーソルが指定の書式フィールド内にある場合、YES を戻します。
result = isFieldModified (consoleField) ユーザーが指定の書式フィールドの内容を変更した場合、YES を戻します。
result = isFieldModifiedByName (name) ユーザーが指定の書式フィールドの内容を変更した場合、YES を戻します。
result = lastKeyTyped () キーボードで最後に押された物理キーの整数コードを戻します。
nextField () 定義されたフィールド移動順序にしたがって、 次の書式フィールドにカーソルを移動します。
result = openFileDialog (currentFile) ディスクからファイルを選択するようユーザーにプロンプトを出すダイアログを開きます。
openWindow (window) ウィンドウを可視にし、 そのウィンドウをウィンドウ・スタックの一番上に追加します。 書式がウィンドウに表示されます。
openWindowByName (name) ウィンドウを可視にし、 そのウィンドウをウィンドウ・スタックの一番上に追加します。
openWindowWithForm (window, form) ウィンドウを可視にし、 そのウィンドウをウィンドウ・スタックの一番上に追加します。 ウィンドウの宣言時にウィンドウ・サイズが定義されていない場合は、 ウィンドウのサイズが変更されて指定の書式が保持されます。
openWindowWithFormByName (windowName, formName) ウィンドウを可視にし、 そのウィンドウをウィンドウ・スタックの一番上に追加します。
previousField () 定義されたフィールド移動順序にしたがって、 前の書式フィールドにカーソルを移動します。
result = promptLineMode (prompt) 行モード環境で、ユーザーに対するプロンプト・メッセージを表示します。
scrollDownLines (numLines) 表示されたデータを画面の下部に向かって指定された行数分スクロールします。
scrollDownPage () 表示されたデータを画面の下部に向かって 1 ページ分スクロールします。
scrollUpLines (numLines) 表示されたデータを画面の上部に向かって指定された行数分スクロールします。
scrollUpPage () 表示されたデータを画面の上部に向かって 1 ページ分スクロールします。
setArrayLine (recordNumber) 指定のプログラム・レコードに選択を移動します。 必要に応じて、データ・テーブルがディスプレイ内でスクロールされ、 選択されたレコードが見えるようになります。
setCurrentArrayCount (count ) プログラム配列内に存在するレコード数を設定します。 openUI 文の前に呼び出す必要があります。
showAllMenuItems () ユーザー選択のすべてのメニュー項目を表示します。
showHelp (helpkey) EGL プログラムの処理の間にコンソール UI のヘルプ画面を表示します。
showMenuItem (item) ユーザー選択の指定のメニュー項目を表示します。
showMenuItemByName(name) ユーザー選択の指定のメニュー項目を表示します。
updateWindowAttributes(attribute {, attribute}) 現行のアクティブ・ウィンドウの 1 つ以上の属性の更新。
表 2. consoleLib の変数
変数 説明
activeForm アクティブ・ウィンドウに最も新しく表示される書式。
activeWindow 最上位ウィンドウであり、 ウィンドウ名が指定されない場合のウィンドウ操作のターゲットです。
commentLine コメント・メッセージが表示されるウィンドウ行。
currentDisplayAttrs 表示関数を介して表示される要素に適用される設定値。
currentRowAttrs 現在行に適用される属性を強調表示します。
cursorWrap YES の場合、カーソルは折り返して書式の先頭フィールドに進みます。 NO の場合、カーソルが書式の最後の入力フィールドから先に移動すると文が終了します。
defaultDisplayAttributes 新規オブジェクトの表示属性のデフォルト設定値。
defaultInputAttributes 入力操作の表示属性のデフォルト設定値。
deferInterrupt YES の場合、プログラムは INTR シグナルをキャッチして interruptRequested 変数に記録します。 そのモニターは、プログラムが担当します。 Windows では、論理 INTERRUPT キー (デフォルトで Ctrl+C) が押されると、シグナルがシミュレートされます。
deferQuit YES の場合、プログラムは QUIT シグナルをキャッチして interruptRequested 変数に記録します。 そのモニターは、プログラムが担当します。 Windows では、論理 QUIT キー (デフォルトで CONTROL_¥) が押されると、シグナルがシミュレートされます。
definedFieldOrder YES の場合、上下の矢印キーが、タブの順序で前または次のフィールドに移動します。 NO の場合、上または下の同等のフィールドへ上下に移動します。
errorLine エラー・メッセージが表示されるウィンドウ。
errorWindow ConsoleUI 画面でエラー・メッセージが表示されるウィンドウ・ロケーション。
errorWindowVisible YES の場合、画面に現行でエラー・ウィンドウが表示されます。
formLine 書式が表示されるウィンドウ行。
interruptRequested YES の場合、INTR シグナルは受信 (またはシミュレート) 済みです。
key_accept openUI 文の正常終了のキー。 デフォルトのキーは ESCAPE です。
key_deleteLine 画面配列から現在の行を削除するためのキー。 デフォルトのキーは F2 です。
key_help openUI 文の処理中にコンテキスト・ヘルプを表示するためのキー。 デフォルトのキーは CTRL+W です。
key_insertLine 画面配列に行を挿入するためのキー。 デフォルトのキーは F1 です。
key_interrupt INTR シグナルをシミュレートするためのキー。デフォルトのキーは Ctrl+C です。
key_pageDown 画面配列 (データ・テーブル) 内で順方向にページングするためのキー。 デフォルトのキーは F3 です。
key_pageUp 画面配列 (データ・テーブル) 内で逆方向にページングするためのキー。 デフォルトのキーは F4 です。
key_quit QUIT シグナルをシミュレートするためのキー。 デフォルトのキーは Ctrl+¥ です。
menuLine メニューが表示されるウィンドウ行。
messageLine メッセージが表示されるウィンドウ行。
messageResource リソース・バンドルのファイル名。
promptLine ウィンドウ内でプロンプトが表示される行の番号。
quitRequested YES の場合、QUIT シグナルは受信 (またはシミュレート) 済みです。
screen 自動的に定義される、境界線のないデフォルト・ウィンドウ。 寸法は、使用可能な表示面の寸法と同じです。
sqlInterrupt YES の場合、ユーザーは処理中の SQL 文に割り込むことができます。 NO の場合、ユーザーは openUI 文のみに割り込むことができます。 consoleLib.deferInterrupt 変数や consoleLib.deferQuit 変数と組み合わせて使用します。

互換性

表 3. consoleLib の互換性に関する考慮事項
プラットフォーム 問題
COBOL 生成 consoleLib 関数はサポートされません。

フィードバック