Constructor
new module:caplin/control/basic/MultiStreamTextControl(controlType)
Constructs a new
MultiStreamTextControl
with the specified arguments.
Extends:
Parameters:
Name | Type | Description |
---|---|---|
controlType |
module:caplin/control/factory/ControlType | The control type. |
Extends
Methods
-
addClass()
-
- Inherited From:
- See:
-
attachControlEventListener()
-
bind()
-
clear()
-
- Inherited From:
- See:
-
- caplin.control.Control#clear
-
clearState()
-
detachControlEventListener()
-
disable()
-
- Inherited From:
- See:
-
enable()
-
- Inherited From:
- See:
-
finalize()
-
flash()
-
- Inherited From:
- See:
-
focus()
-
- Inherited From:
- See:
-
getAttributes()
-
getElement() → {DOMElement}
-
Gets the element associated with this control.
- Inherited From:
Returns:
the element associated with this control.- Type
- DOMElement
-
getFlashDuration() → {Numeric}
-
Gets the value of the flash duration.
- Inherited From:
Returns:
the value of the flash duration.- Type
- Numeric
-
getId() → {Integer}
-
Gets the numeric id of this control.
- Inherited From:
Returns:
The numeric id of this control.- Type
- Integer
-
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
Numeric The new value. oldValue
Numeric The old value. 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:
- See:
-
initialize()
-
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; otherwisefalse
.- Type
- boolean
-
isEnabled()
-
refresh()
-
- Inherited From:
- See:
-
removeClass()
-
removeFlash()
-
Removes the flash state from the control.
- Inherited From:
-
replaceClass()
-
select()
-
- Inherited From:
- 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. -
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. - 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:
-
setInitialClassName()
-
setStyle()
-
- Inherited From:
- See:
-
setTooltip(tooltip)
-
Sets the tooltip value for this control.
Parameters:
Name Type Description tooltip
String the tooltip value. - Inherited From:
-
setValue()
-
- Inherited From:
- See:
-
toString()
-
- Inherited From:
- See:
-
unbind()