Caplin Trader 5.1.0

Class: module:ct-element/handler/RemoveGridRowOnClickHandler

module:ct-element/handler/RemoveGridRowOnClickHandler()

new module:ct-element/handler/RemoveGridRowOnClickHandler()

This handler traps click events and passes a 'removeRowClick' the module:ct-element/RendererEventListener.

RemoveGridRowOnClickHandler is a flyweight singleton, and therefore this constructor should never be invoked directly.

Instead, it is instantiated by the RendererFactory, which reads RendererType specifications from XML and instantiates the handlers by name.

Extends:

Extends

Methods

finalise(renderer)

Allows the handler to perform tear-down on the renderer. This method is called after the renderer is unbound from the view.

Parameters:
Name Type Description
renderer module:ct-element/Renderer

The renderer that is being finalised.
Inherited From:

initialise(renderer, attributes)

Allows the handler to perform any initialisation code on the renderer. This method is called after the renderer is bound to the view for the first time. Implementing this method is optional.

Parameters:
Name Type Description
renderer module:ct-element/Renderer

The renderer that is being initialised
attributes object

Any configuration parameters for this handler.
Inherited From:

onclick(domEvent, renderer) → {Map}

Traps the onclick event and returns a 'removeRowClick' event for passing up to the RendererEventListener.

All the functions that begin with on are assumed to be event handler functions, and are attached to DOM elements by reflection.

Parameters:
Name Type Description
domEvent Object

The DOM event
renderer Object

The renderer
Returns:

A 'removeRowClick' event

Type
Map

toString() → {String}

Returns a human-readable string representation of the handler, which is useful for debugging.

Overrides:
  • module:ct-element/Handler#toString
Returns:

The string representation

Type
String