SCRFLD (Scrollable Field)

The SCRFLD tag defines a field on an application panel as being scrollable. The panel field is defined using either the DTAFLD or LSTCOL tag. The SCRFLD tag must be nested within either a DTAFLD or LSTCOL tag.

Using the SCRFLD tag causes the conversion utility to format an entry in the )FIELD section of the generated panel. See the z/OS ISPF Dialog Developer's Guide and Reference for a description of the )FIELD section.

Syntax


>>-<SCRFLD--+-----------------------+--------------------------->
            '-DISPLEN=-+-n--------+-'   
                       '-%varname-'     

>--+---------------------------------------+-------------------->
   '-INDVAR=ind-var-+--------------------+-'   
                    '-INDVAL='ind-chars'-'     

>--+------------------------------------------+----------------->
   '-LINDVAR=lind-var-+---------------------+-'   
                      '-LINDVAL='lind-char'-'     

>--+------------------------------------------+----------------->
   '-RINDVAR=rind-var-+---------------------+-'   
                      '-RINDVAL='rind-char'-'     

>--+-------------------------------------------+---------------->
   '-SINDVAR=sind-var-+----------------------+-'   
                      '-SINDVAL='sind-chars'-'     

>--+----------------------------------------+------------------->
   '-LCOLIND=lcol-var-+-------------------+-'   
                      |           .-NO--. |     
                      '-LCOLDISP=-+-YES-+-'     

>--+----------------------------------------+------------------->
   '-RCOLIND=rcol-var-+-------------------+-'   
                      |           .-NO--. |     
                      '-RCOLDISP=-+-YES-+-'     

>--+-----------------+------------------------------------------>
   '-SCALE=scale-var-'   

>--+----------------------------------------------+------------->
   |         .-ON-------------------------------. |   
   '-SCROLL=-+-OFF------------------------------+-'   
             +-Start of changeNOLREnd of change-+     
             '-%varname-------------------------'     

>--+------------------------+-->--+-----------+----------------><
   |          (1) .-BELOW-. |     '-</SCRFLD>-'   
   '-FLDSPOS=-----+-SAME--+-'                     
                  '-ABOVE-'

Notes:

When the SCRFLD tag is nested in a DTAFLD tag, FLDSPOS can be BELOW or SAME. When the SCRFLD tag is nested in a LSTCOL tag, FLDSPOS can be BELOW or ABOVE.

Parameters

DISPLEN=n | %varname

This attribute is used to specify a length for the variable displayed in the scrollable field.

When DISPLEN=n is used, n specifies the initial length of the variable. n must be a value between 1 and 32 767.

%varname is a dialog variable that can contain a value between 1 and 32 767 to specify the initial length of the variable displayed in the scrollable field. After the panel is displayed %varname contains the maximum of the length of the dialog variable displayed and the initial length specified. When the scrollable field has been defined using the LSTCOL tag, the length of the dialog variable displayed is the maximum of all instances on the current display for that variable.

INDVAR=ind-var

This attribute specifies the name of a dialog variable that contains the left and right scroll indicator.

ind-var is a 2-byte scroll indicator dialog variable that is updated with 1-byte indicators showing whether left and right scrolling can be performed.

INDVAL='ind-chars'

This attribute is used to override the default scroll indicator values of '-' and '+' where:

-+: indicates you can scroll left or right
-: indicates you can only scroll left
+: indicates you can only scroll right

ind-chars must be a 2-byte literal enclosed in quotes.

The INDVAL attribute can only be specified together with the INDVAR attribute.

LINDVAR=lind-var

This attribute specifies the name of a dialog variable that contains the left scroll indicator.

lind-var is a 1-byte left-scroll-indicator dialog variable that is updated with an indicator showing whether left scrolling can be performed. The LINDVAR attribute cannot be defined together with the INDVAR attribute.

LINDVAL='lind-char'

This attribute is used to override the default left-scroll-indicator value of '-'.

lind-char must be a 1-byte literal enclosed in quotes.

The LINDVAL attribute can only be specified together with the LINDVAR attribute.

RINDVAR=rind-var

This attribute specifies the name of a dialog variable that contains the right scroll indicator.

rind-var is a 1-byte right-scroll-indicator dialog variable that is updated with an indicator showing whether right scrolling can be performed. The RINDVAR attribute cannot be defined together with the INDVAR attribute.

RINDVAL='rind-char'

This attribute is used to override the default right-scroll-indicator value of '+'.

rind-char must be a 1-byte literal enclosed in quotes.

The RINDVAL attribute can only be specified together with the RINDVAR attribute.

SINDVAR=sind-var

This attribute specifies the name of a dialog variable that contains the separator scroll indicator.

sind-var is a separator scroll indicator dialog variable that is initialized with the value repeated for the length of the scrollable field displayed on the panel. If the field is scrollable to the left, the leftmost byte is the value of the left indicator (default: '<'). If the field is scrollable to the right, the rightmost byte is the value of the right indicator ('>').

SINDVAL='sind-chars'

This attribute is used to override the default separator scroll-indicator value of '<->'.

sind-chars must be a 3-byte literal enclosed in quotes.

The SINDVAL attribute can only be specified together with the SINDVAR attribute.

LCOLIND=lcol-var

This attribute specifies the name of a dialog variable that contains the value of the left column position for the displayed scrollable field.

lcol-var is a dialog variable that is updated when the field is scrolled to contain the value of the left column position. This dialog variable can be used to specify an initial left column position for the scrollable field.

Note: If the same lcol-var is specified on multiple SCRFLD tags the associated panel fields scroll simultaneously. When the same lcol-var is associated with multiple panel fields, the conversion utility only defines lcol-var as a left column position indicator panel field for the first of those panel fields.

LCOLDISP=NO | YES

This attribute is used to specify whether the left column position indicator defined using the LCOLIND attribute is displayed on the panel.

When LCOLDISP=NO, the left column indicator is not generated as a panel field.

RCOLIND=rcol-var

This attribute specifies the name of a dialog variable that contains the value of the right column position for the displayed scrollable field.

rcol-var is a dialog variable that is updated when the field is scrolled to contain the value of the right column position.

Note: If the same rcol-var is specified on multiple SCRFLD tags the associated panel fields scroll simultaneously. When the same rcol-var is associated with multiple panel fields, the conversion utility only defines rcol-var as a right column position indicator panel field for the first of those panel fields.

RCOLDISP=NO | YES

This attribute is used to specify whether the right column position indicator defined using the LCOLIND attribute is displayed on the panel.

When RCOLDISP=NO, the right column indicator is not generated as a panel field.

SCALE=scale-var

This attribute specifies the name of a dialog variable that contains the scale indicator.

scale-var is a dialog variable that is updated with a scale line reflecting the current columns being displayed for the scrollable field.

SCROLL=ON | OFF | NOLR | %varname

This attribute is used to specify whether the field is scrollable or not.

When SCROLL=OFF, the field is not scrollable.

Start of change When SCROLL=NOLR, LEFT and RIGHT scrolling of the scrollable field is disabled. End of change

%varname is used to specify the name of a scroll control dialog variable. This can be set to a value of ON or OFF to turn scrolling for the field either on or off. Start of change When SCROLL=NOLR, LEFT and RIGHT scrolling of the scrollable field is disabled. End of change

FLDSPOS=BELOW | ABOVE | SAME

This attribute is used to specify where the scroll indicator panel fields are positioned in relation to the heading text for a table display field defined using the LSTCOL tag or in relation to the display field defined using the DTAFLD tag.

With FLDSPOS=BELOW, the conversion utility defines all scroll indicator panel fields for the scrollable table display field below the heading text or below the data field defined by the DTAFLD tag.

With FLDSPOS=SAME, the conversion utility attempts to define ind-var, lind-var, and rind-var for the data field on the same line as the data field. This option is not valid when the SCRFLD tag is nested within a LSTCOL tag.

With FLDSPOS=ABOVE, the conversion utility defines all scroll indicator panel fields for the scrollable table display field above the heading text. This option is not valid when the SCRFLD tag is nested within a DTAFLD tag.

Comments

Scroll indicator fields

The conversion utility implicitly defines ind-var, lind-var, rind-var, and sind-var as scroll-indicator panel fields, and scale-var as a scale-indicator panel field. This topic describes where the scroll and scale indicator fields appear on the panel. Their position depends on whether the SCRFLD tag is nested within a DTAFLD or LSTCOL tag, and on the attributes specified on the SCRFLD tag.

Here is the order in which the scroll indicator fields are created by the conversion utility:

lcol_var
rcol_var
ind_var | lind_var
rind_var

Position of scroll indicator fields under the LSTCOL tag

