BODYHEADER

Purpose

The BODYHEADER statement is used to define a descriptive header and the scrolling information of the body section. The length of the header is implicitly defined by the body width.
Note: The scrolling information is only displayed when the header is long enough to show the complete information, that is, "␢nn/nnn(nnn)". It may overwrite the title defined by BODYTEXT.

Syntax

Read syntax diagramSkip visual syntax diagramBODYHEADERBH
Read syntax diagramSkip visual syntax diagram( start_line
Read syntax diagramSkip visual syntax diagram , Leftalignment
Read syntax diagramSkip visual syntax diagram , Scrollinfoscroll_info
Read syntax diagramSkip visual syntax diagram,Neutral color
Read syntax diagramSkip visual syntax diagram,Normalhighlight
Read syntax diagramSkip visual syntax diagram , fill_chars
Read syntax diagramSkip visual syntax diagram,body_start_posstart_pos
Read syntax diagramSkip visual syntax diagram,body_end_posend_pos)

Parameters

start_line
The line number that the header should be displayed on. You can specify either the absolute number or use relative addressing based on the bottom line of the panel. Relative addressing uses a notation of *-n where n is the displacement from the bottom line.
alignment
The justification of the text specified in the corresponding BODYTEXT statement. It can be one of the following:
C
Center
L
Left (default)
scroll_info
Specifies whether scroll information is displayed or not. It can be one of the following:
S
Scroll information is displayed right-justified at the end of the header line (default).
N
No scroll information is displayed.
color
The color that the text specified in the corresponding BODYTEXT statement is displayed in. It can be one of the following:
B
Blue
G
Green
N
Neutral (=White)
P
Pink
R
Red
T
Turquoise
W
White
Y
Yellow
BLA
Black
NAV
Navy (Deep Blue in 3270 terms)
ORA
Orange
PUR
Purple
MIN
Mint (Pale Green in 3270 terms)
CEL
Celeste (Pale Turquoise in 3270 terms)
GRA
Gray
IVO
Ivory (x'FF'-White in 3270 terms)
highlight
Specifies the type of highlighting to be used for information units of the status component. The value can be one of the following:
N
Normal (default)
B
Blink
R
Reverse
U
Underscore
fill_chars
You can specify a string of up to 6 characters that replaces the spaces in the header line.
start_pos
Specifies the column number where the header line begins. The default is the start column of the body section. You can specify either the absolute number or use relative addressing based on the width of the panel. Relative addressing uses a notation of *-n where n is the displacement from the rightmost column. The resulting value must be in the range specified in the width parameter in the PANEL definition statement (see PANEL) and must not be greater than end_pos.
end_pos
Specifies the column number where the header line ends. The default is the end column of the body section. You can specify either the absolute number or use relative addressing based on the width of the panel. Relative addressing uses a notation of * or *-n where n is the displacement from the rightmost column.

Restrictions and Limitations

Not more than one header can be specified per body.

This statement must follow its associated 'BODY' definition statement.

Examples

This example defines the header line being on line 3. The title is centered and supplemented with scroll information on the right side. Spaces are replaced by hyphens. The whole text is displayed in turquoise, and uses reverse highlighting. 

BH(03,Center,,Turquoise,Reverse,-)