Class RowInfo

Object
   |
   +--RowInfo

class RowInfo

Contains all the information related to a row pertaining to a ScrollTable or MetapushTable that is about to be displayed in a screen table. In these cases, the same data row can be displayed more than once on different cells, because of scrolling operations. Each time, a call to the "onRowUpdate" event handler is issued and a RowInfo instance is supplied. Specifically, for each row it supplies:

• The current values for the row fields
• The related formatted values to be shown in the cells

- ScrollTable.onRowUpdate()
- MetapushTable.onRowUpdate()

Constructor Detail

RowInfo

RowInfo()

Used by Lightstreamer to provide a value object to each call of the various onRowUpdate event handlers.

See:
- ScrollTable.onRowUpdate()
- MetapushTable.onRowUpdate()

getCellValue

String getCellValue(<FieldDescriptor> field)

Inquiry method that gets the formatted value for a specified field. The formatted value is the text that is actually written in the cell.
In case no formatted value has been supplied for the field yet, the cell will just display its initial value and this value is returned (note that, when a row is scrolled, the DOM cell associated to a specific field changes, hence the initial value may change as well).

Parameters:
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.

Returns:
A formatted text. Note that, in case the initial cell value is returned, it may be HTML code, despite the associated table does not allow push of HTML code.

getServerValue

String getServerValue(<FieldDescriptor> field)

Inquiry method that gets the value for a specified field. If the involved row came from a Server update, then it is the value as received from the Server in case of a subscribed field or set in Table.onItemUpdate() in case of an extra field. If the incoming row was supplied through a call to VisualTable.showValues(), then it is the value as supplied in that call.

Parameters:
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.

Returns:
A value. Null is an allowed value for a field, too; a null value is also returned for an extra field that was not assigned.