Harness, Section, and Flow Action forms
Adding a Row Repeat layout
|
|
A repeating layout defines a rectangular area on a work object form or flow action form corresponding to the HTML <TABLE > element. Three repeating layouts are available: Row Repeat, Column Repeat, and Tabbed Repeat.
The V6.1+ Grid and TreeGrid layouts provide a clearer and more customizable data display that is easier to implement and work with. Consider use of these as alternatives to the Row Repeat layout.
For a Row Repeat layout, each row of the table corresponds to an
element (a single page) of a Page List or Page
Group property. The row can present embedded
properties for each page, either as fields or formatted by a section
rule.C-2526
To see an example, review the standard section rule named
Work-.PartyDetails, which is based on the Page
Group property Work-.pyWorkParty. Special processing
in this rule supports restrictions that specify which parties must be
present and which parties can appear more than once.
In version V5.4, this control is called a Repeating
Layout. The Row Repeat name was introduced with V5.4SP2 to distinguish
the Row Repeat horizontal presentation (rows) from the vertical
presentation (as columns) and from the tabbed presentation.
1. Adding and
deleting a Row Repeat layout
Click the down-arrow (
) at the right
end of the Layout control group (
) and
select the Layout control (
). Click and drag the control. When the
pointer changes shape to indicate that you can drop the layout,
release the mouse button.
On the Layout Options form:
Row as the repeat type.To delete a Row Repeat layout, select the layout and click the
Delete Row button (
). Do not use the Delete Cell button for this
action.
The table initially contains three columns and three rows. Usually,
the top row holds labels, the second row holds fields (property
values), and the final row contains the Add Row control (
). When the section appears
at runtime, the second row is repeated for each existing Page
List or Page Group page.
2. Complete the Row
Repeat panel — Top fields
Click the magnifying glass icon (
) to open the Row Repeat panel. Complete all
tabs of the panel.
If the panel is pinned (
), the wireframe presentation on the rule form
changes immediately to reflect your inputs. If the panel is not
pinned (
),
click Apply to apply your inputs.
Field |
Description |
||||||||||||||||||||||||
| Header |
Choose a format to control what appears above the layout (known as a header or subheader), and the appearance of both the header or subheader if any, and aspects of the body. This choice primarily affects styles and appearance.
Information in or below a subheader (including Using the Branding wizard, you can review or revise the styles (colors, fonts, padding and margins) associated with each header or subheader format.
In the workform CSS style sheets, the various styles named
|
||||||||||||||||||||||||
| Template |
Select a SmartLayout template:
|
||||||||||||||||||||||||
| HTML |
If you selected |
||||||||||||||||||||||||
| Title |
Optional. Enter text for the header or subheader, above the table. You can include directives or JSP tags in this text.
|
||||||||||||||||||||||||
| Visible When |
Click the pencil icon (
|
3. Complete the Row
Repeat panel — General tab
Complete the General tab. To enable SmartPrompt prompting while using this tab, complete the Of Class field before the PageList/Group field.
Field |
Description |
| PageList/ PageGroup |
Type a period followed by the property name. For embedded
pages, type the qualified name. For example, if myArray is a
.myArray .page1.myArray .page1.page2.myArray Click the pencil icon ( You can't use the syntax Apagename.Apropertyname in
this field (with no leading period) to identify a |
||||||||||
| Of Class |
|
||||||||||
| Allow Update |
For repeating layouts added to the harness, section, or
flow action (in release V5.2 or later) select this checkbox
to allow users at runtime to add a new element immediately
after an existing element, using the |
||||||||||
| Allow Reordering |
GATZH 3/25/2010 for v6.1 Select this checkbox to allow for row reordering during runtime. A number for each row that doubles as a drop and drag handle for reordering will appear in front of individual rows. Numbering begins at 1 and continues for however many rows present. If there is only one row and the Allow Reordering checkbox is selected, a no smoking sign ( |
||||||||||
| Header Type |
Select one of the following header styles. This field does
not appear if the Header value is
|
||||||||||
| Expand When |
If blank, the state of the layout (expanded or collapsed) when you save the Harness, Section, or Flow Action form becomes the state upon initial runtime presentation. |
||||||||||
| Defer Load? |
This field appears for |
||||||||||
| New Tab Group |
For Header Type of |
||||||||||
| New Layout |
For Header Type of |
4. Complete the Row
Repeat panel — Advanced tab
Field |
Description |
| Body Visible When |
The when condition rule is evaluated for each row, and so can cause some rows to appear and other rows to be omitted. CLINIC APAPF 8/12/05 Click the pencil icon ( |
| Width |
|
| ID |
Optional. Enter a name that becomes the ID=" " attribute value for the <TABLE > element. This option is useful when a JavaScript function refers to the table. |
| Summary |
Optional. Enter text to supply a value for the
|
| Header Image |
Optional. Identify the second and third key part of a
binary file rule corresponding to a small image. Click the
magnifying glass icon ( |
| Style Prefix |
This field is available only if you selected
|
| Append Activity |
To override the default behavior when a user adds a row to the array, identify the second key part of an activity to be called. Design your activity to accept the same parameters as the default activity Work-.AppendToPageGroup or Work-.AppendToPageList (which are final rules). For example, your activity can prevent users from adding rows after reaching a limit, or can compute additional properties for the page. This field is meaningful only for repeating layouts
created in Version 5.2 or later that include an add row icon
( |
| Delete Activity |
To override the default behavior when a user adds a row to the array, identify the second key part of an activity to be called. Design your activity to accept the same parameters as the default activity Work-.RemoveFromPageGroup or Work-.RemoveFromPageList (which are final rules). For example, your activity can require that at least one row remains, or that users can't delete the first row. This field is meaningful only for repeating layouts
created in Version 5.2 or later that include a delete row
icon ( |
5. Adjusting row
and column properties
To view or change row properties, click the circle at the left end
of the row. Then click the magnifying glass icon (
) at the right end
of the row.
For details, see SmartLayouts — Adjust Row Properties in Adding a layout.
Use the Column Properties panel change the type of a column, or to apply an inline style to all cells in the column.
To view or change column properties, click a column header and then
click the magnifying glass icon ().
For details, see SmartLayouts — Adjust Column Properties in Adding a layout.
Use the cell controls to add columns or delete columns, or merge cells.
In most cases, select an object in the layout before clicking an icon. Certain operations may be unavailable depending on your selection and the layout characteristics.
Control |
Description |
|
Delete the contents of a single cell (not a row or column) |
|
Insert a new row before (above) the selected row |
|
Insert a new row after (below) the selected row |
|
|
Delete the selected row or layout |
|
Merge right — Combine the selected cell and the cell to the right. |
|
Merge down — Combine the selected cell and the cell below it. Proj-649 5.4 |
|
Unmerge All — Undo the previous merges. GAGNP 5/07 |
The Insert column before (
), Insert column after (
), and Delete column (
) operations are not available for Smart
Layout columns — those with a column type of Label,
Field or Spacer). They are available in
freeform layouts.
To reorder rows or columns within a repeating layout, you can select and drag a single row or column using the dots above or to the left of the table; these act as handles.
To duplicate rows or columns within a repeating layout:
Optional. To cause the entire Row Repeat layout to appear
only when certain conditions are true at runtime, select or
enter the When Name key part of a when
condition rule. At runtime, the system uses the
Applies To class of this harness rule as the
Applies To key part to locate the when
condition rule. PARKT 04/08/05
)
) will appear preventing reordering.
If you choose
px-fixed and a property value at runtime is wider than width
defined by the pixel value, the value is truncated, and users
are unable to see the full value. GROVS 8/24/06
)
Optional. Provides
the ability to reference a family of custom styles for
headers. 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
Ctrl key.Ctrl key to drop a duplicate row or
column. Allowing users to append or delete Page List or Page Group
elements (rows)
For Row Repeat layouts created in V5.2 or later, users can add rows, delete rows, or both add and delete rows, depending on which icons you include on the form.
When you first create a Row Repeat layout, a three-by-three table
appears. Typically, cells in the top row present column labels, but
these cells can also hold other property values (not from the embedded
Page List or Page Group pages). Cells in the
bottom row are typically used to present the Delete Row icon
(
), but can also hold other property
values (not from the embedded Page List or Page
Group pages).
At runtime, the middle row appears once for each page. By default, users can add, append, and delete rows at runtime. You can change this default behavior:
) that appears at the
bottom left of the third row. You can also delete the column
containing this row.) that appears in
the right of the second row. GAGNP 5/07You can't delete the top or bottom rows; if they are not needed, you can apply a style that makes them not visible at runtime.
Optionally, you can use button controls or URL controls on the repeating layout rather than the standard icons for Add Row and Delete Row icons. The icon, button, or URL control can appear anywhere in the row.
Identifying
subscript values for added Page Group pages
When a repeating layout is based on a Page Group
property and users click the Add Row icon () to append a new row, or
press the Enter key to insert a new row, the system
requires a subscript value for the new page.
In a Page Group property, the embedded text property
pxSubscript acts as a unique identifier for the pages.
This value may also be present in another property found on each page.
As a best practice for usability, present the pxSubscript
property (as a read-only value) in the left column of each row.
In some cases, the set of allowable values for subscripts are
limited to a predefined static list, such as the codes for the 50
states of the United States (AL for Alabama through WY for Wyoming).
In other cases, the set of allowable values for subscripts is
unpredictable and effectively unrestricted, though each value must be
a valid Java
identifier. For example, a home insurance policy may contain a
Page Group property with a page for each insured
property, with the property identified by a government-issued
code.
Process Commander includes standard rules that support both situations. Your application can override the standard rules to allow users to enter or select a subscript value.
Page
Group. Include only one input field on the section display.
For example, if there are only a few allowed
pxSubscript values, you can present the unused values
as a set of radio buttons.Page
Group.Local List or Remote List on the General tab
of the new property. Then, complete the table fields, to enumerate the allowable values as a Local List, or define a Remote List that
assembles the values dynamically.
At runtime, the system controls the order of
rows presented for a Page Group property. After you
append or insert a new row, it may be re-sorted to a different
position after the Submit is complete. NRESTRICTED CASE?