abstract class sap.ui.mdc.valuehelp.content.MTable

Visiblity: restricted
UX Guidelines:
Implements: sap.ui.mdc.valuehelp.ITypeaheadContentsap.ui.mdc.valuehelp.IDialogContent
Available since: N/A
Module: sap/ui/mdc/valuehelp/content/MTable
Application Component: CA-UI5-MDC

Content for the sap.ui.mdc.valuehelp.base.Container element using a sap.m.Table.


Constructor

Constructor for a new MTable content.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.mdc.valuehelp.content.MTable(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control

Borrowed Properties

Name Type Default Value Description
descriptionPath string empty string

The path of the description field in the content binding. If a table is used as content, this is the binding path of the description of the items.

Visibility: public
filterFields string empty string

The fields based on which the table data is filtered. For filtering the value of the filterValue property is used.

If set to $search and the used binding supports search requests, a $search request is used for filtering.

If set to one or more properties, the filters for these properties are used for filtering. These filters are set on the ListBinding used. The properties need to be separated by commas and enclosed by "*" characters. ("*Property1,Property2*")

If it is empty, no suggestion is available.

Visibility: public
inConditions object empty object

Internal property to allow to bind the conditions created by InParameters to content

Visibility: public
keyPath string empty string

The path of the key field in the content binding. If a table is used as content, this is the binding path of the key of the items.

If not set, the FieldPath of the assigned field is used.

Visibility: public
outParameterNames string[]

Internal property to allow to bind the paths used by OutParameters to content

Visibility: public
caseSensitive boolean false

If this property is set to true, the filtering for user input is always case-sensitive. Otherwise user input is checked case-insensitively. If $search is used, this property has no effect on the $search request.

If the used back-end service supports a case-insensitive search, set this property to false.

Visibility: public
useAsValueHelp boolean true

If set, the List is also opened if the ValueHelp icon is pressed.

Visibility: public
useFirstMatch boolean true

If set, getKeyForText returns the first item that matches the text.

This is the case if the text of the item starts with the text entered.

Visibility: public
conditions object[]

Conditions of the value help

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
config object empty object

internal configuration

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
filterValue string empty string

Value for filtering ($search)

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
shortTitle string empty string

Title text that appears in the dialog header.

Visibility: public
title string empty string

Title text that appears tab header.

Visibility: public

Aggregations

Default Aggregation: table

Name Cardinality Type Description
table (default) 0..1 sap.m.Table

Table to be used in value help

Borrowed Aggregations

Name Cardinality Type Description
collectiveSearchItems 0..n sap.ui.core.Item

Items used for collective search. If none assigned, no collective search is available.

filterBar 0..1 sap.ui.mdc.filterbar.FilterBarBase

FilterBar

inParameters 0..n sap.ui.mdc.field.InParameter

Sets the in parameters of a field help.

If set, the field help reads the data of these entities in the model and uses it to filter in the value help.

outParameters 0..n sap.ui.mdc.field.OutParameter

Sets the out parameters of a field help.

If set, the fields sets the data of these entities in the model based to the selected values.

displayContent 0..1 sap.ui.core.Control

Content control that is put inside the parent container

Note: This aggregation must not be set from outside, it is only to be used by the corresponding container


Events Overview

Event Description
contentUpdated

This event is fired if the content of the table is updated

contentUpdated

This event is fired if the content of the table is updated

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachContentUpdated

Attaches event handler fnFunction to the contentUpdated event of this sap.ui.mdc.valuehelp.content.MTable.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.valuehelp.content.MTable itself.

This event is fired if the content of the table is updated

destroyTable

Destroys the table in the aggregation table.

detachContentUpdated

Detaches event handler fnFunction from the contentUpdated event of this sap.ui.mdc.valuehelp.content.MTable.

The passed function and listener object must match the ones used for event registration.

sap.ui.mdc.valuehelp.content.MTable.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.content.MTable with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.valuehelp.base.FilterableListContent.extend.

fireContentUpdated

Fires event contentUpdated to attached listeners.

sap.ui.mdc.valuehelp.content.MTable.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.content.MTable.

getTable

Gets content of aggregation table.

Table to be used in value help

setTable

Sets the aggregated table.

attachContentUpdated

Attaches event handler fnFunction to the contentUpdated event of this sap.ui.mdc.valuehelp.content.MTable.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.valuehelp.content.MTable itself.

This event is fired if the content of the table is updated

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.valuehelp.content.MTable itself

destroyTable

Destroys the table in the aggregation table.

detachContentUpdated

Detaches event handler fnFunction from the contentUpdated event of this sap.ui.mdc.valuehelp.content.MTable.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.mdc.valuehelp.content.MTable.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.content.MTable with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.mdc.valuehelp.base.FilterableListContent.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireContentUpdated

Fires event contentUpdated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

sap.ui.mdc.valuehelp.content.MTable.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.content.MTable.

getTable

Gets content of aggregation table.

Table to be used in value help

setTable

Sets the aggregated table.

Param Type DefaultValue Description
oTable sap.m.Table

The table to set