class sap.ui.mdc.field.FieldValueHelpMTableWrapper

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/mdc/field/FieldValueHelpMTableWrapper
Application Component: CA-UI5-MDC

Wrapper to use a sap.m.Table control as content of a FieldValueHelp element


Constructor

Constructor for a new FieldValueHelpMTableWrapper.

The FieldValueHelp element supports different types of content. This is a wrapper to use a Table control as 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.field.FieldValueHelpMTableWrapper(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


Aggregations

Default Aggregation: table

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

Table of the field help.

As the FieldValueHelp element cannot know the semantic of the items, the caller is responsible for the item handling. The items must be active to allow interaction and selection.

This can be handled automatically if the following applies:

  • No keyPath or descriptionPath is specified for the FieldValueHelp element
  • Table has no paging
  • Table uses ColumnListItem as item
  • The first column if the table contains the key and the second column the description, using a Text control

For everything else the application has to implement the logic.

If the ListBinding of the table is initially created to be suspended, no filtering or selection is triggered. So the table is empty. Upon user interaction (type ahead, search request, or search from FilterBar) the ListBinding is resumed so the filter is executed. If FilterBar is in LiveMode, and InParameters are used, this also triggers filtering.


Methods Overview

Method Description
destroyTable

Destroys the table in the aggregation table.

sap.ui.mdc.field.FieldValueHelpMTableWrapper.extend

Creates a new subclass of class sap.ui.mdc.field.FieldValueHelpMTableWrapper 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.field.FieldValueHelpTableWrapperBase.extend.

sap.ui.mdc.field.FieldValueHelpMTableWrapper.getMetadata

Returns a metadata object for class sap.ui.mdc.field.FieldValueHelpMTableWrapper.

getTable

Gets content of aggregation table.

Table of the field help.

As the FieldValueHelp element cannot know the semantic of the items, the caller is responsible for the item handling. The items must be active to allow interaction and selection.

This can be handled automatically if the following applies:

  • No keyPath or descriptionPath is specified for the FieldValueHelp element
  • Table has no paging
  • Table uses ColumnListItem as item
  • The first column if the table contains the key and the second column the description, using a Text control

For everything else the application has to implement the logic.

If the ListBinding of the table is initially created to be suspended, no filtering or selection is triggered. So the table is empty. Upon user interaction (type ahead, search request, or search from FilterBar) the ListBinding is resumed so the filter is executed. If FilterBar is in LiveMode, and InParameters are used, this also triggers filtering.

setTable

Sets the aggregated table.

destroyTable

Destroys the table in the aggregation table.

sap.ui.mdc.field.FieldValueHelpMTableWrapper.extend

Creates a new subclass of class sap.ui.mdc.field.FieldValueHelpMTableWrapper 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.field.FieldValueHelpTableWrapperBase.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

sap.ui.mdc.field.FieldValueHelpMTableWrapper.getMetadata

Returns a metadata object for class sap.ui.mdc.field.FieldValueHelpMTableWrapper.

getTable

Gets content of aggregation table.

Table of the field help.

As the FieldValueHelp element cannot know the semantic of the items, the caller is responsible for the item handling. The items must be active to allow interaction and selection.

This can be handled automatically if the following applies:

For everything else the application has to implement the logic.

If the ListBinding of the table is initially created to be suspended, no filtering or selection is triggered. So the table is empty. Upon user interaction (type ahead, search request, or search from FilterBar) the ListBinding is resumed so the filter is executed. If FilterBar is in LiveMode, and InParameters are used, this also triggers filtering.

setTable

Sets the aggregated table.

Param Type DefaultValue Description
oTable sap.m.Table

The table to set