com.sap.ui.table.client.web
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.web.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.web.Table.

Can dispay complex data in "semantic rows".

• Properties
  • width : String
    Control width as common CSS-size (px or % as unit, for example).
  • alternate : boolean
    Alternating semantic row colors.
  • minHeight : int
    Minimum height of the semantic rows which is defined in pixel value.
  • visible : boolean
    Defines whether control is visible.
• Aggregations
  • header : com.sap.ui.table.client.web.Toolbar
    Allows setting the sap.ui.table.web.Toolbar that should be displayed in the top of this instance of the sap.ui.table.web.Table.
  • footer : com.sap.ui.table.client.web.Toolbar
    Allows setting the sap.ui.table.web.Toolbar that should be displayed at the bottom of this instance of the sap.ui.table.web.Table.
  • recordTemplate : com.sap.ui.table.client.web.Record
    Allows setting an instance of sap.ui.table.web.Record that should used as template for the rows to be displayed in this instance of the sap.ui.table.web.Table.
• Associations
• Events
  • itemSelected Event is fired when an item is clicked.

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

Table	attachItemSelectedEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when an item is clicked.
void	clear() Delete all records.
static Table	create() creates a new instance of the class Table
static Table	create(String idOrConfig) creates a new instance of the class Table
static Table	create(String id, String config) creates a new instance of the class Table
void	createRecord(com.sap.ui.core.client.Control data, String id) Create one table record.
void	createRecords(com.sap.ui.core.client.Control data) Create multiple table records.
void	deleteRecord(String id) Delete one table record.
void	deleteRecords(String id) Delete multiple records
Table	destroyFooter() Destroys the footer in the Footer-aggregation.
Table	destroyHeader() Destroys the header in the Header-aggregation.
Table	destroyRecordTemplate() Destroys the recordTemplate in the RecordTemplate-aggregation.
Table	detachItemSelectedEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when an item is clicked.
Toolbar	getFooter() Getter for aggregation footer Allows setting the sap.ui.table.web.Toolbar that should be displayed at the bottom of this instance of the sap.ui.table.web.Table.
Toolbar	getHeader() Getter for aggregation header Allows setting the sap.ui.table.web.Toolbar that should be displayed in the top of this instance of the sap.ui.table.web.Table.
int	getMinHeight() Getter for property minHeight Minimum height of the semantic rows which is defined in pixel value.
Record	getRecordTemplate() Getter for aggregation recordTemplate Allows setting an instance of sap.ui.table.web.Record that should used as template for the rows to be displayed in this instance of the sap.ui.table.web.Table.
String	getWidth() Getter for property width Control width as common CSS-size (px or % as unit, for example).
boolean	isAlternate() Getter for property alternate Alternating semantic row colors.
boolean	isVisible() Getter for property visible Defines whether control is visible.
Table	setAlternate(boolean value) Setter for property alternate Default value is: false
Table	setFooter(Toolbar footer) Setter for the aggregated footer.
Table	setHeader(Toolbar header) Setter for the aggregated header.
Table	setMinHeight(int value) Setter for property minHeight
Table	setRecordTemplate(Record recordTemplate) Setter for the aggregated recordTemplate.
Table	setVisible(boolean value) Setter for property visible Default value is: true
Table	setWidth(String value) Setter for property width

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

creates a new instance of the class Table

create

public static Table create(String idOrConfig)

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)

creates a new instance of the class Table

Parameters:

id - id of the Table

config - configuration JSON string

getWidth

public final String getWidth()

Getter for property width Control width as common CSS-size (px or % as unit, for example).

Returns:

the value of property width

setWidth

public final Table setWidth(String value)

Setter for property width

Parameters:

value - String

Returns:

this to allow method chaining

isAlternate

public final boolean isAlternate()

Getter for property alternate Alternating semantic row colors.

Returns:

the value of property alternate

setAlternate

public final Table setAlternate(boolean value)

Setter for property alternate
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getMinHeight

public final int getMinHeight()

Getter for property minHeight Minimum height of the semantic rows which is defined in pixel value.

Returns:

the value of property minHeight

setMinHeight

public final Table setMinHeight(int value)

Setter for property minHeight

Parameters:

value - int

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Defines whether control is visible.

Returns:

the value of property visible

setVisible

public final Table setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getHeader

public final Toolbar getHeader()

Getter for aggregation header Allows setting the sap.ui.table.web.Toolbar that should be displayed in the top of this instance of the sap.ui.table.web.Table.

Returns:

com.sap.ui.table.client.web.Toolbar

setHeader

public final Table setHeader(Toolbar header)

Setter for the aggregated header.

Parameters:

oheader - {com.sap.ui.table.client.web.Toolbar}

Returns:

this to allow method chaining

destroyHeader

public final Table destroyHeader()

Destroys the header in the Header-aggregation.

Returns:

this to allow method chaining

getFooter

public final Toolbar getFooter()

Getter for aggregation footer Allows setting the sap.ui.table.web.Toolbar that should be displayed at the bottom of this instance of the sap.ui.table.web.Table.

Returns:

com.sap.ui.table.client.web.Toolbar

setFooter

public final Table setFooter(Toolbar footer)

Setter for the aggregated footer.

Parameters:

ofooter - {com.sap.ui.table.client.web.Toolbar}

Returns:

this to allow method chaining

destroyFooter

public final Table destroyFooter()

Destroys the footer in the Footer-aggregation.

Returns:

this to allow method chaining

getRecordTemplate

public final Record getRecordTemplate()

Getter for aggregation recordTemplate Allows setting an instance of sap.ui.table.web.Record that should used as template for the rows to be displayed in this instance of the sap.ui.table.web.Table.

Returns:

com.sap.ui.table.client.web.Record

setRecordTemplate

public final Table setRecordTemplate(Record recordTemplate)

Setter for the aggregated recordTemplate.

Parameters:

orecordTemplate - {com.sap.ui.table.client.web.Record}

Returns:

this to allow method chaining

destroyRecordTemplate

public final Table destroyRecordTemplate()

Destroys the recordTemplate in the RecordTemplate-aggregation.

Returns:

this to allow method chaining

attachItemSelectedEvent

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

attach an EventListener Event is fired when an item is clicked.

Event Parameters:

{sap.ui.core/string} key Gives the 'key'-property of the item that has been selected.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachItemSelectedEvent

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

detach an EventListener Event is fired when an item is clicked.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

createRecord

public final void createRecord(com.sap.ui.core.client.Control data,
                               String id)

Create one table record.

Parameters:

data - Object which holds controls for the table cells.

id - Record identifier.

deleteRecord

public final void deleteRecord(String id)

Delete one table record.

Parameters:

id - Record identifier

createRecords

public final void createRecords(com.sap.ui.core.client.Control data)

Create multiple table records. The record IDs are stored in the data object.

Parameters:

data - An object which holds controls for the table cells.

deleteRecords

public final void deleteRecords(String id)

Delete multiple records

Parameters:

id - Array with multiple IDs.

clear

public final void clear()

Delete all records.