com.sap.ui.table.client
Class Table

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.table.client.Table

public class Table
extends com.sap.ui.core.client.Control

The class Table is the GWT wrapper for the Phoenix control: sap.ui.table.Table.

Provides a table with one or more columns. The table could have a scrollbar and the content inside the table is either editable or not.

• Properties
  • data : Object
    The data to be displayed in the table. For now this will only be nested objects.
  • treeInformation : Object
    The tree specific information. It provides information like what node is expanded/collapsed by default
  • selectionMode : com.sap.ui.table.client.SelectionMode
    Selection mode of the table The following selection mode can be chosen: sap.ui.table.SelectionMode.All, sap.ui.table.SelectionMode.Single, sap.ui.table.SelectionMode.None.
  • editable : boolean
    Switches edit state of the control. Read-only fields have different colors, depending on customer setting.
  • title : String
    Title to be displayed on the top of the table
  • visibleRowCount : int
    The number of rows visible before scrolling. Max 50.
  • visibleFirstRow : int
    First visible row of the table. The table will scroll to that row.
  • expandedVisibleRowCount : int
    Number of rows to be displayed when the table is expanded.
  • customRowHeight : int
    Sets the height of every row in "px" to the given value. (customRowHeight < 25 is ignored)
  • width : String
    Width of the table
  • design : com.sap.ui.table.client.TableVisualDesign
    Design that influences the look-and-feel of the table.
• Aggregations
  • columnHeaders : com.sap.ui.table.client.ColumnHeader
    Getter for aggregation column headers. Allows setting column headers (see sap.ui.table.ColumnHeader) that shall be displayed in the table.
  • actionToolbar : com.sap.ui.commons.client.Toolbar
    Getter for aggregation left toolbar. Allows setting toolbar (see sap.ui.commons.toolbar) that shall be displayed in the table.
  • rightToolbarButtons : com.sap.ui.commons.client.Button
    Getter for aggregation right toolbar buttons. Allow setting buttons (see sap.ui.commons.button) that shall be displayed in the table.
• Associations
• Events
  • rowSelect Event is fired when the user selects a row.
  • rowDeselect Event is fired when the user deselects a row.
  • toggleOpenState Event is fired when the user toggles a tree node such that its expand or collapsed.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.table.Table)

Constructor Summary

protected

Table() constructs the class Table hidden due to JavaScriptObject restriction

Method Summary

Table	addColumnHeader(ColumnHeader columnHeader) Appends a columnHeader to the aggregation columnHeaders.
Table	addRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton) Appends a rightToolbarButton to the aggregation rightToolbarButtons.
Table	attachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user deselects a row.
Table	attachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user selects a row.
Table	attachToggleOpenStateEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user toggles a tree node such that its expand or collapsed.
static Table	create() Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.
static Table	create(String idOrConfig) Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.
static Table	create(String id, String config) Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.
Table	destroyActionToolbar() Destroys the actionToolbar in the ActionToolbar-aggregation.
Table	destroyColumnHeaders() Destroys all the columnHeaders in the ColumnHeaders-aggregation.
Table	destroyRightToolbarButtons() Destroys all the rightToolbarButtons in the RightToolbarButtons-aggregation.
Table	detachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user deselects a row.
Table	detachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user selects a row.
Table	detachToggleOpenStateEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user toggles a tree node such that its expand or collapsed.
com.sap.ui.commons.client.Toolbar	getActionToolbar() Getter for aggregation actionToolbar Getter for aggregation left toolbar.
com.sap.ui.core.client.js.JsArray<ColumnHeader>	getColumnHeaders() Getter for aggregation columnHeaders Getter for aggregation column headers.
int	getCustomRowHeight() Getter for property customRowHeight Sets the height of every row in "px" to the given value.
Object	getData() Getter for property data The data to be displayed in the table.
TableVisualDesign	getDesign() Getter for property design Design that influences the look-and-feel of the table.
int	getExpandedVisibleRowCount() Getter for property expandedVisibleRowCount Number of rows to be displayed when the table is expanded.
com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button>	getRightToolbarButtons() Getter for aggregation rightToolbarButtons Getter for aggregation right toolbar buttons.
SelectionMode	getSelectionMode() Getter for property selectionMode Selection mode of the table The following selection mode can be chosen: sap.ui.table.SelectionMode.All, sap.ui.table.SelectionMode.Single, sap.ui.table.SelectionMode.None.
String	getTitle() Getter for property title Title to be displayed on the top of the table
Object	getTreeInformation() Getter for property treeInformation The tree specific information.
int	getVisibleFirstRow() Getter for property visibleFirstRow First visible row of the table.
int	getVisibleRowCount() Getter for property visibleRowCount The number of rows visible before scrolling.
String	getWidth() Getter for property width Width of the table
int	indexOfColumnHeader(ColumnHeader columnHeader) Checks for the provided com.sap.ui.table.client.ColumnHeader in the columnHeaders-aggregation and returns its index if found or -1 otherwise.
int	indexOfRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton) Checks for the provided com.sap.ui.commons.client.Button in the rightToolbarButtons-aggregation and returns its index if found or -1 otherwise.
Table	insertColumnHeader(ColumnHeader columnHeader, int index) Inserts some columnHeader into the aggregation named columnHeaders.
Table	insertRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton, int index) Inserts some rightToolbarButton into the aggregation named rightToolbarButtons.
boolean	isEditable() Getter for property editable Switches edit state of the control.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<ColumnHeader>>	removeAllColumnHeaders() Removes all the items in the columnHeaders-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button>>	removeAllRightToolbarButtons() Removes all the items in the rightToolbarButtons-aggregation.
com.sap.ui.core.client.js.JsArray<ColumnHeader>	removeColumnHeader(int index) Removes a columnHeader from the aggregation named columnHeaders.
com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button>	removeRightToolbarButton(int index) Removes a rightToolbarButton from the aggregation named rightToolbarButtons.
Table	setActionToolbar(com.sap.ui.commons.client.Toolbar actionToolbar) Setter for the aggregated actionToolbar.
Table	setCustomRowHeight(int value) Setter for property customRowHeight
Table	setData(Object value) Setter for property data
Table	setDesign(TableVisualDesign value) Setter for property design Default value is: sap.ui.table.TableVisualDesign.Standard
Table	setEditable(boolean value) Setter for property editable Default value is: false
Table	setExpandedVisibleRowCount(int value) Setter for property expandedVisibleRowCount Default value is: -1
Table	setSelectionMode(SelectionMode value) Setter for property selectionMode Default value is: sap.ui.table.SelectionMode.All
Table	setTitle(String value) Setter for property title
Table	setTreeInformation(Object value) Setter for property treeInformation
Table	setVisibleFirstRow(int value) Setter for property visibleFirstRow Default value is: 0
Table	setVisibleRowCount(int value) Setter for property visibleRowCount Default value is: 10
Table	setWidth(String value) Setter for property width Default value is: auto

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Table

protected Table()

constructs the class Table
hidden due to JavaScriptObject restriction

Method Detail

create

public static Table create()

Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.

creates a new instance of the class Table

create

public static Table create(String idOrConfig)

Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.

creates a new instance of the class Table

Parameters:

id - id of the Table or configuration JSON string

create

public static Table create(String id,
                           String config)

Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.

creates a new instance of the class Table

Parameters:

id - id of the Table

config - configuration JSON string

getData

public final Object getData()

Getter for property data The data to be displayed in the table. For now this will only be nested objects.

Returns:

the value of property data

setData

public final Table setData(Object value)

Setter for property data

Parameters:

value - Object

Returns:

this to allow method chaining

getTreeInformation

public final Object getTreeInformation()

Getter for property treeInformation The tree specific information. It provides information like what node is expanded/collapsed by default

Returns:

the value of property treeInformation

setTreeInformation

public final Table setTreeInformation(Object value)

Setter for property treeInformation

Parameters:

value - Object

Returns:

this to allow method chaining

getSelectionMode

public final SelectionMode getSelectionMode()

Getter for property selectionMode Selection mode of the table The following selection mode can be chosen: sap.ui.table.SelectionMode.All, sap.ui.table.SelectionMode.Single, sap.ui.table.SelectionMode.None.

Returns:

the value of property selectionMode

setSelectionMode

public final Table setSelectionMode(SelectionMode value)

Setter for property selectionMode
Default value is: sap.ui.table.SelectionMode.All

Parameters:

value - com.sap.ui.table.client.SelectionMode

Returns:

this to allow method chaining

isEditable

public final boolean isEditable()

Getter for property editable Switches edit state of the control. Read-only fields have different colors, depending on customer setting.

Returns:

the value of property editable

setEditable

public final Table setEditable(boolean value)

Setter for property editable
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getTitle

public final String getTitle()

Getter for property title Title to be displayed on the top of the table

Returns:

the value of property title

setTitle

public final Table setTitle(String value)

Setter for property title

Parameters:

value - String

Returns:

this to allow method chaining

getVisibleRowCount

public final int getVisibleRowCount()

Getter for property visibleRowCount The number of rows visible before scrolling. Max 50.

Returns:

the value of property visibleRowCount

setVisibleRowCount

public final Table setVisibleRowCount(int value)

Setter for property visibleRowCount
Default value is: 10

Parameters:

value - int

Returns:

this to allow method chaining

getVisibleFirstRow

public final int getVisibleFirstRow()

Getter for property visibleFirstRow First visible row of the table. The table will scroll to that row.

Returns:

the value of property visibleFirstRow

setVisibleFirstRow

public final Table setVisibleFirstRow(int value)

Setter for property visibleFirstRow
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

getExpandedVisibleRowCount

public final int getExpandedVisibleRowCount()

Getter for property expandedVisibleRowCount Number of rows to be displayed when the table is expanded.

Returns:

the value of property expandedVisibleRowCount

setExpandedVisibleRowCount

public final Table setExpandedVisibleRowCount(int value)

Setter for property expandedVisibleRowCount
Default value is: -1

Parameters:

value - int

Returns:

this to allow method chaining

getCustomRowHeight

public final int getCustomRowHeight()

Getter for property customRowHeight Sets the height of every row in "px" to the given value. (customRowHeight < 25 is ignored)

Returns:

the value of property customRowHeight

setCustomRowHeight

public final Table setCustomRowHeight(int value)

Setter for property customRowHeight

Parameters:

value - int

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width Width of the table

Returns:

the value of property width

setWidth

public final Table setWidth(String value)

Setter for property width
Default value is: auto

Parameters:

value - String

Returns:

this to allow method chaining

getDesign

public final TableVisualDesign getDesign()

Getter for property design Design that influences the look-and-feel of the table.

Returns:

the value of property design

setDesign

public final Table setDesign(TableVisualDesign value)

Setter for property design
Default value is: sap.ui.table.TableVisualDesign.Standard

Parameters:

value - com.sap.ui.table.client.TableVisualDesign

Returns:

this to allow method chaining

getColumnHeaders

public final com.sap.ui.core.client.js.JsArray<ColumnHeader> getColumnHeaders()

Getter for aggregation columnHeaders Getter for aggregation column headers. Allows setting column headers (see sap.ui.table.ColumnHeader) that shall be displayed in the table.

Returns:

com.sap.ui.table.client.ColumnHeader[]

insertColumnHeader

public final Table insertColumnHeader(ColumnHeader columnHeader,
                                      int index)

Inserts some columnHeader into the aggregation named columnHeaders.

Parameters:

columnHeader - the columnHeader to insert

index - int the 0-based index the columnHeader should be inserted at.

Returns:

this to allow method chaining

addColumnHeader

public final Table addColumnHeader(ColumnHeader columnHeader)

Appends a columnHeader to the aggregation columnHeaders.

Parameters:

columnHeader - com.sap.ui.table.client.ColumnHeader the columnHeader to add

Returns:

this to allow method chaining

removeColumnHeader

public final com.sap.ui.core.client.js.JsArray<ColumnHeader> removeColumnHeader(int index)

Removes a columnHeader from the aggregation named columnHeaders.

Parameters:

index - int the position of the columnHeader to remove.

Returns:

reference to this instance

removeAllColumnHeaders

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<ColumnHeader>> removeAllColumnHeaders()

Removes all the items in the columnHeaders-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfColumnHeader

public final int indexOfColumnHeader(ColumnHeader columnHeader)

Checks for the provided com.sap.ui.table.client.ColumnHeader in the columnHeaders-aggregation and returns its index if found or -1 otherwise.

