Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Column Template supports the following events:


Note

Whether you define a Cell Click, Row Click, Cell Double Click, Row Double Click, Change or a Context Click event, the data that is returned will be:

  • Column ID
  • Template configuration (value)
  • Current row data


Anchor
ColumnTemplate_CellClickRowClick
ColumnTemplate_CellClickRowClick
Cell Click and Row Click Events

The Cell Click event occurs when a cell is clicked once. The Cell Click event also raises the Row Click event.

...

  • Cell Click event

    Code Block
    languagejs
    CWEH.registerHandler('BENE_WGT', CWEC.CELL_CLICK, function(columnId, value, record)
    {
    	LOGGER.info('The CELL_CLICK click event is triggeredcaptured', [columnId, value, record]);
    });
    
    // Here, 'BENE_WGT' is the widget ID.


  • Row Click event

    Code Block
    languagejs
    CWEH.registerHandler('BENE_WGT', CWEC.ROW_CLICK, function(columnId, record, value)
    {
    	LOGGER.info('firedThe ROW_CLICK event is captured.', [columnId, record, value]);
    });
    
    // Here, 'BENE_WGT' is the widget ID.


Anchor
ColumnTemplate_CellDblClickRowDblclick
ColumnTemplate_CellDblClickRowDblclick
Cell Double-Click and Row Double-Click Events

The Cell Double Click event occurs when a cell is clicked twice. The Cell Double Click event also raises the Row Double Click event.

The Row Double Click event occurs when a row is clicked twice.

Note

For the Cell Double Click and the Row Double Click events to function, the attribute data-single-click = "true" must be defined. As we are configuring the template for a column, we need to define the attribute data-column-id = '<Column ID>' as well.

For example, when you double click a textbox on the Reference Number column of the Beneficiary Details widget, the Cell Double Click event is raised.

Image Added

To achieve this, you need to define the Cell Double Click event attributes in the Column Template as follows:

Code Block
languagexml
<input 
	type = "text"
	data-single-click = "true"
	value = {{ BENE_ID }}
	data-column-id = "BENE_ID"
>
<!-- BENE_ID is the Reference Number column's ID. -->

On a Cell Double Click, the column ID is returned followed by the template configuration (value) and the row details. On a Row Double Click the column ID is returned followed by the row details and the template configuration (value) as shown in the following image:

Image Added

To capture actions through the Cell Double Click and Row Double Click events, use the event handler functions. For the Reference Number column, you need to capture the actions as follows:

  • Cell Double Click event

    Code Block
    languagejs
    CWEH.registerHandler('BENE_WGT', CWEC.CELL_DBLCLICK, function(columnId, value, record)
    {
    	LOGGER.info('The CELL_DBLCLICK event is captured.', [columnId, value, record]);
    });
    
    // Here, 'BENE_WGT' is the widget ID.


  • Row Double Click event

    Code Block
    languagejs
    CWEH.registerHandler('BENE_WGT', CWEC.ROW_DBLCLICK, function(columnId, record, value)
    {
    	LOGGER.info('The ROW_DBLCLICK event is captured.', [columnId, record, value]);
    });
    
    // Here, 'BENE_WGT' is the widget ID.


Anchor
ColumnTemplate_ChangeEvent
ColumnTemplate_ChangeEvent
Change Event

The Change event occurs when the value of an element is changed. For example, selecting or deselecting a checkbox or radio button. The Change event also raises the Cell Click and Row Click events.

Note

The Change event is applicable only for checkboxes and radio buttons.

For the Change event to function, the attribute data-input = "true" must be defined. As we are configuring the template for a column, we need to define the attribute data-column-id = '<Column ID>' as well.

For example, when you select and deselect the checkbox of a reference number on the Reference Number column of the Beneficiary Details widget, the Change event is triggered.

Image Added

To achieve this you need to define the Change event attributes in the Column Template as follows:

Code Block
languagexml
<input 
	type = 'checkbox'
	data-input = "true"
	data-column-id = 'BENE_ID'
>
<!-- BENE_ID is the Reference Number column's ID. -->

When you select the checkbox, the Change event triggers and the row data followed by the column ID and the template configuration (value) is returned. An additional attribute data-checked = ”checked” is added to the template configuration. When the checkbox is deselected this attribute gets removed from the template configuration as shown in the following screen shots:

  • After selecting the checkbox:

    Image Added

  • After deselecting the checkbox:

    Image Added

To capture actions through the Change event, use the event handler functions. For the Reference Number column, you need to capture the actions as follows:

Code Block
languagejs
CWEH.registerHandler(‘BENE_WGT’, CWEC.CELL_DATA_CHANGE, function(record, columnId, value)
{
	LOGGER.info('The CELL DATA CHANGE event is captured.', [record, columnId, value]);
});
// Here, 'BENE_WGT' is the widget ID.

Anchor
ColumnTemplate_ContextClick
ColumnTemplate_ContextClick
Context Click Event

A Context Click event is raised when you right-click on a cell, column or row in the widget. For example, when you right-click on a cell of the Widget Activity Summary > Saved widget, a context menu with edit and delete option appears.

Note

For the Context Click event to function, the attribute data-context-click = ”true” must be defined. As we are configuring the template for a column, we need to define the attribute data-column-id = '<Column ID>' as well.

The following is a sample screenshot of the Widget Activity Summary > Saved widget with the context menu enabled.

Image Added

To achieve this you need to define the context event attributes as follows:

Code Block
languagexml
<input
	type = 'text'
	data-context-click = "true"
	data-column-id = 'BENE_ID'
>
<!-- BENE_ID is the Reference Number column's ID. -->

On a Context Click, the column ID is returned followed by the template configuration (value) and the row details as shown in the following image:

Image Added

The template configuration code for the Reference Number column is as follows:

Code Block
languagexml
{{ #if tplData }}
	<input 
		data-input = 'true'
		type = 'text'
		value = {{ tplData }}
		data-column-id = 'BENE_ID'
		data-single-click = 'true'
		data-context-click = "true"
	>
{{ /if }}
<!-- BENE_ID is the Reference Number column's ID. -->

To capture actions through the Context Click event, use the event handler functions. For the Reference Number column, you need to capture the actions as follows:

Code Block
languagejs
CWEH.registerHandler('WGT_DRAFT', CWEC.CONTEXT_CLICK, function(columnId, value, record)
{
	LOGGER.info('The CONTEXT_CLICK event is captured.', [columnId, value, record]);
});

// Here, 'WGT_DRAFT’ is the widget ID.