class sap.ui.comp.smartfield.Configuration

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/comp/smartfield/Configuration
Application Component: CA-UI5-CMP

The configuration allows to further define the behavior of a SmartField.


Constructor

Constructor for a new Smartfield/Configuration.

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.comp.smartfield.Configuration(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


Properties

Name Type Default Value Description
controlType sap.ui.comp.smartfield.ControlType

By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property allows to overwrite the default behavior to some extent. For example makes it possible to define that an OData property of type Edm.Boolean is displayed as a combo box.

Visibility: public
displayBehaviour sap.ui.comp.smartfield.DisplayBehaviour

The property specifies how value help, that is available for input fields, is presented. For example, it specifies whether the descriptions of the values shown in the result after a query are displayed.

Visibility: public
preventInitialDataFetchInValueHelpDialog boolean false

If there are value help annotations for a smart field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Visibility: public

Methods Overview

Method Description
sap.ui.comp.smartfield.Configuration.extend

Creates a new subclass of class sap.ui.comp.smartfield.Configuration 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.core.Element.extend.

getControlType

Gets current value of property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property allows to overwrite the default behavior to some extent. For example makes it possible to define that an OData property of type Edm.Boolean is displayed as a combo box.

getDisplayBehaviour

Gets current value of property displayBehaviour.

The property specifies how value help, that is available for input fields, is presented. For example, it specifies whether the descriptions of the values shown in the result after a query are displayed.

sap.ui.comp.smartfield.Configuration.getMetadata

Returns a metadata object for class sap.ui.comp.smartfield.Configuration.

getPreventInitialDataFetchInValueHelpDialog

Gets current value of property preventInitialDataFetchInValueHelpDialog.

If there are value help annotations for a smart field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Default value is false.

setControlType

Sets a new value for property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property allows to overwrite the default behavior to some extent. For example makes it possible to define that an OData property of type Edm.Boolean is displayed as a combo box.

When called with a value of null or undefined, the default value of the property will be restored.

setDisplayBehaviour

Sets a new value for property displayBehaviour.

The property specifies how value help, that is available for input fields, is presented. For example, it specifies whether the descriptions of the values shown in the result after a query are displayed.

When called with a value of null or undefined, the default value of the property will be restored.

setPreventInitialDataFetchInValueHelpDialog

Sets a new value for property preventInitialDataFetchInValueHelpDialog.

If there are value help annotations for a smart field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

sap.ui.comp.smartfield.Configuration.extend

Creates a new subclass of class sap.ui.comp.smartfield.Configuration 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.core.Element.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

getControlType

Gets current value of property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property allows to overwrite the default behavior to some extent. For example makes it possible to define that an OData property of type Edm.Boolean is displayed as a combo box.

getDisplayBehaviour

Gets current value of property displayBehaviour.

The property specifies how value help, that is available for input fields, is presented. For example, it specifies whether the descriptions of the values shown in the result after a query are displayed.

sap.ui.comp.smartfield.Configuration.getMetadata

Returns a metadata object for class sap.ui.comp.smartfield.Configuration.

getPreventInitialDataFetchInValueHelpDialog

Gets current value of property preventInitialDataFetchInValueHelpDialog.

If there are value help annotations for a smart field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

Default value is false.

setControlType

Sets a new value for property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property allows to overwrite the default behavior to some extent. For example makes it possible to define that an OData property of type Edm.Boolean is displayed as a combo box.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sControlType sap.ui.comp.smartfield.ControlType

New value for property controlType

setDisplayBehaviour

Sets a new value for property displayBehaviour.

The property specifies how value help, that is available for input fields, is presented. For example, it specifies whether the descriptions of the values shown in the result after a query are displayed.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sDisplayBehaviour sap.ui.comp.smartfield.DisplayBehaviour

New value for property displayBehaviour

setPreventInitialDataFetchInValueHelpDialog

Sets a new value for property preventInitialDataFetchInValueHelpDialog.

If there are value help annotations for a smart field, it is possible to specify whether the table in the value help dialog for this field will be filled initially. The default value is false, which means the table will be filled as the data fetch is not prevented. Note: As of version 1.78 the default value has been changed from true to false.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
bPreventInitialDataFetchInValueHelpDialog boolean false

New value for property preventInitialDataFetchInValueHelpDialog