HTML Client 5.0.1

Class VisualUpdateInfo

Object
   |
   +--VisualUpdateInfo

class VisualUpdateInfo


Contains all the information related to a data row that is about to be displayed in a screen table. This may happen because of a new update received or a call to VisualTable.showValues(). In these cases, a call to one of the various "onChangingValues" event handler is issued and a VisualUpdateInfo instance is supplied. Specifically, for each row it supplies:

The provided visual effect consists of the following sequence: If the involved data table behaves with a "MultiMetapush logic", hence the fields (other than extra fields) may belong to either a first-level or a second-level schema, then in all methods where a field descriptor has to be supplied, a specific naming convention should be followed. See UpdateItemInfo for details.
The class constructor, its prototype and any other properties should never be used directly; actually, VisualUpdateInfo is not even defined as a global name.
Defined in lspushpage.js

See:


Constructor Summary
VisualUpdateInfo ()
            Used by Lightstreamer to provide a value object to each call of the various "onChangingValues" event handlers.
 
Method Summary
 void forEachChangedField(<Function> iterator)
           Registers an iterator function that will be called once per each field changed with the last visual update.
 String getFormattedValue(<FieldDescriptor> field)
           Inquiry method that gets the formatted value for a specified field.
 String getServerValue(<FieldDescriptor> field)
           Inquiry method that gets the value for a specified field.
 void setAttribute(<FieldDescriptor> field, <String> hotValue, <String> coldValue, <String> attrName)
           Setter method that configures the stylesheet changes to be applied to the HTML cell related with a specified field, while changing its value.
 void setColdToHotTime(<Number> val)
           Setter method that configures the length of the color fading phase before the "hot" phase.
 void setFormattedValue(<FieldDescriptor> field, <String> value)
           Setter method that assigns the formatted value for a specified field.
 void setHotTime(<Number> val)
           Setter method that configures the length of the "hot" phase for the current row.
 void setHotToColdTime(<Number> val)
           Setter method that configures the length of the color fading phase after the "hot" phase.
 void setRowAttribute(<String> hotValue, <String> coldValue, <String> attrName)
           Setter method that configures the stylesheet changes to be applied to the HTML cells of the involved row, while changing the field values.
 void setRowStyle(<String> hotStyle, <String> coldStyle)
           Setter method that configures the stylesheets to be applied to the HTML cells of the involved row, while changing the field values.
 void setStyle(<FieldDescriptor> field, <String> hotStyle, <String> coldStyle)
           Setter method that configures the stylesheets to be applied to the HTML cell related with a specified field, while changing its value.

Constructor Detail

VisualUpdateInfo

VisualUpdateInfo()

Method Detail

forEachChangedField

void forEachChangedField(<Function> iterator)

getFormattedValue

String getFormattedValue(<FieldDescriptor> field)

getServerValue

String getServerValue(<FieldDescriptor> field)

setAttribute

void setAttribute(<FieldDescriptor> field, <String> hotValue, <String> coldValue, <String> attrName)

setColdToHotTime

void setColdToHotTime(<Number> val)

setFormattedValue

void setFormattedValue(<FieldDescriptor> field, <String> value)

setHotTime

void setHotTime(<Number> val)

setHotToColdTime

void setHotToColdTime(<Number> val)

setRowAttribute

void setRowAttribute(<String> hotValue, <String> coldValue, <String> attrName)

setRowStyle

void setRowStyle(<String> hotStyle, <String> coldStyle)

setStyle

void setStyle(<FieldDescriptor> field, <String> hotStyle, <String> coldStyle)

HTML Client 5.0.1

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