namespace sap.ui.integration.designtime.baseEditor.propertyEditor

Available since: N/A
Module:
Application Component: CA-UI5-CTR

Nodes Overview

Node Description
sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor

Base class for property editor implementations.

sap.ui.integration.designtime.baseEditor.propertyEditor.PropertyEditorFactory

Factory for the creation of BasePropertyEditor instances.

sap.ui.integration.designtime.baseEditor.propertyEditor.arrayEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.booleanEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.dateEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.dateTimeEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.enumStringEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.groupEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.iconEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.integerEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.jsonEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.listEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.mapEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.numberEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.selectEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.separatorEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.stringEditor
sap.ui.integration.designtime.baseEditor.propertyEditor.textAreaEditor

Methods Overview

Method Description
Description beforeValueChange

Fires before the value of the nested property editor changes

configChange

Fires when config changes.

designtimeMetadataChange

Fires when the designtime metadata of the nested property editor changes

editorChange

Fires when the new editor changes.

init

Fires when the wrapper is initialized.

propertyEditorChange

Fires when the internal property editor changes, e.g. called after the initial initialization or after changing the propertyName or config properties.

propertyNameChange

Fires when propertyName changes.

ready

Fires when nested property editor is ready.

validationErrorChange

Fires when the error state of the nested property editor changes

valueChange

Fires when the value of the nested property editor changes

beforeValueChange

Fires before the value of the nested property editor changes

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
path string
value any
nextValue any

configChange

Fires when config changes.

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

designtimeMetadataChange

Fires when the designtime metadata of the nested property editor changes

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
path string
value any
previousValue any

editorChange

Fires when the new editor changes.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
previousEditor sap.ui.integration.designtime.baseEditor.BaseEditor
editor sap.ui.integration.designtime.baseEditor.BaseEditor

init

Fires when the wrapper is initialized.

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

propertyEditorChange

Fires when the internal property editor changes, e.g. called after the initial initialization or after changing the propertyName or config properties.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
previousPropertyEditor sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor
propertyEditor sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor

propertyNameChange

Fires when propertyName changes.

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

ready

Fires when nested property editor is ready.

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

validationErrorChange

Fires when the error state of the nested property editor changes

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

Whether there is an error in the nested editor

Since: 1.96.0.

valueChange

Fires when the value of the nested property editor changes

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
path string
value any
previousValue any

Methods Overview

Method Description
attachBeforeValueChange

Attaches event handler fnFunction to the beforeValueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires before the value of the nested property editor changes

attachConfigChange

Attaches event handler fnFunction to the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when config changes.

attachDesigntimeMetadataChange

Attaches event handler fnFunction to the designtimeMetadataChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the designtime metadata of the nested property editor changes

attachEditorChange

Attaches event handler fnFunction to the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the new editor changes.

attachInit

Attaches event handler fnFunction to the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the wrapper is initialized.

attachPropertyEditorChange

Attaches event handler fnFunction to the propertyEditorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the internal property editor changes, e.g. called after the initial initialization or after changing the propertyName or config properties.

attachPropertyNameChange

Attaches event handler fnFunction to the propertyNameChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when propertyName changes.

attachReady

Attaches event handler fnFunction to the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when nested property editor is ready.

attachValidationErrorChange

Attaches event handler fnFunction to the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the error state of the nested property editor changes

attachValueChange

Attaches event handler fnFunction to the valueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the value of the nested property editor changes

detachBeforeValueChange

Detaches event handler fnFunction from the beforeValueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachConfigChange

Detaches event handler fnFunction from the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachDesigntimeMetadataChange

Detaches event handler fnFunction from the designtimeMetadataChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachEditorChange

Detaches event handler fnFunction from the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachInit

Detaches event handler fnFunction from the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachPropertyEditorChange

Detaches event handler fnFunction from the propertyEditorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachPropertyNameChange

Detaches event handler fnFunction from the propertyNameChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachReady

Detaches event handler fnFunction from the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachValidationErrorChange

Detaches event handler fnFunction from the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachValueChange

Detaches event handler fnFunction from the valueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

sap.ui.integration.designtime.baseEditor.PropertyEditor.extend

Creates a new subclass of class sap.ui.integration.designtime.baseEditor.PropertyEditor 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.

fireBeforeValueChange

Fires event beforeValueChange to attached listeners.

fireConfigChange

Fires event configChange to attached listeners.

fireDesigntimeMetadataChange

Fires event designtimeMetadataChange to attached listeners.

fireEditorChange

Fires event editorChange to attached listeners.

fireInit

Fires event init to attached listeners.

firePropertyEditorChange

Fires event propertyEditorChange to attached listeners.

firePropertyNameChange

Fires event propertyNameChange to attached listeners.

fireReady

Fires event ready to attached listeners.

fireValidationErrorChange

Fires event validationErrorChange to attached listeners.

fireValueChange

Fires event valueChange to attached listeners.

getConfig

Gets current value of property config.

Custom configuration object. If set, it has priority over propertyName. Example:

{
    "label": "My property",
    "type": "string",
    "path": "header/status/text"
}
Where:
  • label = text string for the property editor label
  • type = one of the registered property editor types in BaseEditor configuration (see propertyEditors section)
  • path = a binding path to get data from

getEditor

ID of the element which is the current target of the association editor, or null.

sap.ui.integration.designtime.baseEditor.PropertyEditor.getMetadata

Returns a metadata object for class sap.ui.integration.designtime.baseEditor.PropertyEditor.

getPropertyName

Gets current value of property propertyName.

Property name for which the configuration should be retrieved. The configuration for a specified name will be taken from the BaseEditor directly.

getRenderLabel

Gets current value of property renderLabel.

Indicates whether the embedded BasePropertyEditor should render its label.

getValue

Gets current value of property value.

Nested editor value

setConfig

Sets a new value for property config.

Custom configuration object. If set, it has priority over propertyName. Example:

{
    "label": "My property",
    "type": "string",
    "path": "header/status/text"
}
Where:
  • label = text string for the property editor label
  • type = one of the registered property editor types in BaseEditor configuration (see propertyEditors section)
  • path = a binding path to get data from

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

setEditor

Sets the associated editor.

setPropertyName

Sets a new value for property propertyName.

Property name for which the configuration should be retrieved. The configuration for a specified name will be taken from the BaseEditor directly.

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

setRenderLabel

Sets a new value for property renderLabel.

Indicates whether the embedded BasePropertyEditor should render its label.

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

setValue

Sets a new value for property value.

Nested editor value

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

attachBeforeValueChange

Attaches event handler fnFunction to the beforeValueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires before the value of the nested property editor changes

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.designtime.baseEditor.PropertyEditor itself

attachConfigChange

Attaches event handler fnFunction to the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when config changes.

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.designtime.baseEditor.PropertyEditor itself

attachDesigntimeMetadataChange

Attaches event handler fnFunction to the designtimeMetadataChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the designtime metadata of the nested property editor changes

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.designtime.baseEditor.PropertyEditor itself

attachEditorChange

Attaches event handler fnFunction to the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the new editor changes.

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.designtime.baseEditor.PropertyEditor itself

attachInit

Attaches event handler fnFunction to the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the wrapper is initialized.

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.designtime.baseEditor.PropertyEditor itself

attachPropertyEditorChange

Attaches event handler fnFunction to the propertyEditorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the internal property editor changes, e.g. called after the initial initialization or after changing the propertyName or config properties.

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.designtime.baseEditor.PropertyEditor itself

attachPropertyNameChange

Attaches event handler fnFunction to the propertyNameChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when propertyName changes.

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.designtime.baseEditor.PropertyEditor itself

attachReady

Attaches event handler fnFunction to the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when nested property editor is ready.

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.designtime.baseEditor.PropertyEditor itself

attachValidationErrorChange

