HTML Client 5.0.1

Class ScrollTable


class ScrollTable
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 make the older ones scroll. 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 should be made of a matrix of HTML cells. Such cells can be defined at page loading, through PushPage.cellScroll(), or can be attached to the page DOM at any time, as DIV, SPAN or INPUT elements owning the "source='Lightstreamer'" special attribute, together with proper "row", "field" and "table" attributes; the latter 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. A ScreenTableHelper can also be used to this purpose also enabling the possibility to specify tags other than SPAN DIV and INPUT.
For each pushed update, each value is displayed in a cell that is associated to the involved field; the declared cell row numbers are then used to perform scrolling operations on the updates that have been already displayed. By default the new/scrolled value will replace 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 row-field combination is supported.
The initial contents and stylesheets supplied to the cells will also be used when cell clearing has to be performed (in case of a DIV or SPAN element, the stylesheet used is the one supplied through the "class" attribute).
More visualization actions can be performed through the event handlers provided.

Defined in lspushpage.js

Constructor Summary
ScrollTable (<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)
            Creates an object to be used to describe a data table whose values should be displayed and scrolled into existing HTML cells.
Method Summary
 void onChangingValues(<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 onRowUpdate(<Number> rowNumber, <RowInfo> rowInfo)
           Event handler that receives the notification that a row of the data table is being displayed on the corresponding cells.
 void setLastVisibleRow(<Number> rowNumber)
           Setter method that specifies the row number of the last row in the screen 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


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

Method Detail


void onChangingValues(<VisualUpdateInfo> updateInfo)


void onRowUpdate(<Number> rowNumber, <RowInfo> rowInfo)


void setLastVisibleRow(<Number> rowNumber)


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