HTML Client 5.0.1

Class DynaScrollTable


class DynaScrollTable
extends VisualTable

A data table that can be fed with real-time data delivered by Lightstreamer Server and displayed into a screen table in such a way that new updates add new rows to the page. The class contains the subscription details and the event handlers needed to allow Lightstreamer to display the real-time data.
A screen table suitable for the visualization of pushed values is dynamically maintained by Lightstreamer, starting from an HTML hidden template row, containing cells. The template row can be provided as any HTML element owning the "source='Lightstreamer'" special attribute, while the element "ID" attribute defines the screen table id. The association is made when the data table is brought to the "running" state, through the identifier supplied to PushPage.addTable(), that must match the screen table id. The contained cells are defined as any DOM elements owning the "source='Lightstreamer'" special attribute, together with a "field" attribute.
For each pushed update, a new row is cloned from the hidden template and attached after it; then, each value is displayed in a cell inside the new row that is associated to the involved field. By default the new value will be set as the cell's content (or its value in case the cell is an INPUT or a TEXTAREA element). It is possible to override this behavior by specifying a special "update" attribute containing the name of the attribute of the cell to be updated. Any string can be specified; moreover a value of a stylesheet can be specified using the "style.attribute" form (note that the DOM attribute name should be used, not the CSS name; e.g. "style.backgroundColor" is correct, while "style.background-color" is not). WARNING: also events like "onclick" can be assigned; in such cases make sure that no malicious code will be pushed by the Data Adapter (for example through the injection of undesired JavaScript code).
NOTE: the cell/field association depends on the value specified in the "field" attribute of each cell, which should be a valid field descriptor. Only one cell for each field is supported in the template.
Note that the template element can contain an arbitrary HTML structure and should contain HTML cells to be used to display the row field values. However, it should not contain elements to which an ID has been assigned, because the elements will be cloned and the HTML specification prescribes that an ID must be unique in the document. (The ID of the template element, required by Lightstreamer, is not cloned).
More visualization actions can be performed through the provided event handlers.

Defined in lspushpage.js

Constructor Summary
DynaScrollTable (<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)
            Creates an object to be used to describe a data table whose values should be displayed and cumulated into dynamically generated HTML rows.
Method Summary
 Number getMaxDynaRows()
           Inquiry method that gets the maximum number of rows allowed in the data table.
 void onChangingValues(<DOMElement> domNode, <VisualUpdateInfo> updateInfo)
           Event handler that is called by Lightstreamer each time a new update is received, so that a new row enters the data table.
 void setAutoScroll(<String> type, <String> elementId)
           Setter method that enables or disables the automatic adjustment of the screen table scrollbars at each new update.
 void setMaxDynaRows(<Number> maxDynaRows)
           Setter method that sets the maximum number of rows allowed in the data table.
 void setUpwardScroll(<boolean> isUpwardScroll)
           Setter method that enables or disables upward scroll.
Methods inherited from class VisualTable
setClearOnRemove, setClearOnDisconnected, setClearOnAdd, setPushedHtmlEnabled, isPushedHtmlEnabled, showValues
Methods inherited from class Table
getSchema, getGroup, setDataAdapter, getId, setSelector, setItemsRange, setRequestedMaxFrequency, setRequestedBufferSize, setSnapshotRequired, onItemUpdate, onLostUpdates, onEndOfSnapshot, onStart, getClassName

Constructor Detail


DynaScrollTable(<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)

Method Detail


Number getMaxDynaRows()


void onChangingValues(<DOMElement> domNode, <VisualUpdateInfo> updateInfo)


void setAutoScroll(<String> type, <String> elementId)


void setMaxDynaRows(<Number> maxDynaRows)


void setUpwardScroll(<boolean> isUpwardScroll)

HTML Client 5.0.1

Lightstreamer HTML Client API
Documentation generated by JSDoc on Tue May 22 11:46:54 2012