Harness, Section, and Flow Action forms
Adding a Grid layout

Field

Description

Choose a format to control what appears above the layout (known as a header or subheader), and the appearance of both the header and any subheader, and aspects of the body.

This choice primarily affects styles and appearance. Information in or below a subheader (including Hidden Sub) presents information that is right-indented from information in a header.

Using the Branding wizard, you can review or revise the styles (colors, fonts, padding and margins) associated with each header or subheader format.

If you plan to localize the application using this rule so the application can support users in various languages or locales, choose the text carefully and limit the length to no more than 64 characters. When practical, choose a caption already included in a language pack, to simplify later localization. A field value rule with this text as the final key part is needed for each locale. See About the Localization wizard.

This field is not visible if the Format field contains No Format, Hidden, or Hidden (Sub).

Optional. To control visibility of this header, enter or select one of the following:

• Leave blank to always present the header.
• A when condition rule. Click the pencil icon () to review or create the when condition rule.
• Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.

To make a dynamic condition, enter a simple Java comparison of a property and a value, or a combination of such comparisons using parentheses and the && and || operators, such as:

(.Width >= "20") && (.Length >= "40)

This causes dynamic execution of the condition each time the value of a property mentioned in the condition changes. (Mark the fields containing such properties as a Client Event.)

For Header Type of Accordion only. Select to start this accordion element as the first in a group.

Optional. Choose an option to present the data results in segments — known as pages — each containing a fixed number of rows (defined in the Rows per Page setting). The system retrieves a segment from the total data set on the clipboard and presents the page navigation controls in a format defined in this option.

When you select an option, the paging gadget (pyGridGadget section) appears in the right top Action area cell. You can drag and drop the gadget onto any cell in an action area or onto a header cell in the repeating grid.

To add more than one paging gadget, right-click on the cell and copy it paste it in another cell.

The options are:

In cases where the data set is large and performance is an issue, you can populate the clipboard incrementally using the Paginate Activity on the Advanced tab.

To add a header image at the top of the Grid:

1. Open its property panel for this field to start the Image Catalog (a pop-up version of the Image Gallery landing page).
2. Search for the image you want to use by entering a text string in the Search field and clicking Find.
3. Select an image from the resulting display: at the top right of the panel details about the image appear.
4. To use the selected image, click OK.

The image must already be present in a binary file rule that is part of your application; you cannot search your local computer or the Internet through the Image Catalog.

Optional. If the Header Type is Tabbed or Accordion, this field provides the ability to reference a family of custom styles for headers. Enter a single letter or a few letters that designate a collection of styles for this header.

For example, type A in this field to use styles named .A_standardheader* rather than the normal .standardheader* styles. Define the prefixed styles in your workform_zzzzz.css text file (created by the Branding wizard) or in another text file that you identify on the Scripts and Styles tab of the Harness form.

Optional. This field appears if you selected a paging option in the Paging field on the General tab, and the data source is a Page List or Page Group property. You cannot use this option with a Report Definition source.

Select a custom activity that populates the clipboard from a Page List in a page size you define. Because the activity limits clipboard size, it is useful when retrieving large amounts of data from an external Web service or database.

Your activity must accept the following set of parameters:

• PageListProperty — Name of the Page List property
• ClassName — Page List class
• currentPageIndex — Page number in which results are populated
• pyPageSize — Number of records displayed in a page
• sortType — Ascending or descending
• sortProperty — The Page List property that is sorted

Out parameter expected from activity:

• totalRecords – Total number of records in the Page List

This checkbox appears if you select a Paginate Activity. Click it if you want the activity to control sorting behavior. For example if a user is on the fifth page and clicks the sort control on the grid header, the activity gets the sorted results for that page only.

If you do not select this option, the Obj-Sort method is applied to the page.

Select to allow users to move objects higher or lower on the display by dragging and dropping individual rows. Depending on the properties of the objects the rows represent, rows may be moved above or below other rows, or dropped into a row that can receive them to become child entries of that row.

If you selected a Report Definition source, this checkbox is blank and cannot be selected.

Visual indicators give clues about the process: a line appears between two rows in the list if that is where the row you have started dragging will appear if you release it. A row that can receive the row you have selected as a child will change background color. If your mouse cursor is over an area where you cannot drop the row you have selected, an indicator will remind you that the area is not a valid target. If you attempt to drop the row there, the display will remain unchanged.

At runtime, a tool tip appears when the user hovers the cursor over the column header. The user can alternate the sort order (ascending/descending) by  clicking the header.

Sorting is performed on all rows in the grid. If paging is enabled and the user changes the sort order, the grid view returns to the first page.

1. Click a vertical wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border.

The unlabeled Use at Runtime checkbox to the right of the width field is enabled by default and cannot be edited. This forces the Width value to be used by the browser at runtime, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. Data values may sometimes wrap or appear truncated.

Optional. Enter a positive number for the height in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed height.) You can also adjust the height of a row directly:

1. Click a horizontal wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border.

The unlabeled Use at Runtime checkbox to the right of the width field is enabled by default and cannot be edited. This setting forces the Height value to be used by the browser at runtime, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column.

If the source is a Report Definition, the list contains Column Name properties defined in the rule. If there are joins in the report, property names appear as joinname.PropertyName.

Clear the Use at Runtime checkbox (unlabeled) next to the width field to allow the browser at runtime to determine the width of this column based on the size of the column contents and the size of other columns. The width may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no WIDTH= attribute.) The Width value is used as you view the rule form, but not at runtime.

For example, clear this checkbox if the cell is to contain a section rule that may be wide in some situations and narrow in others.

Select (default) the Use at Runtime checkbox to force the Width value to be used by the browser at runtime, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. If checked, data values may sometimes wrap or appear truncated.

Enter a positive number for the height in pixels of this cell.

Clear the Use at Runtime checkbox (unlabeled) to allow the browser at runtime to determine the height of this row based on the size of the row contents and the size of other rows. The height may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no HEIGHT= attribute.) The Height value is used as you update the rule, but not at runtime.

For example, clear this checkbox if the cell is to contain a section rule that may be tall in some situations and short in others.

Select the Use at Runtime checkbox to force the Height value to be used by the browser at runtime, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column.