class sap.ui.mdc.field.ConditionFieldHelp

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

A field help used in the FieldHelp association in FieldBase controls to show a popover of conditions.


Constructor

Constructor for a new ConditionFieldHelp.

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.ConditionFieldHelp(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
_enableOK boolean true

Internal property to bind the OK button to enable or disable it.

Visibility: hidden
label string empty string

Label text that appears as label for the conditions.

Since: 1.84.0.

Visibility: public
title string empty string

Title text that appears in the popover header.

Since: 1.83.0.

Visibility: public

Borrowed Properties

Name Type Default Value Description
conditions object[]

The conditions of the selected items.

Note: This property must only be set by the control the FieldHelp element belongs to, not by the application.

Note: A condition must have the structure of ConditionObject.

Visibility: public
delegate object ...see text or source

Defines the module path of the metadata delegate.

Visibility: public
filterValue string empty string

The value by which the help is filtered.

Note: This only takes effect if the FieldHelp element supports filtering.

Note: This property must only be set by the control the FieldHelp element belongs to, not by the application.

Visibility: public
validateInput boolean true

If this property is set, the user input is validated against the field help. If no entry is found for the user input, an error occurs.

If this property is not set, the user input is still checked against the field help. But if no entry is found, the user input is set to the field if the used data type allows this. (A type parsing error is shown if the user input adheres to the requirements of the used data type.)

Since: 1.69.0.

Visibility: public
delegate object

Path to the Delegate module that provides the required APIs to execute model-specific logic.
Note: Ensure that the related file can be requested (any required library has to be loaded before that).
Do not bind or modify the module. This property can only be configured during control initialization.

Visibility: public

Methods Overview

Method Description
sap.ui.mdc.field.ConditionFieldHelp.extend

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

getLabel

Gets current value of property label.

Label text that appears as label for the conditions.

Default value is empty string.

sap.ui.mdc.field.ConditionFieldHelp.getMetadata

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

getTitle

Gets current value of property title.

Title text that appears in the popover header.

Default value is empty string.

setLabel

Sets a new value for property label.

Label text that appears as label for the conditions.

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

Default value is empty string.

setTitle

Sets a new value for property title.

Title text that appears in the popover header.

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

Default value is empty string.

sap.ui.mdc.field.ConditionFieldHelp.extend

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

getLabel

Gets current value of property label.

Label text that appears as label for the conditions.

Default value is empty string.

sap.ui.mdc.field.ConditionFieldHelp.getMetadata

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

getTitle

Gets current value of property title.

Title text that appears in the popover header.

Default value is empty string.

setLabel

Sets a new value for property label.

Label text that appears as label for the conditions.

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

Default value is empty string.

Param Type DefaultValue Description
sLabel string ""

New value for property label

setTitle

Sets a new value for property title.

Title text that appears in the popover header.

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

Default value is empty string.

Param Type DefaultValue Description
sTitle string ""

New value for property title