Parameters:

columnHeader - the columnHeader whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyColumnHeaders

public final Table destroyColumnHeaders()

Destroys all the columnHeaders in the ColumnHeaders-aggregation.

Returns:

this to allow method chaining

getActionToolbar

public final com.sap.ui.commons.client.Toolbar getActionToolbar()

Getter for aggregation actionToolbar Getter for aggregation left toolbar. Allows setting toolbar (see sap.ui.commons.toolbar) that shall be displayed in the table.

Returns:

com.sap.ui.commons.client.Toolbar

setActionToolbar

public final Table setActionToolbar(com.sap.ui.commons.client.Toolbar actionToolbar)

Setter for the aggregated actionToolbar.

Parameters:

oactionToolbar - {com.sap.ui.commons.client.Toolbar}

Returns:

this to allow method chaining

destroyActionToolbar

public final Table destroyActionToolbar()

Destroys the actionToolbar in the ActionToolbar-aggregation.

Returns:

this to allow method chaining

getRightToolbarButtons

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button> getRightToolbarButtons()

Getter for aggregation rightToolbarButtons Getter for aggregation right toolbar buttons. Allow setting buttons (see sap.ui.commons.button) that shall be displayed in the table.

Returns:

com.sap.ui.commons.client.Button[]

insertRightToolbarButton

public final Table insertRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton,
                                            int index)

Inserts some rightToolbarButton into the aggregation named rightToolbarButtons.

Parameters:

rightToolbarButton - the rightToolbarButton to insert

index - int the 0-based index the rightToolbarButton should be inserted at.

Returns:

this to allow method chaining

addRightToolbarButton

public final Table addRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton)

Appends a rightToolbarButton to the aggregation rightToolbarButtons.

Parameters:

rightToolbarButton - com.sap.ui.commons.client.Button the rightToolbarButton to add

Returns:

this to allow method chaining

removeRightToolbarButton

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button> removeRightToolbarButton(int index)

Removes a rightToolbarButton from the aggregation named rightToolbarButtons.

Parameters:

index - int the position of the rightToolbarButton to remove.

Returns:

reference to this instance

removeAllRightToolbarButtons

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.commons.client.Button>> removeAllRightToolbarButtons()

Removes all the items in the rightToolbarButtons-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfRightToolbarButton

public final int indexOfRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton)

Checks for the provided com.sap.ui.commons.client.Button in the rightToolbarButtons-aggregation and returns its index if found or -1 otherwise.

Parameters:

rightToolbarButton - the rightToolbarButton whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyRightToolbarButtons

public final Table destroyRightToolbarButtons()

Destroys all the rightToolbarButtons in the RightToolbarButtons-aggregation.

Returns:

this to allow method chaining

attachRowSelectEvent

public final Table attachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when the user selects a row.

Event Parameters:

{sap.ui.core/object} selectedRows An array of strings containing the currenctly selected row id's.

{sap.ui.core/object} previouslySelectedRows An array of strings containing previously selected row id's.

{sap.ui.core/object} selectedBindingObjects An array of binding objects for the selected row id's.

{sap.ui.core/object} previouslySelectedBindingObjects An array of binding objects for the previously selected row id's.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachRowSelectEvent

public final Table detachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when the user selects a row.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachRowDeselectEvent

public final Table attachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when the user deselects a row.

Event Parameters:

{sap.ui.core/object} deselectedRows An array of strings containing the currenctly deselected row id's.

{sap.ui.core/object} previouslySelectedRows An array of strings containing previously selected row id's.

{sap.ui.core/object} deselectedBindingObjects An array of binding objects for the deselected row id's.

{sap.ui.core/object} previouslySelectedBindingObjects An array of binding objects for the previously selected row id's.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachRowDeselectEvent

public final Table detachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when the user deselects a row.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

attachToggleOpenStateEvent

public final Table attachToggleOpenStateEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when the user toggles a tree node such that its expand or collapsed.

Event Parameters:

{sap.ui.core/string} rowPath Path of the row that has been toggled.

{sap.ui.core/boolean} opened Returns true/false depending if the tree node is open.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachToggleOpenStateEvent

public final Table detachToggleOpenStateEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when the user toggles a tree node such that its expand or collapsed.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining