Class: module:caplin/control/basic/TextControl

Extends

• module:caplin/control/basic/BasicControl

Methods

addClass()

Inherited From:

• module:caplin/control/basic/BasicControl#addClass

See:

• module:caplin/control/Control#addClass

attachControlEventListener()

Inherited From:

• module:caplin/control/basic/BasicControl#attachControlEventListener

See:

• module:caplin/control/factory/ControlFramework#attachControlEventListener

bind()

Inherited From:

• module:caplin/control/basic/BasicControl#bind

See:

• module:caplin/control/factory/ControlFramework#bind

clear()

Inherited From:

• module:caplin/control/basic/BasicControl#clear

See:

• caplin.control.Control#clear

clearState()

Inherited From:

• module:caplin/control/basic/BasicControl#clearState

See:

• module:caplin/control/Control#clearState

detachControlEventListener()

Inherited From:

• module:caplin/control/basic/BasicControl#detachControlEventListener

See:

• module:caplin/control/factory/ControlFramework#detachControlEventListener

disable()

Inherited From:

• module:caplin/control/basic/BasicControl#disable

See:

• module:caplin/control/Control#disable

enable()

Inherited From:

• module:caplin/control/basic/BasicControl#enable

See:

• module:caplin/control/Control#enable

finalize()

Inherited From:

• module:caplin/control/basic/BasicControl#finalize

See:

• module:caplin/control/factory/ControlFramework#finalize

flash()

Inherited From:

• module:caplin/control/basic/BasicControl#flash

See:

• module:caplin/control/Control#flash

focus()

Inherited From:

• module:caplin/control/basic/BasicControl#focus

See:

• module:caplin/control/Control#focus

getAttributes()

Inherited From:

• module:caplin/control/basic/BasicControl#getAttributes

See:

• module:caplin/control/Control#getAttributes

getElement() → {HTMLElement}

Gets the element associated with this control.

Inherited From:

• module:caplin/control/basic/BasicControl#getElement

Returns:

the element associated with this control.

Type

HTMLElement

getFlashDuration() → {number}

Gets the value of the flash duration.

Inherited From:

• module:caplin/control/basic/BasicControl#getFlashDuration

Returns:

the value of the flash duration.

Type

number

getId() → {integer}

Gets the numeric id of this control.

Inherited From:

• module:caplin/control/basic/BasicControl#getId

Returns:

The numeric id of this control.

Type

integer

getInitialClassName()

Inherited From:

• module:caplin/control/basic/BasicControl#getInitialClassName

See:

• module:caplin/control/factory/ControlFramework#getInitialClassName

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:

• module:caplin/control/basic/BasicControl#getNumericFlashDirection

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()

Inherited From:

• module:caplin/control/basic/BasicControl#getValue

See:

• module:caplin/control/Control#getValue

initialize()

Inherited From:

• module:caplin/control/basic/BasicControl#initialize

See:

• module:caplin/control/factory/ControlFramework#initialize

isBound() → {boolean}

Indicates whether the control is bound to an HTML Element.

Inherited From:

• module:caplin/control/basic/BasicControl#isBound

Returns:

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

Type

boolean

isEnabled()

Inherited From:

• module:caplin/control/basic/BasicControl#isEnabled

See:

• module:caplin/control/Control#isEnabled

refresh()

Inherited From:

• module:caplin/control/basic/BasicControl#refresh

See:

• module:caplin/control/Control#refresh

removeClass()

Inherited From:

• module:caplin/control/basic/BasicControl#removeClass

See:

• module:caplin/control/Control#removeClass

removeFlash()

Removes the flash state from the control.

Inherited From:

• module:caplin/control/basic/BasicControl#removeFlash

replaceClass()

Inherited From:

• module:caplin/control/basic/BasicControl#replaceClass

See:

• module:caplin/control/Control#replaceClass

select()

Inherited From:

• module:caplin/control/basic/BasicControl#select

See:

• module:caplin/control/Control#select

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:

• module:caplin/control/basic/BasicControl#setAttribute

See:

• module:caplin/control/Control#getAttributes

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:

• module:caplin/control/basic/BasicControl#setDomAttribute

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:

• module:caplin/control/basic/BasicControl#setDomClass

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:

• module:caplin/control/basic/BasicControl#setDomParentClass

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:

• module:caplin/control/basic/BasicControl#setDomStyle

(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.

Inherited From:

• module:caplin/control/basic/BasicControl#setDomValue

setId(id)

Sets the id of this control.

Parameters:

Name	Type	Description
id	integer	the value of the id to set.

Inherited From:

• module:caplin/control/basic/BasicControl#setId

setInitialClassName()

Inherited From:

• module:caplin/control/basic/BasicControl#setInitialClassName

See:

• module:caplin/control/factory/ControlFramework#setInitialClassName

setStyle()

Inherited From:

• module:caplin/control/basic/BasicControl#setStyle

See:

• module:caplin/control/Control#setStyle

setTooltip(tooltip)

Sets the tooltip value for this control.

Parameters:

Name	Type	Description
tooltip	string	the tooltip value.

Inherited From:

• module:caplin/control/basic/BasicControl#setTooltip

setValue()

Inherited From:

• module:caplin/control/basic/BasicControl#setValue

See:

• module:caplin/control/Control#setValue

toString()

Inherited From:

• module:caplin/control/basic/BasicControl#toString

See:

• module:caplin/control/Control#toString

unbind()

Inherited From:

• module:caplin/control/basic/BasicControl#unbind

See:

• module:caplin/control/factory/ControlFramework#unbind