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


PANDEF (Panel Default)

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

The PANDEF tag defines default values for application panels.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-<PANDEF--ID=pandef-id--+---------------------------+--------->
                          '-HELP=-+-help-panel-name-+-'   
                                  '-%varname--------'     

>--+----------------+--+---------------------+------------------>
   '-DEPTH=-+-n---+-'  '-WIDTH=-+-n--------+-'   
            '-FIT-'             +-FIT------+     
                                '-%varname-'     

>--+---------------------------------------------------------------------------+-->
   '-KEYLIST=key-list-name-+-----------------------+-+-----------------------+-'   
                           |           .-PRIVATE-. | '-APPLID=application-id-'     
                           '-KEYLTYPE=-+-SHARED--+-'                               

>--+---------+--+-----------------+----------------------------->
   '-CCSID=n-'  |         .-YES-. |   
                '-WINDOW=-+-NO--+-'   

>--+-----------------------+--+----------------------------+---->
   '-WINTITLE=window-title-'  '-APPTITLE=application-title-'   

>--+-------------------+--+--------------------+---------------->
   '-PAD=-+-NULLS----+-'  '-PADC=-+-NULLS----+-'   
          +-USER-----+            +-USER-----+     
          +-char-----+            +-char-----+     
          '-%varname-'            '-%varname-'     

>--+-----------------------+--+-----------+--------------------->
   |          .-NONE-----. |  '-EXPAND=xy-'   
   '-OUTLINE=-+-L--------+-'                  
              +-R--------+                    
              +-O--------+                    
              +-U--------+                    
              +-BOX------+                    
              '-%varname-'                    

>--+---------------------+--+---------------------------+------->
   |             .-NO--. |  '-ENTKEYTEXT=enter-key-text-'   
   '-MERGESAREA=-+-YES-+-'                                  

>--+--------------------------+--+-----------------------+------>
   '-IMAPNAME=-+-image-name-+-'  '-IMAPROW=-+-n--------+-'   
               '-%varname---'               '-%varname-'     

>--+-----------------------+--+-----------+--+-----------+-->--->
   '-IMAPCOL=-+-n--------+-'  '-TMARGIN=n-'  '-BMARGIN=n-'      
              '-%varname-'                                      

>--+-----------+-----------------------------------------------><
   '-</PANDEF>-'   

Parameters

ID=pandef-id
This attribute defines the identifier for the panel default definition. The pandef-id is the value you specify with the PANDEF attribute of PANEL tags that refer to the panel default.

The pandef-id must follow the standard naming convention described in Rules for variable names.

HELP=help-panel-name | %varname
This attribute specifies the extended (panel help) help panel that displays when the user selects help on an application panel that specifies the panel default.

The help-panel-name must follow the standard naming convention described in Rules for variable names.

Specification of the HELP attribute cause ISPDTLC to generate ".HELP=help-panel-name" (or ".HELP=&varname") in the )INIT section during panel generation.

ISPF displays this panel when the application user requests help and the cursor is not on a panel field that has its own field-level help specified. This help panel is also displayed when the user requests extended help.

DEPTH=n | FIT
This attribute specifies a default depth value for an application panel that refers to this panel default. See PANEL (Panel), for more information.
WIDTH=n | FIT | %varname
This attribute specifies a default width value for an application panel that refers to this panel default. See PANEL (Panel), for more information.
KEYLIST=key-list-name
This attribute specifies the name of a key mapping list associated with panels that refer to this panel default. See KEYL (Key List) for more information.
KEYLTYPE= PRIVATE | SHARED
This attribute is used to add the SHARED keyword to the KEYLIST parameter of the )PANEL statement. For more information about the )PANEL statement, refer to the z/OS ISPF Dialog Developer's Guide and Reference.
APPLID=application-id
This attribute is used to add the application ID to the )PANEL statement. The application-id overrides the KEYLAPPL invocation option value.
CCSID=n
This attribute specifies the default CCSID value for an application panel that refers to this panel default. See PANEL (Panel) for more information.
WINDOW=YES | NO
The WINDOW attribute is used to control the generation of the WINDOW keyword on the panel )BODY section. The default is to create the WINDOW keyword. WINDOW=NO should be used when WIDTH=%varname is also used to create a panel.
WINTITLE=window-title
This attribute is used to add a title on the pop-up window border. The attribute value is placed in the ISPF ZWINTTL variable. The maximum length of the window-title text is the panel width minus 1.
APPTITLE=application-title
This attribute is used to add a title on the GUI window border. The attribute value is placed in the ISPF ZAPPTTL variable. The maximum length of the application-title text is the panel width minus 1.
PAD=NULLS | USER | char | %varname
This attribute specifies the pad character for initializing the field. You can define this attribute as a variable name preceded by a “%”.
PADC= NULLS | USER | char | %varname
This attribute specifies the conditional padding character to be used for initializing the field. You can define this attribute as a variable name preceded by a “%”.
OUTLINE=NONE | L | R | O | U | BOX | %varname
This attribute provides for displaying lines around the field on a DBCS terminal. You can define this attribute as a variable name preceded by a “%”.
EXPAND=xy
This attribute adds the EXPAND(xy) attribute to the )BODY section of the panel. If only one character is present, the second character is set to the same value. If the EXPAND attribute is present with no value specified, the conversion utility uses a character from the range of low-order hex values available for panel attributes. This removes an available character from possible use as a panel attribute and may cause panel formatting errors.
MERGESAREA= NO | YES
This attribute controls an additional formatting step for panels with a single scrollable area. If the entire contents of the scrollable area fit within a standard 24-line panel (allowing 2 lines for the function keys display), and no input or output fields are found in the panel body following the location of the scrollable area, the scrollable area content is moved into the panel body.
ENTKEYTEXT=enter-key-text
This attribute is provide the text for the Enter key push button provided on panels displayed in GUI mode. The ENTKEYTEXT attribute causes a statement to be added to the panel )INIT section to set the value of the ZENTKTXT variable to the enter-key-text value.
IMAPNAME=image-name | %varname
This attribute specifies the name of a image to be placed on the panel when it is displayed in GUI mode. The image-name is not used when the panel is displayed in host mode.

The image-name must follow the standard naming convention described in Rules for variable names.

IMAPROW=n | %varname
This attribute specifies the row number for positioning the image. Image position uses an origin based on 0. Therefore, the minimum row value is 0 and the maximum is 61, relating to the description for the DEPTH attribute on the PANEL tag. If a variable name is used, the application must set the variable to a valid value before the panel is displayed. The value specified should be within the actual panel depth for the image to be visible when the panel is displayed.
IMAPCOL=n | %varname
This attribute specifies the column number for positioning the image. Image position uses an origin based on 0. Therefore, the minimum column value is 0 and the maximum is 159, relating to the description for the WIDTH attribute on the PANEL tag. If a variable name is used, the application must set the variable to a valid value before the panel is displayed. The value specified should be within the actual panel width for the image to be visible when the panel is displayed.
TMARGIN=n
This attribute provides the number of blank lines to format at the top of the panel as a top margin.
BMARGIN=n
This attribute provides the number of blank lines to format at the bottom of the panel as a bottom margin.

Comments

The PANDEF tag defines default values for application panels.

PANEL tags refer to the panel default by specifying the pandef-id definition as the PANDEF attribute value. When a PANEL tag refers to a panel default, the values specified by the associated PANDEF tag are used for the panel unless overridden by values specified in the PANEL tag definition.

The PANEL tag can override any of the PANDEF values by specifying that value within its own definition. Thus, it is possible for a PANEL tag to select certain default values from the panel default and override others.

See PANEL (Panel) for more information.

You can code multiple panel defaults for an application. Each panel default should have a unique pandef-id.

Restrictions

  • You cannot code the PANDEF tag within any other tag definition.
  • You must code the PANDEF tag before you code any PANEL tag that refers to it.
  • If both PAD and PADC have been specified, PAD is ignored and PADC is used.
  • When a "%varname" notation is found on any of the attributes that allow a variable name, the "%varname" entry must follow the standard naming convention described in Rules for “%variable” names.
  • EXPAND can operate only when there are no trailing attributes on the line to be expanded. Panel lines formatted as part of a horizontal region require the use of attributes for field alignment. Therefore, the EXPAND feature is functional only for panel sections built within a vertical (or default) region that is not part of any horizontal region.

Processing

None.

Examples

Here is source file markup that contains two panel default definitions. The application panels panel1 and panel2 both refer to the panel default pandef1. The panel panel1 uses all of the defined default values and panel2 uses only the default DEPTH and WIDTH values, and overrides the default HELP and KEYLIST values by specifying those values in the PANEL definition. The third application panel, panel3 refers to all of the default values specified in the panel default pandef2.
<!DOCTYPE DM SYSTEM(
  <!entity sampvar1 sysem>
  <!entity sampbody system>)>
&sampvar1;

<PANDEF ID=panldef1 DEPTH=20 WIDTH=76 HELP=helpaaa KEYLIST=keylxmp>

<PANDEF ID=panldef2 DEPTH=22 WIDTH=70 HELP=morehlp>

<PANEL NAME=pandef1 PANDEF=panldef1>First Panel
&sampbody;
</PANEL>

<PANEL NAME=pandef2 PANDEF=panldef1
 HELP=morehlp KEYLIST=keyltbl>Second Panel
&sampbody;
</PANEL>

<PANEL NAME=pandef3 PANDEF=panldef2>Third Panel
&sampbody;
</PANEL>

<HELP NAME=helpaaa>Help panel "helpaaa"
<AREA>
<INFO WIDTH=48>
<P>This is PANDEF help panel "helpaaa"
</INFO>
</AREA>
</HELP>

<HELP NAME=morehlp>Help panel "morehlp"
<AREA>
<INFO WIDTH=48>
<P>This is PANDEF help panel "morehlp"
</INFO>
</AREA>
</HELP>

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014