z/OS ISPF Dialog Tag Language Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


GA (Graphic Area)

z/OS ISPF Dialog Tag Language Guide and Reference
SC19-3620-00

The GA tag allows the creation of graphic areas on ISPF panels.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-<GA NAME=graphic-area-name--+-------------------+------------>
                               |         .-OFF---. |   
                               '-EXTEND=-+-ON----+-'   
                                         '-FORCE-'     

>--+--------------+--+---------+-------------------------------->
   '-DEPTH=-+-n-+-'  '-WIDTH=n-'   
            '-*-'                  

>--+--------------------------------+--------------------------->
   |      .-NONE--.                 |   
   '-DIV=-+-BLANK-+-| DIV options |-'   
          +-SOLID-+                     
          +-DASH--+                     
          '-TEXT--'                     

>--+----------------------+-->--+-------+----------------------><
   '-LVLINE=variable-name-'     '-</GA>-'   

DIV options

|--+--------------------+--+-------------------+----------------|
   '-FORMAT=-+-START--+-'  '-TEXT=divider-text-'   
             +-CENTER-+                            
             '-END----'                            

Parameters

NAME=graphic-area-name
This attribute defines the name of the graphic area. This name is the dialog variable specified by the application that provides the data for the graphic area.

The NAME attribute must follow the standard naming convention described in Rules for variable names.

EXTEND=OFF | ON | FORCE
This attribute defines the runtime display size of the graphic area. If EXTEND=ON is specified, the graphic area definition is expanded to the size of the logical screen. If you intend to display the panel in a pop-up window, use EXTEND=OFF (which is the default).

If EXTEND=FORCE is specified within a horizontal area or region, the EXTEND(ON) keyword is added to the graphic area attribute statement in the )ATTR panel section. The conversion utility issues a message to advise of a potential display error if other panel fields are formatted on or after the last defined line of the graphic area.

DEPTH=n | *
This attribute specifies the number of lines reserved for the graphic area definition. The DEPTH attribute value reserves space within the panel )BODY section. The minimum depth is one line. will reserve the remaining available panel depth for the graphic area.
WIDTH=n
This attribute specifies the number of columns reserved for the graphic area definition. The minimum width is the number of positions in the graphic area name plus 4 and the maximum is 2 positions less than the panel width. The conversion utility places attribute bytes on both sides of the graphic area.
DIV=NONE | BLANK | SOLID | DASH | TEXT
This attribute specifies the type of divider line to be placed before and after the graphic area. 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, DASH, or TEXT 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. A visible divider line formats with a non-displayable attribute byte on each end of the line.
FORMAT=START | CENTER | END
This attribute specifies the position of the divider-text within the divider line. You must specify both the FORMAT attribute and the TEXT attribute to create a divider line containing text.
TEXT=divider-text
This attribute specifies the text to be placed on the divider line. You must specify both the FORMAT attribute and the TEXT attribute to create a divider line containing text.
LVLINE=variable-name
This attribute allows you to specify the name of a variable which contains the result of the ISPF function LVLINE.

The LVLINE attribute must follow the standard naming convention described in Rules for variable names.

Comments

The GA tag defines a graphic area in the panel )BODY section.

If you specify the CMDAREA tag within your DTL source file, it must appear before the GA tag when DEPTH=* is specified. The GA tag DEPTH may have to be adjusted to allow for additional lines which result from tags present within the panel definition following the end GA tag.

See z/OS ISPF Dialog Developer's Guide and Reference for a discussion of the graphic area in ISPF panels.

Restrictions

  • You must code the GA tag within a PANEL, AREA, or REGION tag. If found anywhere else, an error is logged and the output panel is not saved.
  • If NAME is not valid or not specified, an error is logged and the output panel is not saved.
  • You can use the EXTEND=ON attribute only once within a panel. If EXTEND is already active, from another GA tag, or from an AREA, DA, SELFLD, or REGION tag, a warning message is logged and the EXTEND attribute is ignored.
  • You can code only one GA tag within a PANEL definition.
  • You cannot code the GA tag within a scrollable area.

Processing

None.

Examples

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

<PANEL NAME=ga KEYLIST=keylxmp>Library Card Registration
<AB>
&sampabc;
</AB>
<TOPINST> Type in patron's name and card number (if applicable)
<AREA>
  <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>
  <DIVIDER>
  <GA NAME=garea DIV=solid DEPTH=6 WIDTH=40>
  </GA>
</AREA>
<CMDAREA>Enter a command
</PANEL>

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014