Caplin Trader 5.1.0

Class: module:ct-control/basic/InputControl

module:ct-control/basic/InputControl(controlType)

This is a basic control that is used to display text and react to user gestures. Typically, the TextControl uses formatters and stylers to specify how the text appears to the user, and handlers to capture user interactions such as mouse movements and clicks.

Constructor

new module:ct-control/basic/InputControl(controlType)

Constructs a new InputControl with the specified arguments.

Extends:
Parameters:
Name Type Description
controlType module:ct-control/factory/ControlType

The control type.

Extends

Methods

addClass()

Inherited From:
Implements:
See:

attachControlEventListener()

Inherited From:
Implements:
See:

bind()

Overrides:
Implements:
See:

clear()

Inherited From:
Implements:
See:
  • ct-control/Control#clear

clearState()

Inherited From:
Implements:
See:

createFragment() → {Node}

Creates a fragment containing the control template

Inherited From:
Returns:

The fragment

Type
Node

detachControlEventListener()

Inherited From:
Implements:
See:

disable()

Overrides:
Implements:
See:

enable()

Overrides:
Implements:
See:

finalize()

Inherited From:
Implements:
See:

flash()

Inherited From:
Implements:
See:

focus()

Inherited From:
Implements:
See:

getAttributes()

Inherited From:
Implements:
See:

getElement() → {HTMLElement}

Gets the element associated with this control.

Inherited From:
Returns:

the element associated with this control.

Type
HTMLElement

getFlashDuration() → {number}

Gets the value of the flash duration.

Inherited From:
Implements:
Returns:

the value of the flash duration.

Type
number

getHeight() → {Integer}

Returns the height of the control.

Returns:

The height of the DOM element in pixels.

Type
Integer

getId() → {integer}

Gets the numeric id of this control.

Inherited From:
Implements:
Returns:

The numeric id of this control.

Type
integer

getInitialClassName()

Inherited From:
Implements:
See:

getNumericFlashDirection(newValue, oldValue) → {string}

Determines the numeric flash direction of the new value relative to the old value. If either new or old value is not a number (for example, if either value is undefined) then the function returns an empty string.

Parameters:
Name Type Description
newValue number

The new value.
oldValue number

The old value.
Inherited From:
Returns:

'up', 'down' or 'flat' depending on whether the new value is respectively greater than, less than or equal to the old value.

Type
string

getValue()

Overrides:
Implements:
See:

getWidth() → {Integer}

Returns the width of the control.

Returns:

The width of the DOM element in pixels.

Type
Integer

initialize()

Inherited From:
Implements:
See:

isBound() → {boolean}

Indicates whether the control is bound to an HTML Element.

Inherited From:
Returns:

true if the control is bound to an HTML Element; otherwise false.

Type
boolean

isEnabled()

Overrides:
Implements:
See:

refresh()

Overrides:
Implements:
See:

removeClass()

Inherited From:
Implements:
See:

removeFlash()

Removes the flash state from the control.

Inherited From:
Implements:

replaceClass()

Inherited From:
Implements:
See:

select()

Inherited From:
Implements:
See:

setAttribute(name, value)

Sets a control attribute.

Parameters:
Name Type Description
name string

The name of the attribute to set.
value Variant

The value to set.
Inherited From:
See:

setDomAttribute(attributeName, attributeValue)

Sets the given HTML attribute value on of the underlying HTML element.

Parameters:
Name Type Description
attributeName string

the HTML attribute name to be set.
attributeValue string

the HTML attribute value to set.
Inherited From:

setDomClass(className)

Sets the DOM CSS classname of the underlying HTML element.

Parameters:
Name Type Description
className string

the CSS class name to set.
Inherited From:

setDomParentClass(className)

Sets the DOM CSS classname of the underlying parent HTML element.

Parameters:
Name Type Description
className string

the CSS class name to set.
Inherited From:

setDomStyle(styleName, styleValue)

Sets the given CSS style value on of the underlying HTML element.

Parameters:
Name Type Description
styleName string

the CSS style name to be set.
styleValue string

the CSS value to set.
Inherited From:

(abstract) setDomValue(value)

Sets the value in the DOM. Implementing classes must specify how their DOM value will be set.

Parameters:
Name Type Description
value string

The value to set in the DOM.
Overrides:

setId(id)

Sets the id of this control.

Parameters:
Name Type Description
id integer

the value of the id to set.
Inherited From:
Implements:

setInitialClassName()

Inherited From:
Implements:
See:

setStyle()

Inherited From:
Implements:
See:

setTooltip(tooltip)

Sets the tooltip value for this control.

Parameters:
Name Type Description
tooltip string

the tooltip value.
Inherited From:

setValue()

Inherited From:
Implements:
See:

toString()

Overrides:
Implements:
See:

unbind()

Inherited From:
Implements:
See: