PFLD Statement Syntax

Batch Compiler Statements › Statements for Manual Panel Definition › PFLD Statement Syntax

PFLD Statement Syntax

Functions Performed

A PFLD statement typically is used to perform the following functions:

Create and maintain a single panel field occurrence for the panel established in the most recent PANEL statement.
Identify the panel field occurrence in the data dictionary with a name that is unique within the owner panel occurrence.
Specify characteristics for the field, such as the following:
- Field occurrences for multiply-occurring fields
- Screen locations of the panel field by row and column
- Physical attributes of the field, such as display color
- Field values for literal fields
- Delimit characteristics

►►──┬──────────┬─ PFld panel-field-name ──────────────────────────────────────►
    ├─ ADD ────┤
    ├─ MODify ─┤
    └─ DELete ─┘

 ►──┬───────────────────────────────────────┬─────────────────────────────────►
    └─ OCCURS ─┬─ 1 ◄ ────────────────────┬─┘
               └─ occurrence-count times ─┘

   ┌────────────────────────────── , ───────────────────────────────────────┐
 ►─▼─┬──────────────────────────────────────────────────────────────────────┴─►
     ├─ FOR ALL ◄ ───────────────────────┬──────────────────────────────────────
     │         ┌─────── , ────────┐      │
     └─ FOR ( ─┴─ device-code ) ──┴── ) ─┘
 ►───────────────────────────────────────────────────────────────────────────┐►◄
  ───┬─┬──────────────────────────────────────────────────────┬──────────────┤
     │ └─ AT ─┬─ ANYwhere ──────────────────────────────────┬─┘              │
     │        │ ┌───────────────── , ────────────────────┐  │                │
     │        └─▼─ ( row-number ─┬─ 1 ◄────────────┬─ ) ─┴──┘                │
     │                           └─ column-number ─┘                         │
     ├─┬──────────────────────────────────────────────────────┬──────────────┤
     │ └─ ATTRibutes = ─┬─ NONE ───────────────┬──────────────┘              │
     │                  └─ (attributes list) ──┘                             │
     ├─┬──────────────────────────────────────────────────────┬──────────────┤
     │ ├─ DELIMit ─┬──────┬──┬─ SKIP ◄ ─┬─────────────────────┤              │
     │ │           ├─ IS ─┤  └─ NOSKIP ─┘                     │              │
     │ │           └─ = ──┘                                   │              │
     │ └─ NODELIMit ──────────────────────────────────────────┘              │
     ├─┬──────────────────────────────────────────────────────┬──────────────┤
     │ └─ PAGing type ─┬──────┬─┬─ DETail ONLY ──┬────────────┘              │
     │                 ├─ IS ─┤ ├─ DETail STart ─┤                           │
     │                 └─ = ──┘ ├─ DETail END ───┤                           │
     │                          ├─ FOOTer STart ─┤                           │
     │                          └─ NULL ◄ ───────┘                           │
     ├─┬────────────────────────────────────────────────────────────────────┬┤
     │ └─ VALue ─┬──────┬┬─ 'data-value'───────────────────────────────────┬┘│
     │           ├─ is ─┤│ ┌──────────────────────────────────────────────┐│ │
     │           └─ = ──┘└─▼─ ( ─┬──────────────────────┬─ 'data-value') ─┴┘ │
     │                           └─ (occurrence-count) ─┘                    │
     └───────────────────────────────────────────────────────────────────────┘

Parameters

ADD/MODIFY/DELETE

Specifies the action taken with regard to the MFLD statement.

PFLD

Introduces the clauses that define a panel field and associated panel field occurrence.

OCCURS 1/occurrence-count TIMES

Specifies the number of times the field is to appear on the panel; the default is 1.

FOR ALL /(device-code-a)

Associates the specified screen sizes with field specifications established by subsequent AT, ATTRIBUTES, DELIMIT, and VALUE clauses. If the panel is used with more than one screen size, multiple FOR specifications can be included in the PFLD statement to establish different information for each screen size; for a more detailed description of this latter use of the FOR specification, see "Defining Versions of Maps for Different Devices".

A field is associated with specific devices as follows:

ALL specifies that subsequent clauses of the PFLD statement apply to all screen sizes specified in the related DEVICES clause.
(Device-code-a) specifies one or more devices. Subsequent clauses of the PFLD statement apply only to the designated screen sizes. More than one device-code-a specification can be included in a FOR clause. The number of valid device-code-a specifications depends on the number of screen types declared in the related DEVICES specification.
Valid screen sizes are 12X40, 12X80, 24X80, 32X80, 43X80, and 27X132. Device specifications must be enclosed in parentheses and separated by commas; for example, FOR (12X40,12X80).

AT ANYWHERE/ (row,1/column)

Specifies the screen coordinate of the attribute byte for a field by row and column. The coordinate establishes the location of a runtime field on a given screen. An attribute byte is a nondisplayable character that precedes the displayed field and defines the field's attributes.

The field itself is displayed starting at the coordinate that immediately follows the nondisplayable attribute byte. For example, a field displays starting in coordinate (5,11) for an AT (5,10) specification.

The following considerations apply to the placement of attribute bytes and fields:

Specifying the coordinates for the final column of a row places the first displayable character for a field in the first column of the next row.
Specifying the coordinates for the final column of the final row on a screen places the first displayable character for a field in the first column of the first row (1,1).
Specifying coordinates that cause a field to exceed the remaining length on a given row results in a field that is split at the end of the screen and wrapped around to either the next row or the top of the screen, depending on the row in which the coordinates were placed.

Screen coordinates are designated as follows:

