Window fields in EGL consoleUI

The following list defines the fields in a variable of type Window. None of the fields is required, but size is needed in practice.
color
Specifies the color that is used when displaying the following kinds of output in the window:
  • Labels in consoleForms
  • Input fields in prompts
  • Window border
  • Output of system functions such as ConsoleLib.displayAtPosition
  • Type: ColorKind
  • Example: color = red
  • Default: white
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated
Values are as follows:
defaultColor or white (the default)
White
black
Black
blue
Blue
cyan
Cyan
green
Green
magenta
Magenta
red
Red
yellow
Yellow
commentLine
Sets the number of the line at which a comment (if any) is displayed if the Window field hasCommentLine is set to yes. The line number is calculated from the top of the screen window's content area (in which case the first line is 1) or (if the value is negative) from the bottom of that area (in which case the last line is -1, the second-to-last is -2, and so on).
  • Type: INT
  • Example: commentLine = 10
  • Default: Last line of the window (although if only the screen window is open, the comment is on the second to last line of that window)
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated

The validity of the value is determined only at run time.

formLine
Sets the number of the line at which forms are displayed. The line number is calculated from the top of the screen window's content area (in which case the first line is 1) or (if the value is negative) from the bottom of that area (in which case the last line is -1, the second-to-last is -2, and so on).
  • Type: INT
  • Example: formLine = 8
  • Default: 3
  • Updatable at run time? Yes, but the update has a visual effect only if the window is displayed after the field is updated

The validity of the value is determined only at run time.

hasBorder
Indicates whether the window is surrounded by a border. If the value is yes, the color of the border is specified in the Window field color.
  • Type: Boolean
  • Example: hasBorder = yes
  • Default: no
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated
hasCommentLine
Indicates whether the window reserves a line for comments, which are text entries that are displayed when the cursor enters a consoleField. If the value is yes, the line number is specified in the Window field commentLine.
  • Type: Boolean
  • Example: hasCommentLine = yes
  • Default: no
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated
highlight
Specifies the special effects (if any) that are used when displaying the following kinds of output in the window:
  • Labels in consoleForms
  • Input fields in prompts
  • Window border
  • Output of system functions such as ConsoleLib.displayAtPosition
  • Type: HighlightKind[]
  • Example: highlight = [reverse, underline]
  • Default: [noHighLight]
  • Updatable at run time? Yes, but the update has a visual effect only if the window is displayed after the field is updated
Values are as follows:
noHighlight (the default)
Causes no special effect. Use of this value overrides any other.
blink
Has no effect at this time.
reverse
Reverses the text and background colors so that (for example) if the display has a black background with white letters, the background becomes white and the text becomes black.
underline
Places an underline under the affected areas. The color of the underline is the color of the text, even if the color of the text has been reversed because you also specified the value Reverse.
intensity
Specifies the strength of the displayed font that is used when displaying the following kinds of output in the window:
  • Labels in consoleForms
  • Input fields in prompts
  • Window border
  • Output of system functions such as ConsoleLib.displayAtPosition
  • Type: IntensityKind[]
  • Example: intensity = [bold]
  • Default: [normalIntensity]
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated
Values are as follows:
normalIntensity (the default)
Causes no special effect. Use of this value overrides any other.
bold
Causes the text to appear in a bold-weight font.
dim
Has no effect at this time. In future, may cause the text to appear with a lessened intensity, as appropriate when all input fields are disabled.
invisible
Removes any indication that the field is on the form.
menuLine
Sets the number of the line at which a menu (if any) is displayed in the Window. The line number is calculated from the top of the screen window's content area (in which case the first line is 1) or (if the value is negative) from the bottom of that area (in which case the last line is -1, the second-to-last is -2, and so on).
  • Type: INT
  • Example: menuLine = 2
  • Default: 1
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated

The validity of the value is determined only at run time.

messageLine
Sets the number of the line at which a message (if any) is displayed in the Window. The line number is calculated from the top of the screen window's content area (in which case the first line is 1) or (if the value is negative) from the bottom of that area (in which case the last line is -1, the second-to-last is -2, and so on).
  • Type: INT
  • Example: messageLine = 3
  • Default: 2
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated

The validity of the value is determined only at run time.

name
Window name, as used in a programming context in which the name is resolved at run time. It is recommended that the value of the name field be the same as the name of the variable.
  • Type: String
  • Example: name = "myWindow"
  • Default: none
  • Updatable at run time? No
position
The location of the top left corner of the window within the content area of the screen window. The field contains an array of two integers: the line number followed by the column number. The line number is calculated from the top of the screen window's content area (in which case the first line is 1) or (if the value is negative) from the bottom of that area (in which case the last line is -1, the second-to-last is -2, and so on). The column number is calculated from the left of the console window's content area, and the first column is 1.
  • Type: INT[2]
  • Example: position = [2, 3]
  • Default: [1,1]
  • Updatable at run time? No
promptLine
Sets the number of the line at which a prompt (if any) is displayed in the Window. The line number is calculated from the top of the console window's content area or (if the value is negative) from the bottom of that area.
  • Type: INT
  • Example: promptLine = 4
  • Default: 1
  • Updatable at run time? Yes, but the update has a visual effect only if you open the window after the field is updated

The validity of the value is determined only at run time.

size
An array of two positive integers that represent window dimensions: the number of lines followed by the number of columns.
  • Type: INT[2]
  • Example: size = [24, 80]
  • Default: none
  • Updatable at run time? No

A value is required for practical purposes. If you display a window that lacks a value for size, the run time presents a window that is too small for content.

If either dimension exceeds the size available in the content area of the screen window, an error occurs at run time.

Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.