GRPHDR (Group Header)

The GRPHDR tag allows the creation of group headers on ISPF panels.

Syntax


>>-<GRPHDR--+--------------------+--+---------+----------------->
            |         .-START--. |  '-WIDTH=n-'   
            '-FORMAT=-+-CENTER-+-'                
                      +-END----+                  
                      '-NONE---'                  

>--+------------+--+----------+--+-------------------+---------->
   '-FMTWIDTH=n-'  '-INDENT=n-'  |           .-NO--. |   
                                 '-HEADLINE=-+-YES-+-'   

>--+----------------+--+--------------------+--+---------+------>
   |      .-NONE--. |  |         .-AFTER--. |  '-COMPACT-'   
   '-DIV=-+-BLANK-+-'  '-DIVLOC=-+-BEFORE-+-'                
          +-SOLID-+              '-BOTH---'                  
          '-DASH--'                                          

>--+-------+-->--+--------------------+--+-----------+---------><
   '-STRIP-'     '-group-heading-text-'  '-</GRPHDR>-'

Parameters

FORMAT=START | CENTER | END | NONE

This attribute specifies the type of group header formatting.

When FORMAT=NONE, the lines of group-heading-text are placed in the panel )BODY section without alteration. The processing is similar to the LINES tag.

When the values START, CENTER, or END are specified, the data is processed in a manner similar to the P tag. The group-heading-text is read and flowed to fit within the width limit specified by FMTWIDTH. Multiple lines may be added to the panel, depending on the length of the group-heading-text.

WIDTH=n

This attribute specifies the number of columns reserved for the group heading. The minimum width for a group heading is 4. The maximum value is the remaining panel width. If WIDTH is not specified, the default value is set to the remaining panel width. The conversion utility uses 2 positions from the specified or default WIDTH for attributes.

FMTWIDTH=n

This attribute specifies the number of columns to use for formatting the group-heading-text. The minimum formatting width is 2. The maximum value is the value specified or defaulted for WIDTH. If FMTWIDTH is not specified, the default value is set to the value of WIDTH.

INDENT=n

This attribute specifies that the group heading is to be indented from the current position.

HEADLINE=NO | YES

This attribute specifies whether dashes are added to span the width of the group heading not occupied by text. This allows a visual indication of the width of the group heading.

DIV=NONE | BLANK | SOLID | DASH

This attribute specifies the type of divider line to be placed before and after the group heading. If this attribute is not specified or has the value NONE, no divider line is generated. The value BLANK produces a blank line. You must specify SOLID or DASH to produce a visible divider line. When the GRAPHIC invocation option is specified, SOLID produces a solid line for host display and DASH produces a dashed line. When NOGRAPHIC is specified or the panel is displayed in GUI mode, both SOLID and DASH produce a dashed line.

DIVLOC=AFTER | BEFORE | BOTH

This attribute specifies whether a divider line is to be added after the group heading, before the group heading or both before and after the group heading.

COMPACT

This attribute causes the group heading to format without a blank before the heading.

STRIP

This attribute causes leading and trailing blanks to be removed from the heading.

group-heading-text

This is the text of the group header. If no group-heading-text is provided, a blank line is added to the panel unless the COMPACT attribute is also specified.

Comments

The GRPHDR tag defines a group heading in the panel )BODY section.

The FMTWIDTH and HEADLINE attributes are not valid in combination with FORMAT=NONE. The DIVLOC attribute is not valid in combination with DIV=NONE.

You use the FMTWIDTH attribute to control the width of flowed text within the number of columns specified by WIDTH. The FORMAT attribute controls the placement of the resulting lines within the heading WIDTH. The FMTWIDTH attribute has no effect if the length of the group-heading-text is less than the value specified.

Because the group heading is formatted as text, a blank line is placed at the beginning of each group heading unless the COMPACT attribute has been specified. However, when the group heading is the first item in a scrollable region the blank line is not generated.

Restrictions

You must code the GRPHDR tag within a PANEL, AREA, DTACOL, or REGION tag. If found anywhere else, an error is logged and the output panel is not saved.

Processing

Table 1. The tags you can code within a GRPHDR definition
Tag	Reference	Usage	Required
HP	HP (Highlighted Phrase)	Multiple	No
PS	PS (Point-and-Shoot)	Multiple	No
RP	RP (Reference Phrase)	Multiple	No

Examples

<!DOCTYPE DM SYSTEM>
  <!entity sampvar1 system>
  <!entity sampabc system>)>
&sampvar1;

<PANEL NAME=grphdr KEYLIST=keylxmp>Library Card Registration
<AB>
&sampabc;
</AB>
<TOPINST> Type in patron's name and card number (if applicable)
<AREA>
  <GRPHDR FORMAT=center WIDTH=50 FMTWIDTH=30 DIV=solid COMPACT>
        Data Field Group Heading
  </GRPHDR>
  <DTACOL PMTWIDTH=12 ENTWIDTH=25 DESWIDTH=25 SELWIDTH=25>
    <DTAFLD DATAVAR=curdate USAGE=out ENTWIDTH=8>Date
    <DTAFLD DATAVAR=cardno ENTWIDTH=7>Card No.
      <DTAFLDD>(A 7-digit number)
    <DTAFLD DATAVAR=name>Name
      <DTAFLDD>(Last, First, M.I.)
    <DTAFLD DATAVAR=address>Address
  </DTACOL>
</AREA>
<CMDAREA>Enter a command
</PANEL>

Figure 1. Group heading

   File  Search  Help
 -------------------------------------------------------------------------
                         Library Card Registration

 Type in patron's name and card number (if applicable)

             Data Field Group Heading
 -----------------------------------------------
 Date . . . : ________
 Card No. . . _______  (A 7-digit number)
 Name . . . . _________________________  (Last, First, M.I.)
 Address  . . _________________________







 Enter a command ===> ____________________________________________________
  F1=Help        F3=Exit        F5=Display     F6=Keyshelp   F10=Actions
 F12=Cancel