com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDTable

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDTable

extends IWDUIElement

Web Dynpro Table API. Table represents a two-dimensional data set arranged in rows and columns.

Data binding:
The table gets its data from a context node X.

The number of table rows is given by the number of elements in X. The selected table rows are given by the selection of X. The editable row is determined by the lead selection of X.

Table columns are defined by aggregating TableColumn objects. Each table column has a table cell editor. Every property of the table cell editor may be bound either

1. to an attribute of the context node X, or
2. to a context root attribute.

In the first case, the property value in row i is determined by the attribute value of the ith node element. Otherwise, the property value is the same for all rows and given by the root attribute's value.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static java.lang.String	DEFAULT_ACCESSIBILITY_DESCRIPTION Default value of property accessibilityDescription.
static WDTableDesign	DEFAULT_DESIGN Default value of property design.
static int	DEFAULT_FIRST_VISIBLE_ROW Default value of property firstVisibleRow.
static boolean	DEFAULT_FOOTER_VISIBLE Default value of property footerVisible.
static boolean	DEFAULT_READ_ONLY Default value of property readOnly.
static WDTableSelectionMode	DEFAULT_SELECTION_MODE Default value of property selectionMode.
static int	DEFAULT_VISIBLE_ROW_COUNT Default value of property visibleRowCount.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	addColumn(IWDTableColumn aTableColumn) Adds the given Column at the end of the list of Columns.
void	addColumn(IWDTableColumn aTableColumn, int index) Adds the given Column at the specified index in the list of Columns.
void	bindAccessibilityDescription(IWDAttributeInfo attributeInfo) Binds property accessibilityDescription to the context attribute specified by the given attribute info.
void	bindAccessibilityDescription(java.lang.String path) Binds property accessibilityDescription to the context attribute specified by path.
void	bindDataSource(IWDNodeInfo nodeInfo) Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.
void	bindDataSource(java.lang.String path) Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.
void	bindDesign(IWDAttributeInfo attributeInfo) Binds property design to the context attribute specified by the given attribute info.
void	bindDesign(java.lang.String path) Binds property design to the context attribute specified by path.
void	bindFirstVisibleRow(IWDAttributeInfo attributeInfo) Binds property firstVisibleRow to the context attribute specified by the given attribute info.
void	bindFirstVisibleRow(java.lang.String path) Binds property firstVisibleRow to the context attribute specified by path.
void	bindFooterVisible(IWDAttributeInfo attributeInfo) Binds property footerVisible to the context attribute specified by the given attribute info.
void	bindFooterVisible(java.lang.String path) Binds property footerVisible to the context attribute specified by path.
java.lang.String	bindingOfAccessibilityDescription() Binding path of property accessibilityDescription.
java.lang.String	bindingOfDataSource() Note: This property must be bound to the context! Binding path of property dataSource.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfFirstVisibleRow() Binding path of property firstVisibleRow.
java.lang.String	bindingOfFooterVisible() Binding path of property footerVisible.
java.lang.String	bindingOfReadOnly() Binding path of property readOnly.
java.lang.String	bindingOfVisibleRowCount() Binding path of property visibleRowCount.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindReadOnly(IWDAttributeInfo attributeInfo) Binds property readOnly to the context attribute specified by the given attribute info.
void	bindReadOnly(java.lang.String path) Binds property readOnly to the context attribute specified by path.
void	bindVisibleRowCount(IWDAttributeInfo attributeInfo) Binds property visibleRowCount to the context attribute specified by the given attribute info.
void	bindVisibleRowCount(java.lang.String path) Binds property visibleRowCount to the context attribute specified by path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
void	destroyAllColumns() Destroys all entries in the list of Columns.
void	destroyHeader() Destroys the Header instance.
void	destroyMasterColumn() Destroys the MasterColumn instance.
void	destroyToolBar() Destroys the ToolBar instance.
java.lang.String	getAccessibilityDescription() Returns the value of the accessibilityDescription property.
IWDTableColumn	getColumn(int index) Returns the Column at the given index.
IWDTableColumn[]	getColumns() Returns the list of Columns.
WDTableDesign	getDesign() Returns the value of the design property.
int	getFirstVisibleRow() Returns the value of the firstVisibleRow property.
boolean	getFooterVisible() Returns the value of the footerVisible property.
IWDCaption	getHeader() Gets the Header instance.
IWDAbstractMasterTableColumn	getMasterColumn() Gets the MasterColumn instance.
IWDAction	getOnFilter() Returns the action to which the event onFilter is mapped.
IWDAction	getOnLeadSelect() Returns the action to which the event onLeadSelect is mapped.
boolean	getReadOnly() Returns the value of the readOnly property.
WDTableSelectionMode	getSelectionMode() Returns the value of the selectionMode property.
IWDToolBar	getToolBar() Gets the ToolBar instance.
int	getVisibleRowCount() Returns the value of the visibleRowCount property.
java.lang.String	getWidth() Returns the value of the width property.
boolean	hasColumns() Checks if there exist Columns.
int	indexOfColumn(IWDTableColumn aTableColumn) Returns the index of the given element in the list of Columns or -1 if it is not contained in the list.
java.util.Iterator	iterateColumns() Returns an iterator over the list of Columns.
IWDParameterMapping	mappingOfOnFilter() Returns the parameter mapping of event onFilter.
IWDParameterMapping	mappingOfOnLeadSelect() Returns the parameter mapping of event onLeadSelect.
int	numberOfColumns() Returns the number of Columns.
void	removeAllColumns() Removes all entries from the list of Columns.
IWDTableColumn	removeColumn(int index) Removes the entry at the given index from the list of Columns.
IWDTableColumn	removeColumn(java.lang.String id) Removes the entry with the given ID from the list of Columns.
void	setAccessibilityDescription(java.lang.String value) Sets property accessibilityDescription to the new value.
void	setDesign(WDTableDesign value) Sets property design to the new value.
void	setFirstVisibleRow(int value) Sets property firstVisibleRow to the new value.
void	setFooterVisible(boolean value) Sets property footerVisible to the new value.
void	setHeader(IWDCaption header) Sets the Header instance.
void	setMasterColumn(IWDAbstractMasterTableColumn masterColumn) Sets the MasterColumn instance.
void	setOnFilter(IWDAction action) Maps the event onFilter to the given action.
void	setOnLeadSelect(IWDAction action) Maps the event onLeadSelect to the given action.
void	setReadOnly(boolean value) Sets property readOnly to the new value.
void	setSelectionMode(WDTableSelectionMode selectionMode) Sets property selectionMode to the given value.
void	setToolBar(IWDToolBar toolBar) Sets the ToolBar instance.
void	setVisibleRowCount(int value) Sets property visibleRowCount to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.
void	swapColumns(int i, int j) Swaps the Columns at the given indices.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_ACCESSIBILITY_DESCRIPTION

