com.sap.ui.table.client
Class TableWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.table.client.TableWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class TableWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	TableWidget() Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.
	TableWidget(String id) Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.
protected	TableWidget(Table control) Deprecated. Since version 0.16.0. The sap.ui.table.Table control is replaced by the sap.ui.table.DataTable.

Method Summary

void	addColumnHeader(ColumnHeader columnHeader) Appends some columnHeader to the columnHeaders-aggregation.
void	addRightToolbarButton(com.sap.ui.commons.client.Button rightToolbarButton) Appends some rightToolbarButton to the rightToolbarButtons-aggregation.
void	attachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user deselects a row.
void	attachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user selects a row.
void	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.
void	destroyActionToolbar() Destroys the actionToolbar in the ActionToolbar-aggregation.
void	destroyColumnHeaders() Destroys all the columnHeaders in the ColumnHeaders-aggregation.
void	destroyRightToolbarButtons() Destroys all the rightToolbarButtons in the RightToolbarButtons-aggregation.
void	detachRowDeselectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user deselects a row.
void	detachRowSelectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user selects a row.
void	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.
Table	getControl() returns the reference to the Phoenix Control
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.
void	insertColumnHeader(ColumnHeader columnHeader, int index) Inserts some columnHeader into the aggregation named columnHeaders.
void	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.
void	removeAllColumnHeaders() Removes all the items in the columnHeaders-aggregation.
void	removeAllRightToolbarButtons() Removes all the items in the rightToolbarButtons-aggregation.
void	removeColumnHeader(int index) Removes the columnHeader at position index in the columnHeaders-aggregation named.
void	removeRightToolbarButton(int index) Removes the rightToolbarButton at position index in the rightToolbarButtons-aggregation named.
void	setActionToolbar(com.sap.ui.commons.client.Toolbar actionToolbar) Setter for the aggregated actionToolbar.
void	setCustomRowHeight(int value) Setter for property customRowHeight
void	setData(Object value) Setter for property data
void	setDesign(TableVisualDesign value) Setter for property design Default value is: sap.ui.table.TableVisualDesign.Standard
void	setEditable(boolean value) Setter for property editable Default value is: false
void	setExpandedVisibleRowCount(int value) Setter for property expandedVisibleRowCount Default value is: -1
void	setSelectionMode(SelectionMode value) Setter for property selectionMode Default value is: sap.ui.table.SelectionMode.All
void	setTitle(String value) Setter for property title
void	setTreeInformation(Object value) Setter for property treeInformation
void	setVisibleFirstRow(int value) Setter for property visibleFirstRow Default value is: 0
void	setVisibleRowCount(int value) Setter for property visibleRowCount Default value is: 10
void	setWidth(String value) Setter for property width Default value is: auto

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TableWidget

public TableWidget()

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

constructs the class TableWidget

TableWidget

public TableWidget(String id)

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

constructs the class TableWidget

Parameters:

id - id of the TableWidget

TableWidget

protected TableWidget(Table control)

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

constructs the class TableWidget

Parameters:

control - reference to an existing Table

Method Detail

getControl

public Table getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getData

public 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 void setData(Object value)

Setter for property data

Parameters:

value - Object

getTreeInformation

public 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 void setTreeInformation(Object value)

Setter for property treeInformation

Parameters:

value - Object

getSelectionMode

public 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 void setSelectionMode(SelectionMode value)

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

Parameters:

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

isEditable

public 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 void setEditable(boolean value)

Setter for property editable
Default value is: false

Parameters:

value - boolean

getTitle

public String getTitle()

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

Overrides:

getTitle in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property title

setTitle

public void setTitle(String value)

Setter for property title

Overrides:

setTitle in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getVisibleRowCount

public int getVisibleRowCount()

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

Returns:

the value of property visibleRowCount

setVisibleRowCount

public void setVisibleRowCount(int value)

Setter for property visibleRowCount
Default value is: 10

Parameters:

value - int

getVisibleFirstRow

public 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 void setVisibleFirstRow(int value)

Setter for property visibleFirstRow
Default value is: 0

Parameters:

value - int

getExpandedVisibleRowCount

public 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 void setExpandedVisibleRowCount(int value)

Setter for property expandedVisibleRowCount
Default value is: -1

Parameters:

value - int

getCustomRowHeight

public 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 void setCustomRowHeight(int value)

Setter for property customRowHeight

Parameters:

value - int

getWidth

public String getWidth()

Getter for property width Width of the table

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: auto

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getDesign

public TableVisualDesign getDesign()

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

Returns:

the value of property design

setDesign

public void setDesign(TableVisualDesign value)

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

Parameters:

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

getColumnHeaders

public 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 void 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.

addColumnHeader

public void addColumnHeader(ColumnHeader columnHeader)

Appends some columnHeader to the columnHeaders-aggregation.

Parameters:

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

removeColumnHeader

public void removeColumnHeader(int index)

Removes the columnHeader at position index in the columnHeaders-aggregation named.

Parameters:

index - int the position of the columnHeader to remove.

removeAllColumnHeaders

public void removeAllColumnHeaders()

Removes all the items in the columnHeaders-aggregation.

indexOfColumnHeader

public 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 void destroyColumnHeaders()

Destroys all the columnHeaders in the ColumnHeaders-aggregation.

getActionToolbar

public 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 void setActionToolbar(com.sap.ui.commons.client.Toolbar actionToolbar)

Setter for the aggregated actionToolbar.

Parameters:

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

destroyActionToolbar

public void destroyActionToolbar()

Destroys the actionToolbar in the ActionToolbar-aggregation.

getRightToolbarButtons

public 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 void 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.

addRightToolbarButton

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

Appends some rightToolbarButton to the rightToolbarButtons-aggregation.

Parameters:

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

removeRightToolbarButton

public void removeRightToolbarButton(int index)

Removes the rightToolbarButton at position index in the rightToolbarButtons-aggregation named.

Parameters:

index - int the position of the rightToolbarButton to remove.

removeAllRightToolbarButtons

public void removeAllRightToolbarButtons()

Removes all the items in the rightToolbarButtons-aggregation.

indexOfRightToolbarButton

public 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 void destroyRightToolbarButtons()

Destroys all the rightToolbarButtons in the RightToolbarButtons-aggregation.

attachRowSelectEvent

public void 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

detachRowSelectEvent

public void 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

attachRowDeselectEvent

public void 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

detachRowDeselectEvent

public void 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

attachToggleOpenStateEvent

public void 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

detachToggleOpenStateEvent

public void 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