Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.element.renderer

StreamRenderer

Implements caplin.element.Renderer, caplin.element.RendererFramework.

Constructor Summary

Attributes Name and Description
caplin.element.renderer.StreamRenderer(caplin.element.factory.RendererType rendererType, Array primaryFieldNames, caplin.control.Control control)

Method Summary

Attributes Name and Description
void 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.
void buildXhtml(Object mFieldValues, Object className)

caplin.control.Control getControl()

Returns a control corresponding to the renderer.
String getVariable(String variableName)

Gets the renderer's variable.
void onRendererEvent(Object domEvent)

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

Apply all pending updates
void resetUnformattedStreamValue()

Creates a null value for this renderer type
void setSerialId(int serialId)

Sets the serial id.
void unbindHandlers()

Unbinds event listeners from the control for all the handlers.
void updateStreamValues(Map fieldValuesMap)

Updates the renderer with the new value.
Methods implemented from class caplin.element.Renderer:
addRendererEventListener, clear, clearState, disable, enable, focus, getFieldValues, getFormattedValue, getName, getNamespace, getParsedValue, getUnformattedValue, getUnparsedValue, getValue, isEnabled, raiseEvent, removeRendererEventListener, select, setValue, toString, updateFields, updateFieldValues
Methods implemented from class caplin.element.RendererFramework:
bind, createHtml, createXhtml, finalize, getAllFieldNames, getElement, getPrimaryFieldNames, getSerialId, initialize, isBound, setName, setNamespace, unbind

Constructor Detail

► caplin.element.renderer.StreamRenderer(caplin.element.factory.RendererType rendererType, Array primaryFieldNames, caplin.control.Control control)

Parameters
caplin.element.factory.RendererType rendererType The renderer type.
Array primaryFieldNames The list of model field names.
caplin.control.Control control An instance of the screen control.

Method Detail

► void 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.

► void buildXhtml(Object mFieldValues, Object className)

Parameters
Object mFieldValues
Object className

► caplin.control.Control getControl()

Returns a control corresponding to the renderer.

Returns
{caplin.control.Control} The control

► String getVariable(String variableName)

Gets the renderer's variable.

Parameters
String variableName The variable name to retrieve.
Returns
{String} The variable value

► void onRendererEvent(Object 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
Object domEvent The DOM event that was fired

► void refresh()

Apply all pending updates

► void resetUnformattedStreamValue()

Creates a null value for this renderer type

► void setSerialId(int serialId)

Sets the serial id.

Parameters
int serialId The serial id

► void unbindHandlers()

Unbinds event listeners from the control for all the handlers.

► void updateStreamValues(Map fieldValuesMap)

Updates the renderer with the new value.

Parameters
Map fieldValuesMap The field values map.