public static final java.lang.String DEFAULT_ACCESSIBILITY_DESCRIPTION

Default value of property accessibilityDescription.

DEFAULT_DESIGN

public static final WDTableDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_FIRST_VISIBLE_ROW

public static final int DEFAULT_FIRST_VISIBLE_ROW

Default value of property firstVisibleRow.

DEFAULT_FOOTER_VISIBLE

public static final boolean DEFAULT_FOOTER_VISIBLE

Default value of property footerVisible.

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

Default value of property readOnly.

DEFAULT_SELECTION_MODE

public static final WDTableSelectionMode DEFAULT_SELECTION_MODE

Default value of property selectionMode.

DEFAULT_VISIBLE_ROW_COUNT

public static final int DEFAULT_VISIBLE_ROW_COUNT

Default value of property visibleRowCount.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

getOnFilter

public IWDAction getOnFilter()

Returns the action to which the event onFilter is mapped. The event raised when the filter button is pressed.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnFilter()

setOnFilter

public void setOnFilter(IWDAction action)

Maps the event onFilter to the given action.

Parameters:

action - the action for the event

See Also:

getOnFilter()

mappingOfOnFilter

public IWDParameterMapping mappingOfOnFilter()

Returns the parameter mapping of event onFilter.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnFilter()

getOnLeadSelect

