DEFINE.WINDOW command operands

window_name

The name of the window being defined. The name must be 1 to 8 alphanumeric characters, with the first character alphabetic.

row

specifies which row of the display screen the top line of the window is to occupy. row must be an integer n or -n, where n can be any number from 1 to the number of rows on the display screen. An integer of -n is relative to the bottom of the screen. For example, a row value of -4 on a 24 line screen means that the top line of the window is to be row 21.

column

specifies which column of the display screen the left side of the window is to occupy. column must be an integer n or -n, where n can be any number from 1 to the number of columns on the screen. An integer of -n is relative to the right side of the display screen. For example, a column value of -4 on an 80 column screen means that the left side of the window is to be in column 77.

lines | MAX

specifies the number of lines in the window. lines must be an integer n or the character string MAX. The value n can be any number from 1 to the number of lines on the display screen. MAX indicates that the window is to consist of the remaining lines on the display screen or until a line is encountered that has already been defined as part of another window.

width | MAX | WRAP

specifies the number of character positions in each line of the window. width can be an integer n or the character string MAX or WRAP.

width: can be any number from 1 (or the number defined as the starting column) to the physical width of the display screen.
MAX: indicates that the width of the window should be determined by the number of character positions available in the first line of the window (those not used by another window).
WRAP: indicates that the width of the window is to start from the column value specified with this command and continue to either the beginning of the next window or to the last row and column of the screen. WRAP can only be used when lines is defined as 1.

Note: The first character position in a window is used as a terminal attribute byte and is protected. Therefore, a window defined with a width of 1 is useless.

ALARM(YES | NO)

specifies whether the terminal's audible alarm is to sound when the Session Manager scrolls the window to display new information in the stream. If your terminal does not have an audible alarm, the Session Manager still accepts this operand. It has no way of knowing whether your terminal has an alarm.

HOLD(INPUT | seconds)

specifies how long the window (when unlocked) is to be held in place before it is scrolled toward the bottom of the stream.

INPUT: specifies that the window (when unlocked) be held in place until you supply input by pressing the Enter key or any program function (PF) key.
seconds: specifies that the window (when unlocked) be held in place the specified number of seconds before it is scrolled toward the bottom of the stream. seconds must be an integer from 0 to 999.
During the time the window is held in place, the keyboard remains locked. The keyboard unlocks when the time expires or when the window displays the bottom of the stream.

Note: The value specified on the CONTROL operand of the CHANGE.TERMINAL command overrides the value specified on this operand.

OVERLAP(lines)

specifies how many lines of the window's old position are to be repeated when the window scrolls to the new position.

lines must be an integer from 0 to 999. If you specify a value for lines that is greater than or equal to the number of lines in the window, the Session Manager adjusts the value to be the number of lines in the window minus one. Thus, at least the bottom line of the window's old position always appears at the top of the window's new position.

PROTECT(YES | NO)

specifies whether you can enter data in the window. You can enter data in an unprotected window only. If you try to enter data in a protected window, the keyboard locks.

TARGET(stream_name intensity)

stream_name

The name of the stream that is to receive the information entered in the window.

intensity

specifies the brightness at which the information in the stream is to be displayed. The valid values are:

0: The information in the stream is not to be displayed. You can see the line that the information occupies, but the information itself is invisible.
1: The information is to be displayed at normal intensity.
2: The information is to be highlighted.

UPDATE(LINE | NEWEST | PAGE)

specifies how much new information must enter the stream before the Session Manager updates the window. The window scrolls only when it is unlocked.

LINE: specifies that the window scroll sequentially toward the bottom of the stream. Thus, all of the new information is displayed as the window scrolls over the stream. When the window is full, it scrolls forward (repeating the number of lines specified by the OVERLAP operand) and the new information again starts to fill up the window.
NEWEST: specifies that the window always display the newest information in the stream. When new information enters the stream, the window scrolls directly to the bottom of the stream. Some information in the stream might be skipped over. Thus, if a large amount of information is sent to the stream in a short period of time, only the last few lines (the number of lines in the window) are displayed.
PAGE: specifies that the window scroll sequentially over the stream when there are enough new lines of information (minus the number of overlap lines) to fill the window. The window does not scroll to display the new information until enough additional information (a "page" of information) enters the stream.

VIEW(stream_name | TSOOUT)

The name of the stream that the window is to display. Initially, the Session Manager places the window at the bottom of the stream and unlocks the window.