Attaches event handler fnFunction to the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the error state of the nested property editor changes

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.designtime.baseEditor.PropertyEditor itself

attachValueChange

Attaches event handler fnFunction to the valueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor itself.

Fires when the value of the nested property editor changes

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.designtime.baseEditor.PropertyEditor itself

detachBeforeValueChange

Detaches event handler fnFunction from the beforeValueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachConfigChange

Detaches event handler fnFunction from the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachDesigntimeMetadataChange

Detaches event handler fnFunction from the designtimeMetadataChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachEditorChange

Detaches event handler fnFunction from the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachInit

Detaches event handler fnFunction from the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachPropertyEditorChange

Detaches event handler fnFunction from the propertyEditorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachPropertyNameChange

Detaches event handler fnFunction from the propertyNameChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachReady

Detaches event handler fnFunction from the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachValidationErrorChange

Detaches event handler fnFunction from the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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

detachValueChange

Detaches event handler fnFunction from the valueChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditor.

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.designtime.baseEditor.PropertyEditor.extend

Creates a new subclass of class sap.ui.integration.designtime.baseEditor.PropertyEditor 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

fireBeforeValueChange

Fires event beforeValueChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

path string
value any
nextValue any

fireConfigChange

Fires event configChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

previousConfig object
config object

fireDesigntimeMetadataChange

Fires event designtimeMetadataChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

path string
value any
previousValue any

fireEditorChange

Fires event editorChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

previousEditor sap.ui.integration.designtime.baseEditor.BaseEditor
editor sap.ui.integration.designtime.baseEditor.BaseEditor

fireInit

Fires event init to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

firePropertyEditorChange

Fires event propertyEditorChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

previousPropertyEditor sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor
propertyEditor sap.ui.integration.designtime.baseEditor.propertyEditor.BasePropertyEditor

firePropertyNameChange

Fires event propertyNameChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

previousPropertyName string
propertyName string

fireReady

Fires event ready to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireValidationErrorChange

Fires event validationErrorChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

hasError boolean

Whether there is an error in the nested editor

fireValueChange

Fires event valueChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

path string
value any
previousValue any

getConfig

Gets current value of property config.

Custom configuration object. If set, it has priority over propertyName. Example:

{
    "label": "My property",
    "type": "string",
    "path": "header/status/text"
}
Where:

getEditor

ID of the element which is the current target of the association editor, or null.

sap.ui.integration.designtime.baseEditor.PropertyEditor.getMetadata

Returns a metadata object for class sap.ui.integration.designtime.baseEditor.PropertyEditor.

getPropertyName

Gets current value of property propertyName.

Property name for which the configuration should be retrieved. The configuration for a specified name will be taken from the BaseEditor directly.

getRenderLabel

Gets current value of property renderLabel.

Indicates whether the embedded BasePropertyEditor should render its label.

getValue

Gets current value of property value.

Nested editor value

setConfig

Sets a new value for property config.

Custom configuration object. If set, it has priority over propertyName. Example:

{
    "label": "My property",
    "type": "string",
    "path": "header/status/text"
}
Where:

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

Param Type DefaultValue Description
oConfig object

New value for property config

setEditor

Sets the associated editor.

Param Type DefaultValue Description
oEditor sap.ui.core.ID sap.ui.integration.designtime.baseEditor.BaseEditor

ID of an element which becomes the new target of this editor association; alternatively, an element instance may be given

setPropertyName

Sets a new value for property propertyName.

Property name for which the configuration should be retrieved. The configuration for a specified name will be taken from the BaseEditor directly.

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

Param Type DefaultValue Description
sPropertyName string

New value for property propertyName

setRenderLabel

Sets a new value for property renderLabel.

Indicates whether the embedded BasePropertyEditor should render its label.

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

Param Type DefaultValue Description
bRenderLabel boolean

New value for property renderLabel

setValue

Sets a new value for property value.

Nested editor value

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

Param Type DefaultValue Description
oValue any

New value for property value