Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.control.composite

CompositeControl

Implements caplin.control.Control.
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.

Constructor Summary

Attributes Name and Description
caplin.control.composite.CompositeControl(Object controlType)

A CompositeControl is control whose functions operate on a map control value.

Method Summary

Attributes Name and Description
Number getHeight()

Returns the height of the control.
Integer getId()

Gets the numeric id of this control.
Number getWidth()

Returns the width of the control.
void isBound()

Returns true if the control is bound to the DOM.
void removeFlash()

Removes the flash state from the control.
void setDomValue(String sValue)

Sets the value in the DOM.
void setId(Integer id)

Sets the id of this control.
Methods implemented from class caplin.control.Control:
addClass, clear, clearState, disable, enable, flash, focus, getAttributes, getValue, isEnabled, refresh, removeClass, replaceClass, select, setStyle, setValue, toString

Constructor Detail

► caplin.control.composite.CompositeControl(Object 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.

Parameters
Object controlType The control type.

Method Detail

► Number getHeight()

Returns the height of the control.

Returns
{Number} The height of the DOM element in pixels.

► Integer getId()

Gets the numeric id of this control.

Returns
{Integer} The numeric id of this control.

► Number getWidth()

Returns the width of the control.

Returns
{Number} The width of the DOM element in pixels.

► void isBound()

Returns true if the control is bound to the DOM.

► void removeFlash()

Removes the flash state from the control.

► void setDomValue(String sValue)

Sets the value in the DOM.

Parameters
String sValue The value to set in the DOM.

► void setId(Integer id)

Sets the id of this control.

Parameters
Integer id the value of the id to set.