Class sap.ui.comp.smartfield.ConfigurationModule: sap/ui/comp/smartfield/Configuration

extends Element

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

Constructor Summary
new sap.ui.comp.smartfield.Configuration(sId?, mSettings?)Constructor for a new smartfield/Configuration.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.smartfield.Configuration.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartfield.Configuration with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartfield.Configuration.getMetadata()Returns a metadata object for class sap.ui.comp.smartfield.Configuration.
getControlType()Gets current value of property controlType.
getDisplayBehaviour()Gets current value of property displayBehaviour.
getPreventInitialDataFetchInValueHelpDialog()Gets current value of property preventInitialDataFetchInValueHelpDialog.
setControlType(sControlType)Sets a new value for property controlType.
setDisplayBehaviour(sDisplayBehaviour)Sets a new value for property displayBehaviour.
setPreventInitialDataFetchInValueHelpDialog(bPreventInitialDataFetchInValueHelpDialog)Sets a new value for property preventInitialDataFetchInValueHelpDialog.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.comp.smartfield.Configuration(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.comp.smartfield.Configuration.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.comp.smartfield.Configuration.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartfield.Configuration.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getControlType(): sap.ui.comp.smartfield.ControlType
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.

Returns:
{sap.ui.comp.smartfield.ControlType} Value of property controlType
getDisplayBehaviour(): sap.ui.comp.smartfield.DisplayBehaviour
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.

Returns:
{sap.ui.comp.smartfield.DisplayBehaviour} Value of property displayBehaviour
getPreventInitialDataFetchInValueHelpDialog(): boolean
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 true, which means the table will not be filled as the data fetch is prevented.

Default value is true.

Returns:
{boolean} Value of property preventInitialDataFetchInValueHelpDialog
setControlType(sControlType): sap.ui.comp.smartfield.Configuration
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.

Parameters:
{sap.ui.comp.smartfield.ControlType}sControlType New value for property controlType
Returns:
{sap.ui.comp.smartfield.Configuration} Reference to this in order to allow method chaining
setDisplayBehaviour(sDisplayBehaviour): sap.ui.comp.smartfield.Configuration
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.

Parameters:
{sap.ui.comp.smartfield.DisplayBehaviour}sDisplayBehaviour New value for property displayBehaviour
Returns:
{sap.ui.comp.smartfield.Configuration} Reference to this in order to allow method chaining
setPreventInitialDataFetchInValueHelpDialog(bPreventInitialDataFetchInValueHelpDialog): sap.ui.comp.smartfield.Configuration
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 true, which means the table will not be filled as the data fetch is prevented.

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

Default value is true.

Parameters:
{boolean}bPreventInitialDataFetchInValueHelpDialog New value for property preventInitialDataFetchInValueHelpDialog
Returns:
{sap.ui.comp.smartfield.Configuration} Reference to this in order to allow method chaining