Class: module:caplin/element/renderer/SingleStreamRenderer

Extends

• module:caplin/element/renderer/StreamRenderer

Methods

bindHandlers()

Binds event listeners to the control for all the handlers, which will result in a callbacks to the onRendererEvent() method then any event occurs.

Inherited From:

• module:caplin/element/renderer/StreamRenderer#bindHandlers

buildXhtml(mFieldValues, className)

Parameters:

Name	Type	Description
mFieldValues	Object
className	Object

Inherited From:

• module:caplin/element/renderer/StreamRenderer#buildXhtml

getControl() → {module:caplin/control/Control}

Returns a control corresponding to the renderer.

Inherited From:

• module:caplin/element/renderer/StreamRenderer#getControl

Returns:

The control

Type

module:caplin/control/Control

getVariable(variableName) → {String}

Gets the renderer's variable.

Parameters:

Name	Type	Description
variableName	String	The variable name to retrieve.

Inherited From:

• module:caplin/element/renderer/StreamRenderer#getVariable

Returns:

The variable value

Type

String

onRendererEvent(domEvent)

Event handler callback function that receives the events attached to the controls and defined in the handlers.

All control events call this function.

Parameters:

Name	Type	Description
domEvent	Object	The DOM event that was fired

Inherited From:

• module:caplin/element/renderer/StreamRenderer#onRendererEvent

refresh()

Apply all pending updates

Inherited From:

• module:caplin/element/renderer/StreamRenderer#refresh

setSerialId(serialId)

Sets the serial id.

Parameters:

Name	Type	Description
serialId	int	The serial id

Inherited From:

• module:caplin/element/renderer/StreamRenderer#setSerialId

toString() → {String}

Returns a human-readable string representation of the object, which is useful for debugging.

Returns:

The string representation

Type

String

unbindHandlers()

Unbinds event listeners from the control for all the handlers.

Inherited From:

• module:caplin/element/renderer/StreamRenderer#unbindHandlers

updateStreamValues(fieldValuesMap)

Updates the renderer with the new value.

Parameters:

Name	Type	Description
fieldValuesMap	Map	The field values map.

Inherited From:

• module:caplin/element/renderer/StreamRenderer#updateStreamValues