Form Tree Component

Canvas now enables you to capture data in multiple levels as a hierarchy in a form. For instance, to create a user friendly screen for capturing user groups, we would need a component structure which supports multi-level hierarchy. For example, to display the branches of ABC Bank in the following hierarchical structure:

  • Tamil Nadu
    • Chennai
      • Guindy
      • Broadway
  • Maharashtra
    • Mumbai
      • Santa Cruz
      • Powai
  • Karnataka
    • Bangalore
      • Koramangala
      • Ulsoor


To capture a hierarchy of data, Canvas has introduced a form component called Tree under Containers&More panel in Form Designer. This component helps you add repeatable items with support to extend multiple levels further on.



Modes
The tree form component operates in three modes of behaviour.

  • View Mode
  • Select Mode
  • Admin Mode

View Mode:



Select Mode:

Admin Mode:



To display a form when users click Add, you must use a data support class (Java).


The following table provides information about the properties that are applicable to this form item:


#

Property

Description

Sample Values

1

Form ID

Unique ID of the Form on which you want to place the Form Item.

INFO_FORM

2

Item ID

Unique ID to the Form Tree Component.

TREE_VIEW705

3

Item Type

To identify the item type in a form.

TREEVIEW

4

Channel

Assigns the form item compatibility for various devices.

Desktop / Tablet / Mobile

5

Bundle Key

Name of the key associated with the property file which provides the localized label text for the current form item. Form item bundle key supersede the form level bundle key. If this value is blank, form level bundle key will be used to find label keys.

Common

6

Plain Label

Text entered in Plain Label field appears as the label of the form item without the resource bundle key translation.

18.1:

If you are using the property files, leave the Plain Label field as blank.
See About Display Name Key and Plain Label till 18.1 for more details about this property and the related conditions.

Display Name Key is the property-driven label key for the form item. 
See About Display Name Key and Plain Label till 18.1 for more details about this property and the related conditions.

19.1:

In Canvas 19.1, the Display Name Key field is a configuration-driven label key for the form item. 

See About Display Name Key and Plain Label from 19.1 and Managing Display Names for Forms for more information.


7

Display Name Key

Branches

8

Edit

Selected: Renders the Form in edit enabled mode.
De-Selected: Renders the Form in edit disabled mode.

Selected

9VisibilitySelected: Shows the form item on the Form.
De-Selected: Hides the form item from the form, but the data will still be in active.
Selected
10

Help

Selected: Renders the form item with a help icon.
De-Selected: Renders the form item without a help icon.
Refer the Configuring Help Messages and Tooltips for Form Items section for more information on configuring help text.

Selected

11

Print

Selected: Allows printing the form item while printing the form.
De-Selected: Does not print the particular form item while printing the form.

Selected

12AnchorDefines the size of the form item in terms of percentage (without % symbol).50
13

Column Span

Occupies the specified number of item spaces horizontally for the current item.

2

14Label Alignment

Indicates the alignment of the labels of the form items.
Select Options: Left () or Top ().

Top
15Hide LabelSelected: Hides the label of the form item.
De-Selected: Shows the label of the form item.
Selected
16MandatorySelected: Shows the red asterisk ({}{*}) on the label of the form item, and converts the particular field as mandatory.
De-Selected: Considers the particular field as non-mandatory.
Selected
17Conditional MandatorySelected: Shows the blue double asterisks ({}{}) on the label of the form item, and converts the particular field as conditional mandatory.
Note: If selected, write the conditional logic in the CFEC.PRE_VALIDATE event. See Form Item Handlers for more information.
De-Selected: considers the particular field as normal.
If 'Mandatory' is already selected, do not select this property.
De-Selected
18Event Wiring

The Event Wiring option enables you to assign various events for different set of actions. For detailed information on Event Wiring, refer Form Items Event Wiring.


19Settings Menu: Multi Select

Enables you to select multiple items. 
Selected: Multiple items can be selected. 
De-Selected: Multiple items cannot be selected. 


20

Clone

Enables you to create a duplicate of the selected form item along with its applicable properties except for the Item ID.

2

For usage information on Form Tree component, refer Using the Form Tree Component.