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

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() constructs the class TableWidget
	TableWidget(String id) constructs the class TableWidget
protected	TableWidget(Table control) constructs the class TableWidget

Method Summary

void	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.
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
void	destroyFooter() Destroys the footer in the Footer-aggregation.
void	destroyHeader() Destroys the header in the Header-aggregation.
void	destroyRecordTemplate() Destroys the recordTemplate in the RecordTemplate-aggregation.
void	detachItemSelectedEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when an item is clicked.
Table	getControl() returns the reference to the Phoenix Control
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.
void	setAlternate(boolean value) Setter for property alternate Default value is: false
void	setFooter(Toolbar footer) Setter for the aggregated footer.
void	setHeader(Toolbar header) Setter for the aggregated header.
void	setMinHeight(int value) Setter for property minHeight
void	setRecordTemplate(Record recordTemplate) Setter for the aggregated recordTemplate.
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width

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, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, 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()

constructs the class TableWidget

TableWidget

public TableWidget(String id)

constructs the class TableWidget

Parameters:

id - id of the TableWidget

TableWidget

protected TableWidget(Table control)

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

getWidth

public 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 void setWidth(String value)

Setter for property width

Overrides:

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

Parameters:

value - String

isAlternate

public boolean isAlternate()

Getter for property alternate Alternating semantic row colors.

Returns:

the value of property alternate

setAlternate

public void setAlternate(boolean value)

Setter for property alternate
Default value is: false

Parameters:

value - boolean

getMinHeight

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

Setter for property minHeight

Parameters:

value - int

isVisible

public boolean isVisible()

Getter for property visible Defines whether control is visible.

Overrides:

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

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

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

Parameters:

value - boolean

getHeader

public 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 void setHeader(Toolbar header)

Setter for the aggregated header.

Parameters:

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

destroyHeader

public void destroyHeader()

Destroys the header in the Header-aggregation.

getFooter

public 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 void setFooter(Toolbar footer)

Setter for the aggregated footer.

Parameters:

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

destroyFooter

public void destroyFooter()

Destroys the footer in the Footer-aggregation.

getRecordTemplate

public 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 void setRecordTemplate(Record recordTemplate)

Setter for the aggregated recordTemplate.

Parameters:

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

destroyRecordTemplate

public void destroyRecordTemplate()

Destroys the recordTemplate in the RecordTemplate-aggregation.

attachItemSelectedEvent

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

detachItemSelectedEvent

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

createRecord

public 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 void deleteRecord(String id)

Delete one table record.

Parameters:

id - Record identifier

createRecords

public 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 void deleteRecords(String id)

Delete multiple records

Parameters:

id - Array with multiple IDs.

clear

public void clear()

Delete all records.