|
HTML Client 5.0.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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:
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()
Method Detail |
void forEachChangedField(<Function> iterator)
iterator
- Function instance that will be called once per each field changed on the last update received from the server. <Number> fieldPos
1-based index of the field within the schema. In case of an extra field added with a name identifier such identifier is passed. <String> fieldName
name of the involved changed field. If a schema identifier has been used as schema descriptor for the data table, then a null value is supplied unless this is an extra field in which case the identifier used to add the field is passed. <String> serverValue
server value for the field. See getServerValue() for details. <String> formattedValue
formatted value for the field. See getFormattedValue() for details. <VisualUpdateInfo> updateInfo
original VisualUpdateInfo instance upon the forEachChangedField method has been called. String getFormattedValue(<FieldDescriptor> field)
field
- a field descriptor object for the requested field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
String getServerValue(<FieldDescriptor> field)
field
- a field descriptor object for the requested field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
void setAttribute(<FieldDescriptor> field, <String> hotValue, <String> coldValue, <String> attrName)
field
- a field descriptor object for the involved field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
hotValue
- the temporary "hot" value for the involved attribute, or null if the attribute should not change while entering "hot" phase; an empty string causes the current attribute value to be cleared.
coldValue
- the final "cold" value for the involved attribute, or null if the attribute should not change while exiting "hot" phase; an empty string causes the "hot" phase attribute value to be cleared.
attrName
- the name of an HTML stylesheet attribute. The DOM attribute name should be used, not the CSS name (e.g. "backgroundColor" is accepted, while "background-color" is not).
void setColdToHotTime(<Number> val)
val
- Duration in milliseconds of the fading phase before the "hot" phase.
void setFormattedValue(<FieldDescriptor> field, <String> value)
field
- a field descriptor object for the involved field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
value
- the formatted value for the field, or null.
void setHotTime(<Number> val)
val
- Duration in milliseconds of the "hot" phase.
void setHotToColdTime(<Number> val)
val
- Duration in milliseconds of the fading phase after the "hot" phase.
void setRowAttribute(<String> hotValue, <String> coldValue, <String> attrName)
hotValue
- the temporary "hot" value for the involved attribute, or null if the attribute should not change while entering "hot" phase; an empty string causes the current attribute value to be cleared.
coldValue
- the final "cold" value for the involved attribute, or null if the attribute should not change while exiting "hot" phase; an empty string causes the "hot" phase attribute value to be cleared.
attrName
- the name of an HTML stylesheet attribute. The DOM attribute name should be used, not the CSS name (e.g. "backgroundColor" is accepted, while "background-color" is not). Note that if the "color" or "backgroundColor" attribute is being set, then several color name conventions are supported by the underlying DOM manipulation functions; however, in order to take advantage of the color fading support, only the "#RRGGBB" syntax is fully supported.
void setRowStyle(<String> hotStyle, <String> coldStyle)
hotStyle
- the name of the temporary "hot" stylesheet, or null if the cells style should not change while entering "hot" phase.
coldStyle
- the name of the final "cold" stylesheet, or null if the cells style should not change while exiting "hot" phase.
void setStyle(<FieldDescriptor> field, <String> hotStyle, <String> coldStyle)
field
- a field descriptor object for the involved field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
hotStyle
- the name of the temporary "hot" stylesheet, or null if the cell style should not change while entering "hot" phase (regardless of the settings made through setRowStyle() and setRowAttribute()).
coldStyle
- the name of the final "cold" stylesheet, or null if the cell style should not change while exiting "hot" phase (regardless of the settings made through setRowStyle() and setRowAttribute()).
|
HTML Client 5.0.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |