Caplin Trader 4.8.0

Class: module:caplin/control/composite/CompositeControl

module:caplin/control/composite/CompositeControl

Constructor

new module:caplin/control/composite/CompositeControl(controlType)

A CompositeControl is control whose functions operate on a map control value. This is an abstract base class, therefore the constructor should not be directly invoked. The CompositeControl is a special type of composite control that accepts a Map control value and applies formatters, stylers (and parsers) on elements in the map according to the downstream (and upstream) definitions in the RendererType XML.
Parameters:
Name Type Description
controlType object The control type.
Implements:

Methods

getHeight() → {number}

Gets the height of the control.
Returns:
The height of the DOM element in pixels.
Type
number

getId() → {integer}

Gets the numeric id of this control.
Returns:
The numeric id of this control.
Type
integer

getWidth() → {number}

Gets the width of the control.
Returns:
The width of the DOM element in pixels.
Type
number

isBound()

Returns true if the control is bound to the DOM.

removeFlash()

Removes the flash state from the control.

setDomValue(sValue)

Sets the value in the DOM.
Parameters:
Name Type Description
sValue string The value to set in the DOM.

setId(id)

Sets the id of this control.
Parameters:
Name Type Description
id integer the value of the id to set.