Renders a group of property editors based on specified tags
or custom config
.
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.designtime.baseEditor.PropertyEditors()
Name | Type | Default Value | Description |
---|---|---|---|
config | array | An array of custom configuration objects. If set, it has priority over [ { "label": "My property 1", "type": "string", "path": "path/to/my/property1" }, { "label": "My property 2", "type": "string", "path": "path/to/my/property2" } ]Where:
|
|
layout | string | list | Visibility: public |
layoutConfig | object | Visibility: public | |
renderLabels | boolean | Indicates whether the embedded |
|
tags | string | List of tags to render, e.g. |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
content | 0..1 | sap.ui.core.Control |
Name | Cardinality | Type | Description |
---|---|---|---|
editor | 0..1 | sap.ui.integration.designtime.baseEditor.BaseEditor | |
propertyEditors | 0..1 | sap.ui.integration.designtime.baseEditor.PropertyEditor |
Event | Description |
---|---|
configChange |
Fires when |
editorChange |
Fires when the new editor changes. |
init |
Fires when the wrapper is initialized. |
layoutChange |
Fires when |
layoutConfigChange |
Fires when |
propertyEditorsChange |
Fires when the internal |
ready |
Fires when the nested editors are ready |
tagsChange |
Fires when |
validationErrorChange |
Fires when the error state of one of the nested property editors changes |
Fires when config
changes.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
previousConfig | array | |
config | array |
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 |
Fires when the wrapper is initialized.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Fires when layout
changes.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
previousLayout | string | |
layout | string |
Fires when layoutConfig
changes.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
previousLayoutConfig | object | |
layoutConfig | object |
Fires when the internal propertyEditors
aggregation changes, e.g. called after the initial initialization or after changing tag
or config
properties.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
previousPropertyEditors | sap.ui.integration.designtime.baseEditor.PropertyEditor | |
propertyEditors | sap.ui.integration.designtime.baseEditor.PropertyEditor |
Fires when the nested editors are ready
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Method | Description |
---|---|
attachConfigChange |
Attaches event handler When called, the context of the event handler (its Fires when |
attachEditorChange |
Attaches event handler When called, the context of the event handler (its Fires when the new editor changes. |
attachInit |
Attaches event handler When called, the context of the event handler (its Fires when the wrapper is initialized. |
attachLayoutChange |
Attaches event handler When called, the context of the event handler (its Fires when |
attachLayoutConfigChange |
Attaches event handler When called, the context of the event handler (its Fires when |
attachPropertyEditorsChange |
Attaches event handler When called, the context of the event handler (its Fires when the internal |
attachReady |
Attaches event handler When called, the context of the event handler (its Fires when the nested editors are ready |
attachTagsChange |
Attaches event handler When called, the context of the event handler (its Fires when |
attachValidationErrorChange |
Attaches event handler When called, the context of the event handler (its Fires when the error state of one of the nested property editors changes |
destroyContent |
Destroys the content in the aggregation content. |
detachConfigChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachEditorChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachInit |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachLayoutChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachLayoutConfigChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachPropertyEditorsChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachReady |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachTagsChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachValidationErrorChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.integration.designtime.baseEditor.PropertyEditors.extend |
Creates a new subclass of class sap.ui.integration.designtime.baseEditor.PropertyEditors with name
|
fireConfigChange |
Fires event configChange to attached listeners. |
fireEditorChange |
Fires event editorChange to attached listeners. |
fireInit |
Fires event init to attached listeners. |
fireLayoutChange |
Fires event layoutChange to attached listeners. |
fireLayoutConfigChange |
Fires event layoutConfigChange to attached listeners. |
firePropertyEditorsChange |
Fires event propertyEditorsChange to attached listeners. |
fireReady |
Fires event ready to attached listeners. |
fireTagsChange |
Fires event tagsChange to attached listeners. |
fireValidationErrorChange |
Fires event validationErrorChange to attached listeners. |
getConfig |
Gets current value of property config. An array of custom configuration objects. If set, it has priority over [ { "label": "My property 1", "type": "string", "path": "path/to/my/property1" }, { "label": "My property 2", "type": "string", "path": "path/to/my/property2" } ]Where:
|
getContent |
Gets content of aggregation content. |
getEditor |
ID of the element which is the current target of the association editor, or |
getLayout |
Gets current value of property layout. Default value is |
getLayoutConfig |
Gets current value of property layoutConfig. |
sap.ui.integration.designtime.baseEditor.PropertyEditors.getMetadata |
Returns a metadata object for class sap.ui.integration.designtime.baseEditor.PropertyEditors. |
getRenderLabels |
Gets current value of property renderLabels. Indicates whether the embedded |
getTags |
Gets current value of property tags. List of tags to render, e.g. |
setConfig |
Sets a new value for property config. An array of custom configuration objects. If set, it has priority over [ { "label": "My property 1", "type": "string", "path": "path/to/my/property1" }, { "label": "My property 2", "type": "string", "path": "path/to/my/property2" } ]Where:
When called with a value of |
setContent |
Sets the aggregated content. |
setEditor |
Sets the associated editor. |
setLayout |
Sets a new value for property layout. When called with a value of Default value is |
setLayoutConfig |
Sets a new value for property layoutConfig. When called with a value of |
setRenderLabels |
Sets a new value for property renderLabels. Indicates whether the embedded When called with a value of |
setTags |
Sets a new value for property tags. List of tags to render, e.g. When called with a value of |
Attaches event handler fnFunction
to the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
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 |
Attaches event handler fnFunction
to the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
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 |
Attaches event handler fnFunction
to the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
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 |
Attaches event handler fnFunction
to the layoutChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when layout
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 |
Attaches event handler fnFunction
to the layoutConfigChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when layoutConfig
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 |
Attaches event handler fnFunction
to the propertyEditorsChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when the internal propertyEditors
aggregation changes, e.g. called after the initial initialization or after changing tag
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 |
Attaches event handler fnFunction
to the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when the nested editors are 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 |
Attaches event handler fnFunction
to the tagsChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when tags
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 |
Attaches event handler fnFunction
to the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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.PropertyEditors
itself.
Fires when the error state of one of the nested property editors 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 |
Detaches event handler fnFunction
from the configChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the editorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the init event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the layoutChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the layoutConfigChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the propertyEditorsChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the ready event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the tagsChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Detaches event handler fnFunction
from the validationErrorChange event of this sap.ui.integration.designtime.baseEditor.PropertyEditors
.
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 |
Creates a new subclass of class sap.ui.integration.designtime.baseEditor.PropertyEditors 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 |
Fires event configChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
previousConfig | array | ||
config | array |
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 |
Fires event init to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event layoutChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
previousLayout | string | ||
layout | string |
Fires event layoutConfigChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
previousLayoutConfig | object | ||
layoutConfig | object |
Fires event propertyEditorsChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
previousPropertyEditors | sap.ui.integration.designtime.baseEditor.PropertyEditor | ||
propertyEditors | sap.ui.integration.designtime.baseEditor.PropertyEditor |
Fires event ready to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event tagsChange to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
previousTags | string | ||
tags | string |
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 one of the nested editors |
Gets current value of property config.
An array of custom configuration objects. If set, it has priority over tags
. Example:
[ { "label": "My property 1", "type": "string", "path": "path/to/my/property1" }, { "label": "My property 2", "type": "string", "path": "path/to/my/property2" } ]Where:
propertyEditors
section)Returns a metadata object for class sap.ui.integration.designtime.baseEditor.PropertyEditors.
Gets current value of property renderLabels.
Indicates whether the embedded BasePropertyEditor
instances should render their labels.
Gets current value of property tags.
List of tags to render, e.g. "header,content"
. Only the properties that contain both tags will be rendered.
Sets a new value for property config.
An array of custom configuration objects. If set, it has priority over tags
. Example:
[ { "label": "My property 1", "type": "string", "path": "path/to/my/property1" }, { "label": "My property 2", "type": "string", "path": "path/to/my/property2" } ]Where:
propertyEditors
section)When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sConfig | array |
New value for property |
Sets the aggregated content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to set |
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 |
Sets a new value for property layout.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "list"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLayout | string | "list" |
New value for property |
Sets a new value for property layoutConfig.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLayoutConfig | object |
New value for property |
Sets a new value for property renderLabels.
Indicates whether the embedded BasePropertyEditor
instances should render their labels.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
bRenderLabels | boolean |
New value for property |
Sets a new value for property tags.
List of tags to render, e.g. "header,content"
. Only the properties that contain both tags will be rendered.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTags | string |
New value for property |