EGL-Bibliothek 'consoleLib'

Die Bibliothek 'consoleLib' stellt die Konsol-UI-Funktionalität für EGL-Programme bereit. Die Verwendung des Qualifikationsmerkmals 'consoleLib' (zum Beispiel consoleLib.activateWindow()) ist optional.

In den folgenden Tabellen sind die Funktionen und Variablen in 'consoleLib' aufgelistet.

Tabelle 1. Funktionen in 'consoleLib'
Funktion Beschreibung
activateWindow (window) Macht das angegebene Fenster zum aktiven Fenster und aktualisiert die consoleLib-Variable activeWindow.
activateWindowByName (name) Macht das angegebene Fenster zum aktiven Fenster und aktualisiert die consoleLib-Variable activeWindow.
cancelArrayDelete () Unterbricht eine laufende Löschoperation während eines openUI-Ereigniscodeblocks BEFORE_DELETE.
cancelArrayInsert () Unterbricht eine laufende Einfügeoperation während eines openUI-Ereigniscodeblocks BEFORE_INSERT.
clearActiveForm () Löscht die Anzeigepuffer aller Felder.
clearActiveWindow () Entfernt alle angezeigten Materialien aus dem aktiven Fenster.
clearFields ([consoleField{, consoleField}]) Löscht die Anzeigepuffer der angegebenen Felder im aktiven Formular. Sind keine Felder angegeben, werden alle Felder des Formulars gelöscht.
clearFieldsByName (fieldName{, fieldName}) Löscht die Anzeigepuffer der genannten Felder im aktiven Formular. Wenn keine Felder genannt sind, werden alle Felder des Formulars gelöscht.
clearForm (consoleForm) Löscht die Anzeigepuffer aller Felder.
clearWindow (window) Entfernt alle angezeigten Materialien aus dem angegebenen Fenster.
clearWindowByName (name) Entfernt alle angezeigten Materialien aus dem angegebenen Fenster.
closeActiveWindow () Löscht das Fenster aus der Anzeige, gibt die Ressourcen frei, die diesem Fenster zugeordnet waren, und aktiviert das zuvor aktive Fenster.
closeWindow (window) Löscht das Fenster aus der Anzeige, gibt die Ressourcen frei, die diesem Fenster zugeordnet waren, und aktiviert das zuvor aktive Fenster.
closeWindowByName (name) Löscht das Fenster aus der Anzeige, gibt die Ressourcen frei, die diesem Fenster zugeordnet waren, und aktiviert das zuvor aktive Fenster.
result = currentArrayCount () Gibt die Anzahl von Elementen in der dynamischen Feldgruppe zurück, die dem aktuell aktiven Formular zugeordnet ist.
result = currentArrayDataLine () Gibt die Nummer des Programmdatensatzes in der Programmfeldgruppe zurück, der in der aktuellen Zeile einer Anzeigefeldgruppe während oder direkt nach der Anweisung openUI angezeigt wird.
result = currentArrayScreenLine () Gibt die Nummer des aktuellen Anzeigedatensatzes in seiner Anzeigefeldgruppe während einer Anweisung openUI zurück.
displayAtLine (text, line) Zeigt eine Zeichenfolge an einer angegebenen Position im aktiven Fenster an.
displayAtPosition (text, line, column) Zeigt eine Zeichenfolge an einer angegebenen Position im aktiven Fenster an.
displayError (msg) Bewirkt, dass das Fehlernachrichtenfenster erstellt und angezeigt wird, und blendet die Fehlernachricht in diesem Fenster ein.
displayFields ([consoleField{, consoleField}]) Zeigt Formularfeldwerte in der Konsole an.
displayFieldsByName (consoleFieldName{, consoleFieldName}) Zeigt Formularfeldwerte in der Konsole an.
displayForm (consoleForm) Zeigt das Formular im aktiven Fenster an.
displayFormByName (formName) Zeigt das Formular im aktiven Fenster an.
displayLineMode (text) Zeigt eine Zeichenfolge im Zeilenmodus statt im Formular-/Fenstermodus an.
displayMessage (msg) Zeigt eine Zeichenfolge an einer angegebenen Position im aktiven Fenster an und verwendet die Eigenschaft messageLine des aktiven Fensters, um anzugeben, wo die Zeichenfolge angezeigt werden soll.
drawBox (row, column, depth, width) Zeichnet ein Rechteck im aktiven Fenster an der angegebenen Position und mit den angegebenen Abmessungen.
drawBoxWithColor (row, column, depth, width, color) Zeichnet ein Rechteck im aktiven Fenster, an der angegebenen Position, mit den angegebenen Abmessungen und mit der angegebenen Farbe.
result = getKey () Liest eine Taste aus der Eingabe und gibt den ganzzahligen Code für die Taste zurück.
result = getKeyCode (keyName) Gibt den ganzzahligen Code der benannten Taste in der Zeichenfolge zurück.
result = getKeyName (keyCode) Gibt den Namen zurück, der den ganzzahligen Tastencode darstellt.
gotoField (consoleField) Verschiebt den Cursor in das angegebene Formularfeld.
gotoFieldByName (name) Verschiebt den Cursor in das angegebene Formularfeld.
gotoMenuItem (item) Verschiebt den Menücursor zum angegebenen Menüpunkt.
gotoMenuItemByName (name) Verschiebt den Menücursor zum angegebenen Menüpunkt.
hideAllMenuItems () Verdeckt alle Menüpunkte im aktuell angezeigten Menü.
hideErrorWindow () Blendet das Fehlernachrichtenfenster aus.
hideMenuItem (item) Blendet einen angegebenen Menüpunkt aus, damit er nicht von einem Benutzer ausgewählt werden kann.
hideMenuItemByName (name) Blendet einen angegebenen Menüpunkt aus, damit er nicht von einem Benutzer ausgewählt werden kann.
result = isCurrentField (consoleField) Gibt YES zurück, wenn der Cursor sich im angegebenen Formularfeld befindet.
result = isCurrentFieldByName (name) Gibt YES zurück, wenn der Cursor sich im angegebenen Formularfeld befindet.
result = isFieldModified (consoleField) Gibt YES zurück, wenn der Benutzer den Inhalt des angegebenen Formularfelds geändert hat.
result = isFieldModifiedByName (name) Gibt YES zurück, wenn der Benutzer den Inhalt des angegebenen Formularfelds geändert hat.
result = lastKeyTyped () Gibt den ganzzahligen Code der Taste zurück, die zuletzt auf der Tastatur gedrückt wurde.
nextField () Verschiebt den Cursor in das nächste Formularfeld gemäß der definierten Feldreihenfolge.
result = openFileDialog (currentFile) Öffnet ein Dialogfenster, in dem der Benutzer aufgefordert wird, eine Datei vom Datenträger zu lesen.
openWindow (window) Macht ein Fenster sichtbar und fügt es vor allen anderen angezeigten Fenstern hinzu. Das Formular wird im Fenster angezeigt.
openWindowByName (name) Macht ein Fenster sichtbar und fügt es vor allen anderen angezeigten Fenstern hinzu.
openWindowWithForm (window, form) Macht ein Fenster sichtbar und fügt es vor allen anderen angezeigten Fenstern hinzu. Die Größe des Fensters passt sich an das angegebene Formular an, wenn sie nicht während der Deklaration des Fensters definiert wurde.
openWindowWithFormByName (windowName, formName) Macht ein Fenster sichtbar und fügt es vor allen anderen angezeigten Fenstern hinzu.
previousField () Verschiebt den Cursor in das vorherige Formularfeld gemäß der definierten Feldreihenfolge.
result = promptLineMode (prompt) Zeigt eine Eingabeaufforderung für den Benutzer in einer Zeilenmodusumgebung an.
scrollDownLines (numLines) Blättert in der Anzeige um die angegebene Anzahl von Zeilen nach unten.
scrollDownPage () Blättert in der Anzeige um eine Seite nach unten.
scrollUpLines (numLines) Blättert in der Anzeige um die angegebene Anzahl von Zeilen nach oben.
scrollUpPage () Blättert in der Anzeige um eine Seite nach oben.
setArrayLine (recordNumber) Verschiebt die Auswahl in den angegebenen Programmdatensatz. Gegebenenfalls wird in der Anzeige geblättert, um den ausgewählten Datensatz sichtbar zu machen.
setCurrentArrayCount (count ) Legt fest, wie viele Datensätze in der Programmfeldgruppe vorhanden sind. Diese Funktion muss vor der Anweisung openUI aufgerufen werden.
showAllMenuItems () Zeigt alle Menüpunkte an, die der Benutzer auswählen kann.
showHelp (helpkey) Zeigt während der Verarbeitung des EGL-Programms eine Hilfetextanzeige der Konsol-UI an.
showMenuItem (item) Zeigt den angegebenen Menüpunkt an, den der Benutzer auswählen kann.
showMenuItemByName(name) Zeigt den angegebenen Menüpunkt an, den der Benutzer auswählen kann.
updateWindowAttributes(attribute {, attribute}) Aktualisiert mindestens ein Attribut des aktuell aktiven Fensters.
Tabelle 2. Variablen in 'consoleLib'
Variablen Beschreibung
activeForm Das zuletzt anzeigte Formular im aktiven Fenster.
activeWindow Das zuoberst angezeigte Fenster. Dies ist das Ziel für Fensteroperationen, wenn kein Fenstername angegeben ist.
commentLine Die Fensterzeile, in der Kommentare angezeigt werden.
currentDisplayAttrs Einstellungen für die Elemente, die über die Anzeigefunktionen angezeigt werden.
currentRowAttrs Hervorhebungsattribute der aktuellen Zeile.
cursorWrap Falls YES, kehrt der Cursor zurück in das erste Feld im Formular. Falls NO, endet die Anweisung, wenn der Cursor das letzte Eingabefeld im Formular verlässt.
defaultDisplayAttributes Standardeinstellungen der Darstellungsattribute für neue Objekte.
defaultInputAttributes Die Standardeinstellungen der Darstellungsattribute für Eingabeoperationen.
deferInterrupt Falls YES, fängt das Programm INTR-Signale ab und protokolliert sie in der Variablen interruptRequested, die das Programm anschließend überwachen muss. Unter Windows wird das Signal simuliert, wenn die logische Taste INTERRUPT (standardmäßig CONTROL_C) gedrückt wird.
deferQuit Falls YES, fängt das Programm QUIT-Signale ab und protokolliert sie in der Variablen interruptRequested, die das Programm anschließend überwachen muss. Unter Windows wird das Signal simuliert, wenn die logische Taste QUIT (standardmäßig CONTROL_\) gedrückt wird.
definedFieldOrder Falls YES, springt die Aufwärts- und Abwärtspfeiltaste in die vorherigen und nächsten Felder gemäß der Tabulatorreihenfolge. Falls NO, springt die Aufwärts- und Abwärtspfeiltaste in das nächste vergleichbare Feld nach oben bzw. nach unten.
errorLine Das Fenster, in dem Fehlernachrichten angezeigt werden.
errorWindow Die Fensterposition, an der Fehlernachrichten in der Anzeige der Konsolenbenutzerschnittstelle angezeigt werden.
errorWindowVisible Falls YES, wird das Fehlernachrichtenfenster aktuell in der Anzeige angezeigt.
formLine Die Fensterzeile, in der Formulare angezeigt werden.
interruptRequested Falls YES, wurde ein INTR-Signal empfangen (oder simuliert).
key_accept Taste für ein erfolgreiches Beenden von openUI-Anweisungen. Die Standardtaste ist ESCAPE.
key_deleteLine Taste für das Löschen der aktuellen Zeile aus einer Anzeigefeldgruppe. Die Standardtaste ist F2.
key_help Taste für das Anzeigen der Kontexthilfe während openUI-Anweisungen. Die Standardtaste ist CTRL_W.
key_insertLine Taste für das Einfügen einer Zeile in eine Anzeigefeldgruppe. Die Standardtaste ist F1.
key_interrupt Taste für das Simulieren eines INTR-Signals. Die Standardtaste ist CONTROL_C.
key_pageDown Taste für das Vorblättern in einer Anzeigefeldgruppe (einer Datentabelle). Die Standardtaste ist F3.
key_pageUp Taste für das Rückblättern in einer Anzeigefeldgruppe (einer Datentabelle). Die Standardtaste ist F4.
key_quit Taste für das Simulieren eines QUIT-Signals. Die Standardtaste ist CONTROL_\.
menuLine Die Fensterzeile, in der Menüs angezeigt werden.
messageLine Die Fensterzeile, in der Nachrichten angezeigt werden.
messageResource Der Dateiname des Ressourcenpakets.
promptLine Die Nummer der Zeile, in der Eingabeaufforderungen in einem Fenster angezeigt werden.
quitRequested Falls YES, wurde ein QUIT-Signal empfangen (oder simuliert).
screen Automatisch definiertes Standardfenster ohne Rahmen. Die Abmessungen passen sich an die verfügbare Anzeigefläche an.
sqlInterrupt Falls YES, kann der Benutzer in Verarbeitung befindliche SQL-Anweisungen unterbrechen. Falls NO, kann der Benutzer nur openUI-Anweisungen unterbrechen. Diese Variable wird in Kombination mit den Variablen consoleLib.deferInterrupt und consoleLib.deferQuit verwendet.

Kompatibilität

Tabelle 3. Überlegungen zur Kompatibilität für 'consoleLib'
Plattform Problem
COBOL-Generierung Es werden keine 'consoleLib'-Funktionen unterstützt.

Feedback