class sap.ui.mdc.field.FieldInfoBase

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

A FieldInfoBase element is a base class that shows any kind of information related to the Field control, for example, navigation targets or contact details.


Constructor

Constructor for a new FieldInfoBase.

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

Events Overview

Event Description
dataUpdate

This event is fired if the data was updated.

popoverAfterOpen

This event is fired after the popover is opened.

dataUpdate

This event is fired if the data was updated.

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

popoverAfterOpen

This event is fired after the popover is opened.

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

Methods Overview

Method Description
attachDataUpdate

Attaches event handler fnFunction to the dataUpdate event of this sap.ui.mdc.field.FieldInfoBase.

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.FieldInfoBase itself.

This event is fired if the data was updated.

attachPopoverAfterOpen

Attaches event handler fnFunction to the popoverAfterOpen event of this sap.ui.mdc.field.FieldInfoBase.

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.FieldInfoBase itself.

This event is fired after the popover is opened.

detachDataUpdate

Detaches event handler fnFunction from the dataUpdate event of this sap.ui.mdc.field.FieldInfoBase.

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

detachPopoverAfterOpen

Detaches event handler fnFunction from the popoverAfterOpen event of this sap.ui.mdc.field.FieldInfoBase.

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

sap.ui.mdc.field.FieldInfoBase.extend

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

fireDataUpdate

Fires event dataUpdate to attached listeners.

firePopoverAfterOpen

Fires event popoverAfterOpen to attached listeners.

getContent

Returns the content of the popover.

sap.ui.mdc.field.FieldInfoBase.getMetadata

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

getSourceControl
getTriggerHref

Returns as a promise result href which defines the target navigation of the Link control created by Field. If direct navigation is used, href is returned. If the information panel contains more content than only one link, undefined is returned.

isTriggerable

Returns true as a promise result if the control created by Field can be triggered.

open

Opens the info panel in the control created by Field.

attachDataUpdate

Attaches event handler fnFunction to the dataUpdate event of this sap.ui.mdc.field.FieldInfoBase.

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.FieldInfoBase itself.

This event is fired if the data was updated.

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.FieldInfoBase itself

attachPopoverAfterOpen

Attaches event handler fnFunction to the popoverAfterOpen event of this sap.ui.mdc.field.FieldInfoBase.

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.FieldInfoBase itself.

This event is fired after the popover is opened.

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.FieldInfoBase itself

detachDataUpdate

Detaches event handler fnFunction from the dataUpdate event of this sap.ui.mdc.field.FieldInfoBase.

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

detachPopoverAfterOpen

Detaches event handler fnFunction from the popoverAfterOpen event of this sap.ui.mdc.field.FieldInfoBase.

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.FieldInfoBase.extend

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

fireDataUpdate

Fires event dataUpdate to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

firePopoverAfterOpen

Fires event popoverAfterOpen to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getContent

Returns the content of the popover.

sap.ui.mdc.field.FieldInfoBase.getMetadata

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

getSourceControl

getTriggerHref

Returns as a promise result href which defines the target navigation of the Link control created by Field. If direct navigation is used, href is returned. If the information panel contains more content than only one link, undefined is returned.

isTriggerable

Returns true as a promise result if the control created by Field can be triggered.

open

Opens the info panel in the control created by Field.

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

Optional control reference to which the popover is attached. By default the parent is used as reference.