About the Icon control V5.1x |
A cell in a layout can contain a predefined icon that starts an activity when clicked. You can also add an icon to the header of a harness. Follow these instructions to add an icon to a cell or header.
As of V6.2, this control uses the auto-generated pxIcon control rule. See Harness, Section, and Flow Action forms — Adding an Icon control. Use this rule in new development.
Cell Properties panel — Top fields
Click the magnifying glass icon () to display the Cell Properties panel.
Your updates to this panel can update the rule form immediately or upon clicking Apply, depending on the Property Panel settings in your Edit preferences. See Setting your preferences. If the panel is pinned(), the wireframe on the rule form changes immediately to reflect your inputs. If the panel is not pinned(), click Apply to apply your inputs.GRP-229
Field |
Description |
Type |
Select a function for this icon from the predefined values. See Built-in Types. Each has a corresponding style that determines an image, shown in the wireframe preview. Select |
Tooltip |
Optional. Enter a sentence or phrase that conveys to users the purpose and function of the icon. As a best practice, start the ToolTip text for an input field with a verb; for example "Review work object history" or "Add an attachment". If this text is to be localized. enter no more than 64 characters. Click the pencil icon to review or create the field value rule supporting localization, with a middle key part of pyActionPrompt. Proj-212. Proj-212 |
Style |
Select the icon image. If you have selected a
predefined icon, then in most cases — to avoid user
confusion — accept the standard style that matches the
value in the Type field.
Standard icons are predefined in the standard text file rule named webwb.workform.css, an HTML style sheet. Click the pencil icon () to review the style sheet that defines these icons. If necessary, your application can override the appearance of an icon by overriding the corresponding binary file rule and updating a style sheet. The selection list presents all binary file rules available to your RuleSet list with a File Name key part starting with "icon." To include a custom icon in this list:
|
Cell Properties panel — General tab
Complete the General tab.
Field |
Description |
Do Action
|
These fields appear only when the type is
See Complete additional information for custom icons below. corrected 4/24/08 |
Visible |
Select to determine when the icon appears. (If this setting is not applicable, the cell contents are blank.)
|
Visible When |
If you selected
An icon that is not visible is also disabled and cannot be clicked. |
Wrap Text? |
Not meaningful for icons. B-17946 |
Disabled? |
Select to cause the icon to be disabled or enabled based on a test, even when the form is in read-write mode. Complete the next field to modify the effect of this checkbox. PROJ-283 MARTT 2/26/07REVISED LABEL PER KUCHS 3/7/07 |
Disabled Condition |
Optional. This field appears only when you select the Disabled? checkbox. Enter an expression involving another property, or identify the When Name key part of a when condition rule. PROJ-283 Specify one of four outcomes, where true or blank means the icon is disabled. CONFIRM
|
Run on Client? |
This checkbox appears only if the Condition field contains a simple Java comparison. Select to cause dynamic execution of the condition each time the value of the property mentioned in the condition changes. (Mark the field containing that property as a Client Event.) Leave cleared to cause the condition to execute only once, upon initial presentation of the form. |
Cell Properties panel — Advanced tab
Complete the Advanced tab.
Width |
As a best practice, use SmartLayouts to achieve uniform width of cells throughout your application's forms. You can set the width of SmartLayout templates using the Branding wizard. Optional. This field appears only when the cell is not controlled by SmartLayout column restrictions. Enter a positive number for the width in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed width.) You can also adjust the width this column directly:
|
Height |
As a best practice, use SmartLayouts to achieve uniform height of cells throughout your application's forms. You can set the width of SmartLayout templates using the Branding wizard. Optional. This field appears only when all columns in the
Layout are not controlled by SmartLayout column
restrictions (that is, all columns have the
|
Privilege |
Optional. Select the Privilege Name key part of a privilege rule that controls the availability of this icon at runtime. During rule resolution at runtime, the system uses the Applies To key part of the current rule as the first key part. At runtime, the icon is not available to users who do not hold this privilege. IS IT NOT VISIBLE OR IS IT GRAYED OUT? Click the pencil icon () to review or create the privilege rule. |
Read-Write Style |
Not used. |
Read-Only Style |
Optional. By default, when the work object form or
flow action form appears in read-only mode, the CSS style
named Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override the standard style sheet in the text file rule webwb.user_work_form.css. |
Use Header Styles |
Select to change this table cell to use header styles (by changing from <TD> elements to <TH> elements). |
Inline Style |
To apply inline styling to this cell only, type a CSS style definition in this field, or click the magnifying glass to access a Style Editor window. Styles you enter in this field supplement and override style elements defined in style sheets, according to normal CSS rules. Inline styles are recorded in the generated HTML for the form; they do not alter the CSS definitions. Using the Style EditorYou can select the font, color, font size, text align, vertical align PROJ 242 – TASK 16156, borders, margins, and other attributes of this cell using selection lists. The Style Editor maintains a preview of the resulting presentation. If you alter the style definition directly, click Apply to update the preview. Click OK to record the style defined with the Style Editor in the panel. |
Additional information for custom icons
When you choose CUSTOM
as the Type
value, additional fields appear on the Advanced tab.
When clicked, the custom icon executes an activity, using parameter values determined in this panel or parameter values determined by user input.
Field |
Description |
Do Action |
Select an activity to execute when users click the custom icon. To find the activity at runtime, the system uses the Applies To key part of this rule as the initial Applies To key part of the activity. |
Parameters |
If the activity selected accepts input parameters, you can specify sources for the parameter values here, or allow users to enter them at runtime. To define parameter values on the panel, enter a constant value, a property reference, or expression for each parameter. |
Pass Current Parameters |
Select to share the parameter page of the current activity with the called activity. |
params |
If the activity accepts input parameters, enter constant values for each required parameter. |
(no label) |
Select one: GROVS 5/19/05
|
No Data Submission |
If you selected |
Target Name |
If you selected |
Window Width |
If you selected |
Window Height |
If you selected |
Icons listed in the following table support standard activities. You can override the activity or the ToolTip text.
To avoid user confusion, do not use a standard icon for a processing function that is unrelated to its default function.
Type |
Icon Style and Description |
Add New Work
|
|
Attachments
|
|
Cancel
|
|
Contents
|
|
Enable Action Section
|
|
Expand/Collapse
|
|
Explore
|
|
Finish Assignment
|
|
Get Next Work
|
|
History
|
|
Local Action
|
|
Reopen Work Item
|
|
Review
|
|
Save
|
|
Show Reopen Screen
|
|
Show Flow Location
|
If the
harness rule is a New harness — one supporting the
entry of new work objects — do not include the
|
Spell Checker
|
|
Update
|
This capability is not desirable in all applications, as it allows users to overwrite values entered previously, perhaps by other users. The Apply button sends changed user inputs to the server, but does not commit these changes. The user must select and complete a flow action to save the changes. See Understanding transactions in flow executions. Clinic 9/6/05 |