Package com.ebasetech.xi.api

Interface WebFormTable

All Superinterfaces:

Element, java.io.Serializable, Table

public interface WebFormTable
extends Table

The WebFormTable represents a table in an interactive web form.

Individual tables can be accessed via the Tables interface.

Since:

V4.4

Field Summary

Fields inherited from interface com.ebasetech.xi.api.Table

SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING

Method Summary

Modifier and Type	Method	Description
WebFormTableColumn	getColumn(java.lang.String columnName)	Returns the specified table column or null if the column does not exist.
WebFormTableColumn[]	getColumns()	Returns an array of all table columns in the table.
Control	getControl()	Returns the first Table Control or Repeater Control on the current page that displays this table.
Control	getControl(Page page)	Returns the first Table Control or Repeater Control on the specified page that displays this table.

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.Table

copyTable, deleteRow, deleteRow, fetchTable, fetchTable, findRow, findRows, getColumnValueOnRow, getCurrentRow, getRowCount, getRows, getSortColumns, getSortDirections, insertRow, isRowDeletedByUser, isRowDeletedByUser, isRowEmpty, isRowEmpty, isRowInserted, isRowInserted, isRowModified, isRowModified, isRowSelected, isRowSelected, loadFromJSON, replaceTable, resetTable, setColumnValueOnRow, setCurrentRow, setRowDeletedByUser, setRowDeletedByUser, setRowEmpty, setRowEmpty, setRowSelected, setRowSelected, sort, sort, sort, sort, toJSON, toJSON, updateTable

Method Details

getControl

Control getControl()

Returns the first Table Control or Repeater Control on the current page that displays this table.

Returns:

control

See Also:

getControl(Page)

getControl

Control getControl(Page page)

Returns the first Table Control or Repeater Control on the specified page that displays this table.

Returns:

control

See Also:

getControl()

getColumn

WebFormTableColumn getColumn(java.lang.String columnName)

Returns the specified table column or null if the column does not exist. When columnName is a valid Java name, the column can more easily be accessed as tableName.columnName e.g. T1.COL1, however use of this method is the only way to access column names that are not valid Java names.

Javascript example:

 var col = tables.ORDERS.getColumn("2XX");
 

Specified by:

getColumn in interface Table

Returns:

a table column, or null if the column does not exist

Since:

V4.4

getColumns

WebFormTableColumn[] getColumns()

Returns an array of all table columns in the table.

Javascript example:

 var cols = tables.ORDERS.getColumns();
 for each (var col in cols)
 {
   log(col.elementName + ": " + col.value);
 }
 

Specified by:

getColumns in interface Table

Returns:

an array of all columns in the table

Since:

V4.4