ANYWHERE specifies that the field can appear anywhere on the screen. ANYWHERE is meaningful only with mapin operations for which the requesting program reads extraneous data. Extraneous data is data that is not associated with a field at a specific row/column location.
(Row-n,column-n) specifies the row and column coordinates for the attribute byte for the field:
- Row-n identifies a horizontal position on the screen.
- Column-n identifies a vertical position on the screen; the default column is 1.

The following considerations apply when positioning multiply-occurring fields:

Each occurrence of the field requires its own row-n,column-n specification; multiple row-n,column-n specifications can be made in one AT clause, if necessary.
If there are more row-n,column-n specifications than multiply-occurring fields specified in the OCCURS clause, the compiler input statement listing returns an error message.
AT specifications can occur in any order; they are assigned to corresponding OCCURS values in order of iteration.

ATTRIBUTES=NONE/(attributes-list)

Specifies the attributes for the field. Only one ATTRIBUTES clause can occur in a given MFLD statement. ATTRIBUTES specifications apply to all occurrences of the field. Valid specifications are as follows:

NONE removes all attribute specifications from the map and panel field occurrences being defined by the MFLD statement. The following runtime considerations apply when NONE is specified for a field:
- The field is displayed with the attributes defined for the preceding field if the preceding field is not delimited.
- The field is displayed with the default display attributes provided by the device if the preceding field is delimited or if there is no preceding field.
- The field is displayed beginning in the column position specified in the AT clause, since there is no attribute character for the field.
(Attributes-list) specifies a list of attributes that apply to the field.
Note: For more information about available attributes, see "Attributes List".

DELIMIT/NODELIMIT

Specifies whether a delimit character is placed after the final position of a data field:

DELIMIT IS SKIP/NOSKIP specifies that an internal delimit character is placed after the final position of the field, as determined by the external picture of the associated record element. The action of the cursor when it reaches the delimit character and the disposition of excess characters are determined by one of the following specifications:
- SKIP (default) specifies that the cursor is advanced automatically to the start of the next UNPROTECTED field when operator input reaches the delimit character. If there are no more UNPROTECTED fields on the map, the cursor is placed at the start of the current field. Characters typed after the internal delimit character is reached are placed in the field to which the cursor advances. SKIP is the default if DELIMIT is specified.
- NOSKIP specifies that the cursor remains at the delimit character when operator input reaches the end of the field. Subsequently typed input locks the keyboard until the operator presses the RESET key. The TAB key advances the cursor to the next UNPROTECTED field.
NODELIMIT specifies that no internal delimit character is assigned to the field. The operator is not informed when input reaches the end of the field, and can continue typing until the attribute byte of the next field is reached. On mapin, the external picture of the record element associated with the field determines the amount of operator input that is stored. Input that exceeds the length of the external picture is ignored; a CA ADS dialog or application program can include commands to inquire whether extraneous data has been input for a NODELIMIT field.

PAGING TYPE IS DETAIL ONLY/START/DETAIL END/FOOTER START/NULL

(pageable maps only) Specifies whether the field begins and/or ends the detail occurrence or an area on the pageable map:

DETAIL ONLY performs the following functions:
- Begins the detail area on the line that contains the attribute byte of the field being defined.
- Begins the detail occurrence on the line that contains the attribute byte of the field being defined.
- Ends the header area (if any) on the line immediately above the line that contains the attribute byte for the field assigned the DETAIL ONLY specification.
- Ends the detail occurrence for the map at the final character of the field assigned the DETAIL ONLY specification.
The field assigned the DETAIL ONLY specification must begin on a new line (that is, it cannot begin on a line that contains characters for a field in the header area).
DETAIL START performs the following functions:
- Begins the detail area on the line that contains the attribute byte of the field being defined.
- Begins the detail occurrence on the line that contains the attribute byte of the field being defined.
- Ends the header area (if any) on the line immediately above the line that contains the attribute byte for the field assigned the DETAIL START specification.
The field assigned the DETAIL START specification must begin on a new line (that is, it cannot begin on a line that contains characters for a field in the header area).
DETAIL END specifies that the detail occurrence for the map is to end at the final character position of the current field. The detail area for the map is not terminated by DETAIL END; FOOTER START (below) can be used to terminate the detail area.
FOOTER START performs the following functions:
- Begins the footer area on the line that contains the attribute for the field. The footer area ends at the end of the screen.
- Ends the detail area on the line immediately above the line that contains the attribute byte of the field assigned the FOOTER START specification.
The field assigned the FOOTER START specification must begin on a new line (that is, it cannot begin on a line that contains characters for a field in the DETAIL END field). If assigned, the FOOTER START specification must be made for a field below the field assigned the DETAIL END specification.
NULL (default) specifies that the field does not begin or end a detail or an area on the map. The NULL setting can be used to override a previous DETAIL START, DETAIL END, or FOOTER START specification for a field.

Note: For more information about the areas of pageable maps, see "Pageable Maps".

VALUE IS data-value/((occurrence-count) data-value)

Supplies string values to literal fields:

Data-value assigns a value to a singly-occurring literal field. The specified value must be enclosed in quotation marks.
((Occurrence-count) data-value) assigns a value to a literal field or assigns discrete values to multiple occurrences of a literal field:
- (Occurrence-count) identifies one or more field occurrences by order of iteration. Values are assigned to the literal fields specified in the AT clause by order of iteration of the row/column specifications rather than by their order of display on the mapped screen. For example, with a literal field that occurs four times, the specification VALUE IS ((2) 'ABC' (1) 'DEF' (1) 'GHI') assigns the value ABC to the first and second field occurrences, DEF to the third field occurrence, and GHI to the fourth field occurrence.
- Data-value specifies the value assigned to each occurrence or group of literal field occurrences. The supplied value must be enclosed in quotation marks.

A maximum of 256 characters can be specified for a literal field in data-value.