Skip to Main Content

Introduction

This page demonstrates integration with the Set value dynamic action, Change events, built-in validation, and accessibility features. The right-hand column is frozen by default. You can unfreeze the column by clicking the button.

Set Value

In this example changing a value in the ename column triggers one of the four defined dynamic actions which set the value of the flag column. Setting the ename column to:

  • JONES results in setting the plug-in value to Y - checkbox selected
  • SCOTT results in setting the plug-in value to N - checkbox not selected
  • JAMES results in setting the plug-in value to NULL
  • any other value results in setting the plug-in value to INVALID

Change Events

The plug-in exposes a Change [United Codes Interactive Grid Checkbox] event. The difference this event and the native Change event is that it reveals additional data through this.data. You can learn more about exposed data in table below:

PropertyDescription
this.data.regionThe region interface returned from execution of apex.region.
this.data.gridThe interactiveGridView interface returned from getViews interactiveGrid widget method.
this.data.recordThe result of grids widget method getActiveRecord.
this.data.recordIdRecord Id returned by model interface using getRecordId method.
this.data.columnThe column name on which the plug-in change event occured.
this.data.valueThe current value of the given column in given record.

Use the following links to learn more about the interfaces referenced, namespace, widgets and widget methods:

On this page you will find an example implementation of the plug-in change event. Change the state of the column flag and inspect this.data the properties displayed in the form below the interactive grid. Properties this.data.region and this.data.grid are not included.

Validation

The plug-in has built-in validation which is executed when the interactive grid is saved. If the value of a column using the plug-in is equal the Value When Checked or Value When Not Checked attribute or is NULL then validation is succesful. Otherwise, the built-in validation raises an error.

The validation error message can be customized using APEX Translation Text UC_IG_CHECKBOX_VALIDATION. Use %0 to reference a column label and %1 to reference the invalid value.

You can see validation at work on this page. Set any column value to any value other than JONES, SCOTT and JAMES and save the interactive grid.

Accessibility

Keyboard-only actions are supported. In interactive grid read mode navigate to cell containing the plug-in and press the Enter key to activate interactive grid edit mode. When the plug-in checkbox or icon is in focus, you can change the state by pressing the Spacebar key.

Settings

Container with border

Demo

IG container with padding

Example IG

Event Change data