public IWDAction getOnLeadSelect()

Returns the action to which the event onLeadSelect is mapped. The action performed when the lead selection of the table was changed. Event parameters are the ID of the column and the zero based index of the row where the selection occured.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnLeadSelect()

setOnLeadSelect

public void setOnLeadSelect(IWDAction action)

Maps the event onLeadSelect to the given action.

Parameters:

action - the action for the event

See Also:

getOnLeadSelect()

mappingOfOnLeadSelect

public IWDParameterMapping mappingOfOnLeadSelect()

Returns the parameter mapping of event onLeadSelect.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• String col - The ID of the selected column.
• int row - The zero based index of the selected row.

Returns:

parameter mapping list.

See Also:

getOnLeadSelect()

bindAccessibilityDescription

public void bindAccessibilityDescription(java.lang.String path)

Binds property accessibilityDescription to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the accessibilityDescription property is bound

bindAccessibilityDescription

public void bindAccessibilityDescription(IWDAttributeInfo attributeInfo)

Binds property accessibilityDescription to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the accessibilityDescription property is bound

bindingOfAccessibilityDescription

public java.lang.String bindingOfAccessibilityDescription()

Binding path of property accessibilityDescription.

Returns:

the path of the context attribute to which the accessibilityDescription is currently bound

getAccessibilityDescription

public java.lang.String getAccessibilityDescription()

