Caplin Trader 4.8.0

Class: module:caplin/control/complex/SpreadControl

module:caplin/control/complex/SpreadControl

The custom SpreadControl is a composite control for displaying a bid and ask price together using one Renderer.

As with all controls, instances are created by the RendererFactory (which uses XML RendererTypes) therefore this constructor should never be invoked.

Constructor

new module:caplin/control/complex/SpreadControl(controlType)

Constructs a new SpreadControl with the specified arguments.
Extends:
Parameters:
Name Type Description
controlType module:caplin/control/factory/ControlType The control type.

Extends

Methods

getHeight() → {number}

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

getId() → {integer}

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

getWidth() → {number}

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

isBound()

Returns true if the control is bound to the DOM.
Inherited From:

removeFlash()

Removes the flash state from the control.
Inherited From:

setDomValue(sValue)

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

setId(id)

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