Caplin Trader 5.1.0

Class: module:ct-control/composite/CompositeControl

module:ct-control/composite/CompositeControl(controlType)

new module:ct-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

addClass(className)

Adds the specified CSS class name to the control. This has no effect if it is already on the element.

Parameters:
Name Type Description
className String

The CSS class name to add to the DOM.
Implements:

clear()

Clear the control and returns it to its original state.

Implements:

clearState()

Clears the state of the control without modifying the displayed value. This is a faster version of clear for when you are going to update the displayed value immediately after clearing.

Implements:

disable()

Disables the control. Does nothing if the control has no concept of enabled/disabled.

Implements:

enable()

Enables the control. Does nothing if the control has no concept of enabled/disabled.

Implements:

flash(value, duration)

Flashes the control based on the new control value. Does nothing if the control has no concept of flash. Note that this does not write the new value to the control itself, it merely styles the control according to the value.

Parameters:
Name Type Description
value Variant

The new control value.
duration int

The flash duration in milliseconds.
Implements:

focus()

Moves the focus to this control. Does nothing if the control has no concept of focus.

Implements:

getAttributes() → {Map}

Gets the controls attributes

Implements:
Returns:

A map of attributes.

Type
Map

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.

Implements:
Returns:

The numeric id of this control.

Type
integer

getValue() → {Variant}

Gets the control value from the control.

Implements:
Returns:

The control value.

Type
Variant

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.

isEnabled() → {Boolean}

Determines whether the control is enabled.

Implements:
Returns:

true if the control is enabled.

Type
Boolean

refresh()

Refresh the screen.

Implements:

removeClass(className)

Removes the specified CSS class name from the control. This has no effect if it is not already on the element.

Parameters:
Name Type Description
className String

The CSS class name to add to the DOM.
Implements:

removeFlash()

Removes the flash state from the control.

Implements:

replaceClass(oldClassName, newClassName)

Replaces the specified CSS class on the control with a new class.

Parameters:
Name Type Description
oldClassName String

The old CSS class to remove.
newClassName String

The new CSS class to add.
Implements:

select()

Moves the focus and highlights this control. Does nothing if the control has no concept of focus.

Implements:

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.
Implements:

setStyle(styleName, styleValue)

Sets the specified style the control's DOM element.

Parameters:
Name Type Description
styleName String

The style name to add to the DOM.
styleValue String

The style value.
Implements:

setValue(value)

Sets the control value, which will update the screen. Depending on the renderer type, this will either be a simple string (if the renderer has no streams) or a map with stream names as its keys.

Parameters:
Name Type Description
value Variant

The new control value.
Implements:

toString() → {String}

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

Implements:
Returns:

The string representation

Type
String