class sap.ui.integration.editor.fields.BaseField

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/integration/editor/fields/BaseField
Application Component: CA-UI5-CTR

Constructor

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.integration.editor.fields.BaseField()

Properties

Name Type Default Value Description
configuration object Visibility: public
host object Visibility: public
mode string Visibility: public
specialButton object Visibility: public
visible boolean true Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_dynamicField 0..1 sap.ui.core.Control
_field 0..1 sap.ui.core.Control

Associations

Name Cardinality Type Description
_messageIcon 0..1 sap.ui.core.Icon
_messageStrip 0..1 sap.m.MessageStrip

Events Overview

Event Description
afterInit

afterInit

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

Methods Overview

Method Description
attachAfterInit

Attaches event handler fnFunction to the afterInit event of this sap.ui.integration.editor.fields.BaseField.

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.integration.editor.fields.BaseField itself.

detachAfterInit

Detaches event handler fnFunction from the afterInit event of this sap.ui.integration.editor.fields.BaseField.

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

sap.ui.integration.editor.fields.BaseField.extend

Creates a new subclass of class sap.ui.integration.editor.fields.BaseField 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.Control.extend.

fireAfterInit

Fires event afterInit to attached listeners.

getConfiguration

Gets current value of property configuration.

getHost

Gets current value of property host.

sap.ui.integration.editor.fields.BaseField.getMetadata

Returns a metadata object for class sap.ui.integration.editor.fields.BaseField.

getMode

Gets current value of property mode.

getSpecialButton

Gets current value of property specialButton.

getVisible

Gets current value of property visible.

Default value is true.

setConfiguration

Sets a new value for property configuration.

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

setHost

Sets a new value for property host.

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

setMode

Sets a new value for property mode.

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

setSpecialButton

Sets a new value for property specialButton.

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

setVisible

Sets a new value for property visible.

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

Default value is true.

attachAfterInit

Attaches event handler fnFunction to the afterInit event of this sap.ui.integration.editor.fields.BaseField.

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.integration.editor.fields.BaseField itself.

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.integration.editor.fields.BaseField itself

detachAfterInit

Detaches event handler fnFunction from the afterInit event of this sap.ui.integration.editor.fields.BaseField.

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.integration.editor.fields.BaseField.extend

Creates a new subclass of class sap.ui.integration.editor.fields.BaseField 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.Control.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

fireAfterInit

Fires event afterInit to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getConfiguration

Gets current value of property configuration.

getHost

Gets current value of property host.

sap.ui.integration.editor.fields.BaseField.getMetadata

Returns a metadata object for class sap.ui.integration.editor.fields.BaseField.

getMode

Gets current value of property mode.

getSpecialButton

Gets current value of property specialButton.

getVisible

Gets current value of property visible.

Default value is true.

setConfiguration

Sets a new value for property configuration.

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

Param Type DefaultValue Description
oConfiguration object

New value for property configuration

setHost

Sets a new value for property host.

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

Param Type DefaultValue Description
oHost object

New value for property host

setMode

Sets a new value for property mode.

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

Param Type DefaultValue Description
sMode string

New value for property mode

setSpecialButton

Sets a new value for property specialButton.

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

Param Type DefaultValue Description
oSpecialButton object

New value for property specialButton

setVisible

Sets a new value for property visible.

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

Default value is true.

Param Type DefaultValue Description
bVisible boolean true

New value for property visible