class sap.ui.mdc.field.CustomFieldHelp

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

A field help used in the FieldHelp association in FieldBase controls that allows you to add custom content.


Constructor

Constructor for a new CustomFieldHelp.

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.CustomFieldHelp(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

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

Aggregations

Default Aggregation: content

Name Cardinality Type Description
content (default) 0..1 sap.ui.core.Control

Content of the field help.


Events Overview

Event Description
beforeOpen

This event is fired before the field help opens.

beforeOpen

This event is fired before the field help opens.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachBeforeOpen

Attaches event handler fnFunction to the beforeOpen event of this sap.ui.mdc.field.CustomFieldHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.field.CustomFieldHelp itself.

This event is fired before the field help opens.

destroyContent

Destroys the content in the aggregation content.

detachBeforeOpen

Detaches event handler fnFunction from the beforeOpen event of this sap.ui.mdc.field.CustomFieldHelp.

The passed function and listener object must match the ones used for event registration.

sap.ui.mdc.field.CustomFieldHelp.extend

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

fireBeforeOpen

Fires event beforeOpen to attached listeners.

fireSelectEvent

Closes the field help and fires the select event of the field help.

getContent

Gets content of aggregation content.

Content of the field help.

sap.ui.mdc.field.CustomFieldHelp.getMetadata

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

setContent

Sets the aggregated content.

attachBeforeOpen

Attaches event handler fnFunction to the beforeOpen event of this sap.ui.mdc.field.CustomFieldHelp.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.mdc.field.CustomFieldHelp itself.

This event is fired before the field help opens.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.mdc.field.CustomFieldHelp itself

destroyContent

Destroys the content in the aggregation content.

detachBeforeOpen

Detaches event handler fnFunction from the beforeOpen event of this sap.ui.mdc.field.CustomFieldHelp.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.mdc.field.CustomFieldHelp.extend

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

fireBeforeOpen

Fires event beforeOpen to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireSelectEvent

Closes the field help and fires the select event of the field help.

Param Type DefaultValue Description
aConditions object[]

Selected conditions

getContent

Gets content of aggregation content.

Content of the field help.

sap.ui.mdc.field.CustomFieldHelp.getMetadata

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

setContent

Sets the aggregated content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to set