Home | Class Index

SDK Version: 3.2.1-255201

Documentation generated on 02 April 2013

    • /
        • /libs/javascript/caplin/src\caplin\element\styler\StaleStyler
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\GroupHeaderDecorator
          • js
        • /libs/javascript/caplin/src\caplin\grid\decorator\RowLoadingDecorator
          • js
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 oRendererType, Array pPrimaryFieldNames, caplin.control.Control An)

StreamRenderer is an abstract base class, therefore this constructor should not be directly invoked.

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 sClassName)

caplin.control.Control getControl()

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

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

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 unbindHandlers()

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

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 oRendererType, Array pPrimaryFieldNames, caplin.control.Control An)

StreamRenderer is an abstract base class, therefore this constructor should not be directly invoked.

Instead, the RendererFactory should be used to create instances, which requires the RendererTypes to have been declared in XML and loaded using the RendererTypeLoader.

Parameters
caplin.element.factory.RendererType oRendererType The renderer type
Array pPrimaryFieldNames The list of model field names
caplin.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 sClassName)

Parameters
Object mFieldValues
Object sClassName

► caplin.control.Control getControl()

Returns a control corresponding to the renderer.

Returns
The control

► String getVariable( sVariableName)

Gets the renderer's variable.

Parameters
sVariableName
Returns
The variable value

► void onRendererEvent(Object oDomEvent)

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 oDomEvent The DOM event that was fired

► void refresh()

Apply all pending updates

► void resetUnformattedStreamValue()

Creates a null value for this renderer type

► void unbindHandlers()

Unbinds event listeners from the control for all the handlers.

► void updateStreamValues(Map mFieldValues)

Updates the renderer with the new value.

Parameters
Map mFieldValues The field values.