Returns the value of the accessibilityDescription property. The initial value is "". Short description for the Table (it's like a title) in the accessibility mode. Should be used if no title is available. If you set both, title and accessibilityDescription, only the accessibilityDescription is considered. It is only used if accessibility mode (508) is switched on and will be included into the tooltip. Its read by the screen reader when the whole UI element gets the focus.

Returns:

the current value of the accessibilityDescription property

See Also:

setAccessibilityDescription(String)

setAccessibilityDescription

public void setAccessibilityDescription(java.lang.String value)

Sets property accessibilityDescription to the new value.

Parameters:

value - the new value of the accessibilityDescription property

See Also:

getAccessibilityDescription()

bindDataSource

public void bindDataSource(java.lang.String path)

Note: This property must be bound to the context! Binds property dataSource to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the dataSource property is bound

bindDataSource

public void bindDataSource(IWDNodeInfo nodeInfo)

Note: This property must be bound to the context! Binds property dataSource to the context node specified by the given node info.

Parameters:

nodeInfo - the info of the context node to which the dataSource property is bound

bindingOfDataSource

public java.lang.String bindingOfDataSource()

Note: This property must be bound to the context! Binding path of property dataSource.

Returns:

the path of the context attribute to which the dataSource is currently bound

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the design property is bound

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

Binds property design to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the design property is bound

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

the path of the context attribute to which the design is currently bound

getDesign

public WDTableDesign getDesign()

Returns the value of the design property. The initial value is WDTableDesign.STANDARD. Determines the visual design of the table.

Returns:

the current value of the design property

See Also:

setDesign(WDTableDesign)

setDesign

public void setDesign(WDTableDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindFirstVisibleRow

public void bindFirstVisibleRow(java.lang.String path)

Binds property firstVisibleRow to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the firstVisibleRow property is bound

bindFirstVisibleRow

public void bindFirstVisibleRow(IWDAttributeInfo attributeInfo)

Binds property firstVisibleRow to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the firstVisibleRow property is bound

bindingOfFirstVisibleRow

public java.lang.String bindingOfFirstVisibleRow()

Binding path of property firstVisibleRow.

Returns:

the path of the context attribute to which the firstVisibleRow is currently bound

getFirstVisibleRow

public int getFirstVisibleRow()

Returns the value of the firstVisibleRow property. The initial value is 0. Determines which row should be the first visible, counts from zero.

Returns:

the current value of the firstVisibleRow property

See Also:

setFirstVisibleRow(int)

setFirstVisibleRow

public void setFirstVisibleRow(int value)

Sets property firstVisibleRow to the new value.

Parameters:

value - the new value of the firstVisibleRow property

See Also:

getFirstVisibleRow()

bindFooterVisible

public void bindFooterVisible(java.lang.String path)

Binds property footerVisible to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the footerVisible property is bound

bindFooterVisible

public void bindFooterVisible(IWDAttributeInfo attributeInfo)

Binds property footerVisible to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the footerVisible property is bound

bindingOfFooterVisible

public java.lang.String bindingOfFooterVisible()

Binding path of property footerVisible.

Returns:

the path of the context attribute to which the footerVisible is currently bound

getFooterVisible

public boolean getFooterVisible()

Returns the value of the footerVisible property. The initial value is true. Determines if the table footer is displayed.

Returns:

the current value of the footerVisible property

See Also:

setFooterVisible(boolean)

setFooterVisible

public void setFooterVisible(boolean value)

Sets property footerVisible to the new value.

Parameters:

value - the new value of the footerVisible property

See Also:

getFooterVisible()

bindReadOnly

public void bindReadOnly(java.lang.String path)

Binds property readOnly to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the readOnly property is bound

bindReadOnly

public void bindReadOnly(IWDAttributeInfo attributeInfo)

Binds property readOnly to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the readOnly property is bound

bindingOfReadOnly

public java.lang.String bindingOfReadOnly()

Binding path of property readOnly.

Returns:

the path of the context attribute to which the readOnly is currently bound

getReadOnly

public boolean getReadOnly()

Returns the value of the readOnly property. The initial value is false. Determines if the table is editable. If set to true editing data in the table is disabled.

Returns:

the current value of the readOnly property

See Also:

setReadOnly(boolean)

setReadOnly

public void setReadOnly(boolean value)

Sets property readOnly to the new value.

Parameters:

value - the new value of the readOnly property

See Also:

getReadOnly()

getSelectionMode

public WDTableSelectionMode getSelectionMode()

Returns the value of the selectionMode property. The initial value is WDTableSelectionMode.AUTO. Determines how table rows can be selected.

Returns:

the value of the selectionMode property

See Also:

setSelectionMode(WDTableSelectionMode)

setSelectionMode

public void setSelectionMode(WDTableSelectionMode selectionMode)

Sets property selectionMode to the given value.

Parameters:

selectionMode - the new selectionMode value

See Also:

getSelectionMode()

bindVisibleRowCount

public void bindVisibleRowCount(java.lang.String path)

Binds property visibleRowCount to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the visibleRowCount property is bound

bindVisibleRowCount

public void bindVisibleRowCount(IWDAttributeInfo attributeInfo)

Binds property visibleRowCount to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the visibleRowCount property is bound

bindingOfVisibleRowCount

public java.lang.String bindingOfVisibleRowCount()

Binding path of property visibleRowCount.

Returns:

the path of the context attribute to which the visibleRowCount is currently bound

getVisibleRowCount

public int getVisibleRowCount()

Returns the value of the visibleRowCount property. The initial value is 5. The number of rows that should be visible without scrolling; a value of -1 means "unlimited" and displays all rows without scrolling.

Returns:

the current value of the visibleRowCount property

See Also:

setVisibleRowCount(int)

setVisibleRowCount

public void setVisibleRowCount(int value)

Sets property visibleRowCount to the new value.

Parameters:

value - the new value of the visibleRowCount property

See Also:

getVisibleRowCount()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the width property is bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds property width to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property is bound

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

the path of the context attribute to which the width is currently bound

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". The width (CSS size) of the table.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

addColumn

public void addColumn(IWDTableColumn aTableColumn)

Adds the given Column at the end of the list of Columns.

Parameters:

aTableColumn - the Column to be added into the list

See Also:

getColumns()

addColumn

public void addColumn(IWDTableColumn aTableColumn,
                      int index)

Adds the given Column at the specified index in the list of Columns.

Parameters:

aTableColumn - the Column to be added into the list

index - zero based index of the insertion position in the list

See Also:

getColumns()

swapColumns

public void swapColumns(int i,
                        int j)

Swaps the Columns at the given indices.

Parameters:

i - index of the first Column to swap

j - index of the second Column to swap

Throws:

IndexOutOfBoundsException - If one of the indices is out of bounds

getColumns

public IWDTableColumn[] getColumns()

Returns the list of Columns. A table contains a number of table columns.

Returns:

an array containing references to the current Columns

getColumn

public IWDTableColumn getColumn(int index)

Returns the Column at the given index.

Returns:

Column at the given index

indexOfColumn

public int indexOfColumn(IWDTableColumn aTableColumn)

Returns the index of the given element in the list of Columns or -1 if it is not contained in the list.

numberOfColumns

public int numberOfColumns()

Returns the number of Columns.

Returns:

the current number of Columns.

See Also:

getColumns()

hasColumns

public boolean hasColumns()

Checks if there exist Columns.

Returns:

true if there are Columns; false otherwise.

See Also:

getColumns()

iterateColumns

public java.util.Iterator iterateColumns()

Returns an iterator over the list of Columns.

Returns:

an iterator over the current Columns

See Also:

getColumns()

removeColumn

public IWDTableColumn removeColumn(int index)

Removes the entry at the given index from the list of Columns. This does not destroy the removed element, i.e. it may be added again!

Parameters:

index - zero based index of the deletion position in the list

Returns:

the removed element

See Also:

addColumn(IWDTableColumn), getColumns()

removeColumn

public IWDTableColumn removeColumn(java.lang.String id)

Removes the entry with the given ID from the list of Columns. This does not destroy the removed element, i.e. it may be added again!

Parameters:

id - unique ID of the element to be deleted from the list

Returns:

the removed element

See Also:

addColumn(IWDTableColumn), getColumns()

removeAllColumns

public void removeAllColumns()

Removes all entries from the list of Columns. This does not destroy the removed elements, i.e. they may be added again!

See Also:

addColumn(IWDTableColumn), getColumns()

destroyAllColumns

public void destroyAllColumns()

Destroys all entries in the list of Columns. Destroyed elements do not exist any longer, i.e. new elements may be created with the same IDs.

getHeader

public IWDCaption getHeader()

Gets the Header instance. The header of a table contains a caption.

Returns:

the current Header

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the Header instance.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

Destroys the Header instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getMasterColumn

public IWDAbstractMasterTableColumn getMasterColumn()

Gets the MasterColumn instance.

Returns:

the current MasterColumn

See Also:

setMasterColumn(IWDAbstractMasterTableColumn)

setMasterColumn

public void setMasterColumn(IWDAbstractMasterTableColumn masterColumn)

Sets the MasterColumn instance.

Parameters:

masterColumn - the new masterColumn

See Also:

getMasterColumn()

destroyMasterColumn

public void destroyMasterColumn()

Destroys the MasterColumn instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getToolBar

public IWDToolBar getToolBar()

Gets the ToolBar instance. A table may contain a toolbar.

Returns:

the current ToolBar

See Also:

setToolBar(IWDToolBar)

setToolBar

public void setToolBar(IWDToolBar toolBar)

Sets the ToolBar instance.

Parameters:

toolBar - the new toolBar

See Also:

getToolBar()

destroyToolBar

public void destroyToolBar()

Destroys the ToolBar instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.