Group box

A group box is a rectangle that is drawn around a group of related fields. The upper-left corner of the box contains a label for the group. Group boxes display in GUI mode only.

To specify a group box, use the type keyword GRPBOX. Its syntax is:


>>-attribute-char--TYPE(GRPBOX)--WIDTH(wvalue)--DEPTH(dvalue)--><

Where:

attribute-char is the special character or 2-position hexadecimal value used to define the group box area within the panel body section. The area is defined by using the special character to position the upper-left corner of the group box in the panel body section.
wvalue is the width of the group box, not including the borders. This value can be 0 to 99. For example, a specification of WIDTH(9) means the box can contain data 9 characters wide.
dvalue is the depth of the group box, including the group box title line. This value can be 0 to 99. A minimum of 2 lines must be defined for the box. The top line is reserved for the label. For example, a specification of DEPTH(5) means the box consists of a group box title and 4 lines of data.

In the panel body section, the name immediately following the special character for the upper-left corner of the group box identifies the dialog variable that contains the text for the group box label. In Figure 1, that name is gbar. The name cannot be specified by using a Z-variable placeholder within the panel body.

Some things to remember when defining group boxes are:

Input/output/text fields should have ending attributes within the group box, or blanks where the box border falls.
Dynamic areas are allowed within group boxes, and should be entirely contained within the box.
Group boxes cannot be defined within dynamic areas.
Dynamic areas and group boxes should not overlap.
Scrollable areas are allowed within group boxes, and should be entirely contained within the box.
Group boxes are allowed within scrollable areas, and should be entirely contained within the area.
Scrollable areas and group boxes should not overlap.
Group boxes should not be used with graphic areas.
If the parameters WIDTH and DEPTH are not specified, the group box does not display.
If you specify WIDTH with no DEPTH, DEPTH(0) is assumed. This means the group box ends at the bottom of the panel.
If you specify DEPTH with no WIDTH, WIDTH(0) is assumed. This means the group box does not display.
If the group box DEPTH is coded as zero and the group box is within a scrollable area, the group box expands to the bottom of the scrollable area.
If the depth of the scrollable area is less than the group box DEPTH, the group box ends at the bottom of the visible scrollable area. The group box DEPTH is expanded when scrolling up, as long as the maximum group box depth has not been reached and the group box title is within the displayed portion of the scrollable area. After the group box title is no longer displayed in the scrollable area, the group box no longer appears.

Note: Even though the type GRPBOX is considered an output field, it maps to the CUA panel-element type Column Heading (CH). Therefore, its color, intensity, and highlight values can only be changed through the CUA Attribute Change Utility.

Figure 1. Group box definition

)ATTR
  + TYPE(TEXT)   INTENS(low) SKIP(on)
  % TYPE(TEXT)   INTENS(HIGH) SKIP(on)
  _ TYPE(INPUT)  INTENS(HIGH) CAPS(ON)
  # TYPE(GRPBOX) WIDTH(44) DEPTH(7)
)BODY
* --------------------------Group Box Example--------------------------
%COMMAND ===>_ZCMD
+                                           +
+    #gbar                                  +
+                                           +
+     +Available           Desired+         +
+       +Cruise Control      Sunroof+       +
+       +AM/FM Stereo        AM/FM Stereo   +
+       +Power Brakes+                      +
+       +Sunroof+                           +
+                                           +
+                                           +
)INIT
&zcmd = &z
&gbar = 'Options'
)REINIT
&zcmd = &z
)PROC
)END