Caplin Trader 4.8.0

Interface: module:caplin/control/Control

module:caplin/control/Control

A Control is a screen control with which a user interacts, such as an input box, a drop-down box, or a straightforward text label.

This interface allows module:caplin/element/Stylers to interact with the Control in order to apply visual effects.

Implementations:

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

clear()

Clear the control and returns it to its original state.
Implementations:

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

disable()

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

enable()

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

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

focus()

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

getAttributes() → {Map}

Gets the controls attributes
Implementations:
Returns:
A map of attributes.
Type
Map

getValue() → {Variant}

Gets the control value from the control.
Implementations:
Returns:
The control value.
Type
Variant

isEnabled() → {Boolean}

Determines whether the control is enabled.
Implementations:
Returns:
true if the control is enabled.
Type
Boolean

refresh()

Refresh the screen.
Implementations:

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

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

select()

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

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

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

toString() → {String}

Returns a human-readable string representation of the object, which is useful for debugging.
Implementations:
Returns:
The string representation
Type
String