Home | Class Index

SDK Version: 3.3.1-263455

Documentation generated on 25 June 2013

Interface
caplin.control.factory

ControlFramework

The ControlFramework interface specifies those lifecycle functions that are necessary for a control implementation to be managed by the Control Framework.

Constructor Summary

Attributes Name and Description
caplin.control.factory.ControlFramework()

Method Summary

Attributes Name and Description
void attachControlEventListener(String sEventName, caplin.element.Renderer oRenderer)

Attaches an event listener to the control.
void bind(HtmlElement eControlElement, boolean bIsDummy)

Binds the DOM control.
String createHtml(Variant vValue)

Creates an HTML fragment using the supplied control value.
void detachControlEventListener(String sEventName)

Detaches event listeners from the control.
void finalize()

Releases any resources and unbinds the control from the DOM.
String getInitialClassName()

Gets the initial class name.
void initialize()

Initializes the control, clearing any cached value and cached CSS styling information.
void setInitialClassName(String sInitialClassName)

Sets the initial class name.
void unbind()

Unbinds the DOM control.

Constructor Detail

► caplin.control.factory.ControlFramework()

Method Detail

► void attachControlEventListener(String sEventName, caplin.element.Renderer oRenderer)

Attaches an event listener to the control. When the event occurs on the control then the onRendererEvent callback will be invoked on the supplied renderer.

Parameters
String sEventName The event name such as 'click', 'change', 'mouseover' etc.
caplin.element.Renderer oRenderer The renderer

► void bind(HtmlElement eControlElement, boolean bIsDummy)

Binds the DOM control.

Parameters
HtmlElement eControlElement The DOM element which represents the control
boolean bIsDummy (optional) True if the supplied control is a dummy

► String createHtml(Variant vValue)

Creates an HTML fragment using the supplied control value.

Parameters
Variant vValue The field vale to display
Returns
The HTML fragment

► void detachControlEventListener(String sEventName)

Detaches event listeners from the control.

Parameters
String sEventName The event name such as 'click', 'change', 'mouseover' etc.

► void finalize()

Releases any resources and unbinds the control from the DOM.

► String getInitialClassName()

Gets the initial class name.

Returns
The initial class name.

► void initialize()

Initializes the control, clearing any cached value and cached CSS styling information.

► void setInitialClassName(String sInitialClassName)

Sets the initial class name.

Parameters
String sInitialClassName The HTML class attribute (a space separated list)

► void unbind()

Unbinds the DOM control.