Depending on the attributes specified on the SCRFLD tag, the conversion utility can create below or above the column heading text up to four panel lines containing scroll indicator fields. Here is a table that identifies the order in which the scroll indicator fields are created by the conversion utility, assuming FLDSPOS=BELOW is specified.

Table 1. Order in which scroll indicator fields are created when FLDSPOS=BELO is specified
Relative Line from Column Heading 1	Scroll Indicator Dialog Variables	Comments
+1	ind-var \| lind-var and rind-var	Displays either the left/right scroll indicator variable OR the left and right scroll indicator variables. The scroll indicator variables are positioned left-justified relative to the column.
+2	lcol-var and rcol-var	The left and right column position indicators are positioned left-justified relative to the column. The number of characters used for the left and right column indicators is one more than the larger of the dimension of the initial field display length or the dimension of the column width.
+3	sind-var	Separator scroll indicator field spans the width of the column.
+4	scale-var	Scale indicator field spans the width of the column.

1 If the associated scroll indicator dialog variables are not specified, the conversion utility uses the line for the next scroll indicator field.

Position of scroll indicator fields under the DTAFLD tag

Depending on the attributes specified on the SCRFLD tag, the conversion utility can create below or on the same line as the data field up to four panel lines containing scroll indicator fields. The following table identifies the order in which the scroll indicator fields are created by the conversion utility, assuming FLDSPOS=BELOW is specified.

The conversion utility defines, on the following panel lines, output fields for the scroll indicator variables specified using the SCRFLD tag attributes. Here is a table that identifies the order in which the scroll indicator fields are created by the conversion utility:

Table 2. Order in which scroll indicator fields are created
Relative Line from DTAFLD Field 1	Scroll Indicator Dialog Variables	Comments
+1	scale-var	Scale indicator field spans the width of the field.
+2	sind-var	Separator scroll indicator field spans the width of the field.
+3	lcol-var and rcol-var	The left and right column position indicators are positioned left-justified relative to the column. The number of characters used for the left and right column indicators is one more than the initial field display length.
+4	ind-var \| lind-var and rind-var	Displays either the left/right scroll indicator variable OR the left and right scroll indicator variables. The scroll indicator variables are positioned left-justified relative to the field.

1 If the associated scroll indicator dialog variables are not specified, the conversion utility uses the line for the next scroll indicator field.

When the SCRFLD tag is associated with a DTAFLD tag that is immediately within a vertical region, scale and separator scroll indicators are not permitted.

Restrictions

You must code the SCRFLD tag within a LSTCOL or DTAFLD tag.

Processing

Table 3. Tags you can code within a SCRFLD definition
Tag	Reference	Usage	Required
COMMENT	COMMENT (Comment)	Multiple	No
SOURCE	SOURCE (Source)	Multiple	No

Examples

Here is source file markup where the application panel contains two scrollable fields, the Address field and the Comments field. A scroll separator is displayed with the Address field and a scale line is displayed with the Comments field. Figure 1 shows the formatted result.

<!DOCTYPE DM SYSTEM>

<VARCLASS NAME=date TYPE='char 8'>
<VARCLASS NAME=name TYPE='char 20'>
<VARCLASS NAME=addr TYPE='char 40'>
<VARCLASS NAME=prod TYPE='char 25'>
<VARCLASS NAME=comm TYPE='char 55'>

<VARLIST>
  <VARDCL NAME=curdate VARCLASS=date>
  <VARDCL NAME=snamvar VARCLASS=name>
  <VARDCL NAME=fnamvar VARCLASS=name>
  <VARDCL NAME=sindvar VARCLASS=addr>
  <VARDCL NAME=addrvar VARCLASS=addr>
  <VARDCL NAME=prodvar VARCLASS=prod>
  <VARDCL NAME=scalvar VARCLASS=comm>
  <VARDCL NAME=commvar VARCLASS=comm>
</VARLIST>
<PANEL NAME=scrfld0 HELP=loghelp>Customer Feedback
<TOPINST>Complete the following fields, then press Enter.
<AREA>
  <DTACOL PMTWIDTH=15>
    <DIVIDER>
    <DTAFLD DATAVAR=curdate USAGE=out ENTWIDTH=8 FLDSPACE=27>Date
  <DTAFLDD>(Current Date)
    <DIVIDER>
    <DTAFLD DATAVAR=snamvar ENTWIDTH=20>Surname
    <DIVIDER>
    <DTAFLD DATAVAR=fnamvar ENTWIDTH=20>First Names
    <DIVIDER>
    <DTAFLD DATAVAR=addrvar ENTWIDTH=40 DESWIDTH=15>Address
  <DTAFLDD>(Optional)
      <SCRFLD DISPLEN=80 SINDVAR=sindvar>
    <DIVIDER>
    <DTAFLD DATAVAR=prodvar ENTWIDTH=25 DESWIDTH=25>Product
  <DTAFLDD>(Product Purchased)
    <DIVIDER>
    <DTAFLD DATAVAR=commvar ENTWIDTH=55>Comments
      <SCRFLD DISPLEN=110 SCALE=scalvar>
  </DTACOL>
</AREA>
<CMDAREA scrollvar=scrvar>Command
</PANEL>

Figure 1. List field

                             Customer Feedback

 Complete the following fields, then press Enter.


 Date  . . . . : 02/10/21                   (Current Date)

 Surname . . . . Smith               

 First Names . . John Joseph         

 Address . . . . Apartment 10a, 100 Happiness Street, Ple  (Optional)
                 --------------------------------------->

 Product . . . . Hammer                     (Product Purchased)

 Comments  . . . An implement that has proved very useful for driving na
                 ----+----1----+----2----+----3----+----4----+----5----+



 Command ===>                                             Scroll ===> CSR 
  F1=Help    F3=Exit    F7=Up     F8=Down    F10=Left   F11=Right  F12=Cancel

Here is source file markup that uses the LSTFLD and LSTCOL tags to display the data in an ISPF table. The SCRFLD tag is used to display the Customer and Comments data in scrollable fields. Left and right column indicators are displayed in the column headings for the Customer and Comments data. A separator scroll indicator is also displayed in the heading for the Customer column. A scale indicator is displayed in the heading for the Comments column. Figure 2 shows the formatted result.

<!DOCTYPE DM SYSTEM>

<VARCLASS NAME=date TYPE='char 8'>
<VARCLASS NAME=cust TYPE='char 15'>
<VARCLASS NAME=prod TYPE='char 15'>
<VARCLASS NAME=comm TYPE='char 30'>

<VARLIST>
  <VARDCL NAME=datevar VARCLASS=date>
  <VARDCL NAME=custvar VARCLASS=cust>
  <VARDCL NAME=prodvar VARCLASS=prod>
  <VARDCL NAME=commvar VARCLASS=comm>
</VARLIST>

<PANEL NAME=scrfld1 HELP=loghelp>Customer Feedback Display
<AREA>
<LSTFLD SCROLLVAR=scrlamt SCRVHELP=scrhelp>
  <LSTCOL DATAVAR=datevar USAGE=out COLWIDTH=8>Date
  <LSTCOL DATAVAR=custvar USAGE=out COLWIDTH=15>Customer
   <SCRFLD DISPLEN=50 SINDVAR=sindvar LCOLIND=cuslcol LCOLDISP=YES
      RCOLIND=cusrcol RCOLDISP=YES>
  <LSTCOL DATAVAR=prodvar USAGE=out COLWIDTH=15>Product
  <LSTCOL DATAVAR=commvar USAGE=out COLWIDTH=30>Comments
   <SCRFLD DISPLEN=110 SCALE=scalvar LCOLIND=comlcol LCOLDISP=YES
      RCOLIND=comrcol RCOLDISP=YES>
 </LSTFLD>
</AREA>
<CMDAREA>Command
</PANEL>

Figure 2. List variable

                         Customer Feedback Display           Row 1 to 6 of 6

 Date      Customer         Product          Comments
           1   15                            1    30
           -------------->                   ----+----1----+----2----+----3

 03/02/25  Big Bang Demoli  Jackhammer       We've used this piece of equip
 03/02/25  Carpenter, Scot  Chisel           I'm able to shape pieces of wo
 03/02/26  Acme Building C  Cement mixer     Our bricklayers make heavy use
 03/02/28  Smith, John Jos  Hammer           An implement that has proved v
 03/02/28  Hole, Doug       Shovel           Is ideally suited to our holis
 03/03/03  Picker, Sherry   Folding ladder   This tool is highly recommende
 ****************************** Bottom of data *******************************








 Command ===>                                             Scroll ===> CSR 
  F1=Help    F3=Exit    F7=Up      F8=Down    F10=Left   F11=Right  F12=Cancel
 F13=Help   F15=Exit    F24=Cancel