Binding

The OData property that a SmartField control manages is determined by the binding of the value property of the control. Properties of a complex type are not supported.

The SmartField control allows for binding of navigation properties.

The entity set to which the bindings are related is either specified in the entitySet attribute of the control or derived from the binding context at runtime.

When binding the SmartField control against the OData service property of type Edm.Boolean, and if the SmartField control is in read-only mode, static texts are used for visual representation. In addition, a configuration parameter in the SmartField control can define the properties of the static texts of the CheckBox, such as Yes/No or True/False. For the SmartForm control, the custom data can be used for this purpose.

Configuration

The configuration aggregation of SmartField provides the option to overwrite the default behavior of the SmartField control.

Using the controlType property, you can select the appropriate control for your use case.

The following control types are available:

• Check box

• Date picker

• Dropdown list (combo box)

• Input

• Select dropdown list (sap.m.Select)

It depends on the related data types and configurations which control types are rendered, for example:

• If the relevant OData property is of type Edm.String, the SmartField control can be configured to render a combo box or a select dropdown list.

• If the relevant OData property is of type Edm.Boolean, the SmartField control can be configured to render a combo box.

• If the relevant OData property is of type Edm.DateTime, the SmartField control can be configured to render a date picker.

The table below shows which controls are used if you don't overwrite the control type.

Using the displayBehaviour property, you can define how an ID and a description or Boolean values are represented in read-only mode.

You have the following options:

• sap.ui.comp.smartfield.DisplayBehaviour.descriptionAndId: Description and ID are displayed for available values.

• sap.ui.comp.smartfield.DisplayBehaviour.descriptionOnly: Only the description of the available values is displayed.

• sap.ui.comp.smartfield.DisplayBehaviour.idAndDescription: ID and description are displayed for available values.

• sap.ui.comp.smartfield.DisplayBehaviour.idOnly: Shows the ID only.

• sap.ui.comp.smartfield.DisplayBehaviour.OnOff: Shows Boolean value as On/Off

• sap.ui.comp.smartfield.DisplayBehaviour.TrueFalse: Shows Boolean value as True/False

• sap.ui.comp.smartfield.DisplayBehaviour.YesNo: Shows Boolean value as Yes/No

Using the preventInitialDataFetchInValueHelpDialog property, you can prevent the query from being fired immediately when the value help dialog is opened.

Text

The Text annotation defines the field description and where it is taken from. It can be configured with V2 or V4 annotations. For more information, see the API Reference: Text.

The configuration takes place as follows:

• For the local text annotation – it's set at a property level. The description is derived from the local text or navigational property.
• For the ValueList text annotation (with applied ValueList annotation) – it's set at the ValueList Collection level. The text is derived from the ValueList Collection text configuration. If a local text annotation is applied, it will be taken into consideration at the start as initial text value. This prevents the initial call for description from taking place. If the value is changed, the description is taken accordingly from the ValueList Collection item.

With the textInEditModeSource property of the SmartField, you can additionally configure the control at view level where the text is taken from.

TextArrangement

The TextArrangement annotation describes the arrangement of an ID value and its description. For more information, see the API Reference: TextArrangement.

Field Control

The field control handles the visual representation of SmartField controls, such as:

• Whether input is mandatory

• Whether the controls are read-only

• Whether the controls are hidden as defined by the SAP Fiori user interface programming model

  The following attributes are available to implement field control:

  • Enabled

    Toggles from display to edit mode.

  • Visible

    Hides the SmartField control.

  • Mandatory

    Determines whether input is required.

Consumers of the SmartField control can further adapt the runtime behavior by binding these attributes.

The behavior can only be made more restrictive on client side, for example, if an OData property is mandatory, this cannot be overwritten on SmartField control level.