class sap.ui.core.ComponentContainer

Visiblity: public
UX Guidelines:
Implements: sap.ui.core.IPlaceholderSupport
Available since: N/A
Module: sap/ui/core/ComponentContainer
Application Component: CA-UI5-COR

Container that embeds a sap/ui/core/UIComponent in a control tree.

Concerning asynchronous component loading:

To activate a fully asynchronous loading behavior of components and their dependencies, the property async needs to be set to true and the manifest property needs to be set to a 'truthy' value, e.g. true or a URL to the manifest location. If both options are correctly set, the component factory will load and evaluate the component manifest first. In this way, the additional dependencies of the Component are already known before the Component preload/controller is loaded. Both the component preload/controller and the additional dependencies can thus be loaded asynchronously and in parallel.

Sample usage of the ComponentContainer:

    <!-- inside XML view -->
    ...
    <core:ComponentContainer
        usage="someComponent"
        manifest="true"
        async="true"
    />

See also module:sap/ui/core/ComponentSupport.


Constructor

Constructor for a new ComponentContainer.

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.core.ComponentContainer(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


Properties

Name Type Default Value Description
async boolean false

Flag whether the component should be created sync (default) or async. The default will be async when initially the property manifest is set to a truthy value and for the property async no value has been specified. This property can only be applied initially.

Visibility: public
autoPrefixId boolean false

Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash. This property can only be applied initially.

Visibility: public
handleValidation boolean false

Enable/disable validation handling by MessageManager for this component. The resulting Messages will be propagated to the controls. This property can only be applied initially.

Visibility: public
height sap.ui.core.CSSSize

Container height in CSS size

Visibility: public
lifecycle sap.ui.core.ComponentLifecycle Legacy

Lifecycle behavior for the Component associated by the ComponentContainer. The default behavior is Legacy. This means that the ComponentContainer takes care that the Component is destroyed when the ComponentContainer is destroyed, but it is not destroyed when a new Component is associated. If you use the usage property to create the Component, the default behavior is Container. This means that the Component is destroyed when the ComponentContainer is destroyed or a new Component is associated. This property must only be applied before a component instance is created.

Visibility: public
manifest any

Controls when and from where to load the manifest for the Component. When set to any truthy value, the manifest will be loaded asynchronously by default and evaluated before the Component controller, if it is set to a falsy value other than undefined, the manifest will be loaded after the controller. A non-empty string value will be interpreted as the URL location from where to load the manifest. A non-null object value will be interpreted as manifest content. This property can only be applied initially.

Visibility: public
name string

Component name, the package where the component is contained. This property can only be applied initially.

Visibility: public
propagateModel boolean false

Defines whether binding information is propagated to the component.

Visibility: public
settings object

The settings object passed to the component when created. This property can only be applied initially.

Visibility: public
url sap.ui.core.URI

The URL of the component. This property can only be applied initially.

Visibility: public
usage string

The name of a component usage as configured in the app descriptor of the component owning this ComponentContainer.

The configuration from the named usage will be used to create a component instance for this ComponentContainer. If there's no owning component or if its app descriptor does not contain a usage with the given name, an error will be logged.

See Using and Nesting Components for more information about component usages.

This property can only be applied initially.

Visibility: public
width sap.ui.core.CSSSize

Container width in CSS size

Visibility: public

Borrowed Properties

Name Type Default Value Description
blocked boolean false

Whether the control is currently in blocked state.

Visibility: public
busy boolean false

Whether the control is currently in busy state.

Visibility: public
busyIndicatorDelay int 1000

The delay in milliseconds, after which the busy indicator will show up for this control.

Visibility: public
busyIndicatorSize sap.ui.core.BusyIndicatorSize Medium

The size of the BusyIndicator. For controls with a width smaller 3rem a sap.ui.core.BusyIndicatorSize.Small should be used. If the size could vary in width and the width could get smaller than 3rem, the sap.ui.core.BusyIndicatorSize.Auto option could be used. The default is set to sap.ui.core.BusyIndicatorSize.Medium For a full screen BusyIndicator use sap.ui.core.BusyIndicatorSize.Large.

Since: 1.54.

Visibility: public
fieldGroupIds string[]

The IDs of a logical field group that this control belongs to.

All fields in a logical field group should share the same fieldGroupId. Once a logical field group is left, the validateFieldGroup event is fired.

For backward compatibility with older releases, field group IDs are syntactically not limited, but it is suggested to use only valid sap.ui.core.IDs.

See #attachValidateFieldGroup or consult the Field Group documentation.

Since: 1.31.

Visibility: public
visible boolean true

Whether the control should be visible on the screen.

If set to false, a placeholder will be rendered to mark the location of the invisible control in the DOM of the current page. The placeholder will be hidden and have zero dimensions (display: none).

Also see InvisibleRenderer.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
customData 0..n sap.ui.core.CustomData

Custom Data, a data structure like a map containing arbitrary key value pairs.

dependents 0..n sap.ui.core.Element

Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element.

Since: 1.19.

dragDropConfig 0..n sap.ui.core.dnd.DragDropBase

Defines the drag-and-drop configuration. Note: This configuration might be ignored due to control metadata restrictions.

Since: 1.56.

layoutData 0..1 sap.ui.core.LayoutData

Defines the layout constraints for this control when it is used inside a Layout. LayoutData classes are typed classes and must match the embedding Layout. See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element.

tooltip 0..1 sap.ui.core.TooltipBase

The tooltip that should be shown for this Element.

In the most simple case, a tooltip is a string that will be rendered by the control and displayed by the browser when the mouse pointer hovers over the control's DOM. In this variant, tooltip behaves like a simple control property.

Controls need to explicitly support this kind of tooltip as they have to render it, but most controls do. Exceptions will be documented for the corresponding controls (e.g. sap.ui.core.HTML does not support tooltips).

Alternatively, tooltip can act like a 0..1 aggregation and can be set to a tooltip control (an instance of a subclass of sap.ui.core.TooltipBase). In that case, the framework will take care of rendering the tooltip control in a popup-like manner. Such a tooltip control can display arbitrary content, not only a string.

UI5 currently does not provide a recommended implementation of TooltipBase as the use of content-rich tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of TooltipBase therefore have been deprecated. However, apps can still subclass from TooltipBase and create their own implementation when needed (potentially taking the deprecated implementations as a starting point).

See the section Using Tooltips in the Fiori Design Guideline.


Associations

Name Cardinality Type Description
component 0..1 sap.ui.core.UIComponent

The component displayed in this ComponentContainer.


Events Overview

Event Description
componentCreated

Fired when the component instance has been created by the ComponentContainer.

Since: 1.50.

componentFailed

Fired when the creation of the component instance has failed.

By default, the ComponentContainer also logs the error that occurred. Since 1.83, this default behavior can be prevented by calling preventDefault() on the event object.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object.

Since: 1.60.

componentCreated

Fired when the component instance has been created by the ComponentContainer.

Since: 1.50.

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

Reference to the created component instance

componentFailed

Fired when the creation of the component instance has failed.

By default, the ComponentContainer also logs the error that occurred. Since 1.83, this default behavior can be prevented by calling preventDefault() on the event object.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object.

Since: 1.60.

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

The reason object as returned by the component promise


Methods Overview

Method Description
attachComponentCreated

Attaches event handler fnFunction to the componentCreated event of this sap.ui.core.ComponentContainer.

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.core.ComponentContainer itself.

Fired when the component instance has been created by the ComponentContainer.

attachComponentFailed

Attaches event handler fnFunction to the componentFailed event of this sap.ui.core.ComponentContainer.

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.core.ComponentContainer itself.

Fired when the creation of the component instance has failed.

By default, the ComponentContainer also logs the error that occurred. Since 1.83, this default behavior can be prevented by calling preventDefault() on the event object.

detachComponentCreated

Detaches event handler fnFunction from the componentCreated event of this sap.ui.core.ComponentContainer.

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

detachComponentFailed

Detaches event handler fnFunction from the componentFailed event of this sap.ui.core.ComponentContainer.

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

sap.ui.core.ComponentContainer.extend

Creates a new subclass of class sap.ui.core.ComponentContainer 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.

fireComponentCreated

Fires event componentCreated to attached listeners.

fireComponentFailed

Fires event componentFailed to attached listeners.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object. The return value of this method indicates whether the default action should be executed.

getAsync

Gets current value of property async.

Flag whether the component should be created sync (default) or async. The default will be async when initially the property manifest is set to a truthy value and for the property async no value has been specified. This property can only be applied initially.

Default value is false.

getAutoPrefixId

Gets current value of property autoPrefixId.

Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash. This property can only be applied initially.

Default value is false.

getComponent

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

getHandleValidation

Gets current value of property handleValidation.

Enable/disable validation handling by MessageManager for this component. The resulting Messages will be propagated to the controls. This property can only be applied initially.

Default value is false.

getHeight

Gets current value of property height.

Container height in CSS size

getLifecycle

Gets current value of property lifecycle.

Lifecycle behavior for the Component associated by the ComponentContainer. The default behavior is Legacy. This means that the ComponentContainer takes care that the Component is destroyed when the ComponentContainer is destroyed, but it is not destroyed when a new Component is associated. If you use the usage property to create the Component, the default behavior is Container. This means that the Component is destroyed when the ComponentContainer is destroyed or a new Component is associated. This property must only be applied before a component instance is created.

Default value is Legacy.

getManifest

Gets current value of property manifest.

Controls when and from where to load the manifest for the Component. When set to any truthy value, the manifest will be loaded asynchronously by default and evaluated before the Component controller, if it is set to a falsy value other than undefined, the manifest will be loaded after the controller. A non-empty string value will be interpreted as the URL location from where to load the manifest. A non-null object value will be interpreted as manifest content. This property can only be applied initially.

sap.ui.core.ComponentContainer.getMetadata

Returns a metadata object for class sap.ui.core.ComponentContainer.

getName

Gets current value of property name.

Component name, the package where the component is contained. This property can only be applied initially.

getPropagateModel

Gets current value of property propagateModel.

Defines whether binding information is propagated to the component.

Default value is false.

getSettings

Gets current value of property settings.

The settings object passed to the component when created. This property can only be applied initially.

getUrl

Gets current value of property url.

The URL of the component. This property can only be applied initially.

getUsage

Gets current value of property usage.

The name of a component usage as configured in the app descriptor of the component owning this ComponentContainer.

The configuration from the named usage will be used to create a component instance for this ComponentContainer. If there's no owning component or if its app descriptor does not contain a usage with the given name, an error will be logged.

See Using and Nesting Components for more information about component usages.

This property can only be applied initially.

getWidth

Gets current value of property width.

Container width in CSS size

hidePlaceholder

Hides the placeholder that is shown on the component container.

setAsync

Sets a new value for property async.

Flag whether the component should be created sync (default) or async. The default will be async when initially the property manifest is set to a truthy value and for the property async no value has been specified. This property can only be applied initially.

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

Default value is false.

setAutoPrefixId

Sets a new value for property autoPrefixId.

Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash. This property can only be applied initially.

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

Default value is false.

setComponent

Sets the component of the container. Depending on the ComponentContainer's lifecycle this might destroy the old associated Component.

Once the component is associated with the container the cross connection to the component will be set and the models will be propagated if defined. If the usage property is set the ComponentLifecycle is processed like a "Container" lifecycle.

setHandleValidation

Sets a new value for property handleValidation.

Enable/disable validation handling by MessageManager for this component. The resulting Messages will be propagated to the controls. This property can only be applied initially.

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

Default value is false.

setHeight

Sets a new value for property height.

Container height in CSS size

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

setLifecycle

Sets a new value for property lifecycle.

Lifecycle behavior for the Component associated by the ComponentContainer. The default behavior is Legacy. This means that the ComponentContainer takes care that the Component is destroyed when the ComponentContainer is destroyed, but it is not destroyed when a new Component is associated. If you use the usage property to create the Component, the default behavior is Container. This means that the Component is destroyed when the ComponentContainer is destroyed or a new Component is associated. This property must only be applied before a component instance is created.

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

Default value is Legacy.

setManifest

Sets a new value for property manifest.

Controls when and from where to load the manifest for the Component. When set to any truthy value, the manifest will be loaded asynchronously by default and evaluated before the Component controller, if it is set to a falsy value other than undefined, the manifest will be loaded after the controller. A non-empty string value will be interpreted as the URL location from where to load the manifest. A non-null object value will be interpreted as manifest content. This property can only be applied initially.

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

setName

Sets a new value for property name.

Component name, the package where the component is contained. This property can only be applied initially.

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

setPropagateModel

Sets a new value for property propagateModel.

Defines whether binding information is propagated to the component.

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

Default value is false.

setSettings

Sets a new value for property settings.

The settings object passed to the component when created. This property can only be applied initially.

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

setUrl

Sets a new value for property url.

The URL of the component. This property can only be applied initially.

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

setUsage

Sets a new value for property usage.

The name of a component usage as configured in the app descriptor of the component owning this ComponentContainer.

The configuration from the named usage will be used to create a component instance for this ComponentContainer. If there's no owning component or if its app descriptor does not contain a usage with the given name, an error will be logged.

See Using and Nesting Components for more information about component usages.

This property can only be applied initially.

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

setWidth

Sets a new value for property width.

Container width in CSS size

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

showPlaceholder

Shows the provided placeholder on the component container.

attachComponentCreated

Attaches event handler fnFunction to the componentCreated event of this sap.ui.core.ComponentContainer.

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.core.ComponentContainer itself.

Fired when the component instance has been created by the ComponentContainer.

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.core.ComponentContainer itself

attachComponentFailed

Attaches event handler fnFunction to the componentFailed event of this sap.ui.core.ComponentContainer.

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.core.ComponentContainer itself.

Fired when the creation of the component instance has failed.

By default, the ComponentContainer also logs the error that occurred. Since 1.83, this default behavior can be prevented by calling preventDefault() on the event object.

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.core.ComponentContainer itself

detachComponentCreated

Detaches event handler fnFunction from the componentCreated event of this sap.ui.core.ComponentContainer.

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

detachComponentFailed

Detaches event handler fnFunction from the componentFailed event of this sap.ui.core.ComponentContainer.

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.core.ComponentContainer.extend

Creates a new subclass of class sap.ui.core.ComponentContainer 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

fireComponentCreated

Fires event componentCreated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

component sap.ui.core.UIComponent

Reference to the created component instance

fireComponentFailed

Fires event componentFailed to attached listeners.

Listeners may prevent the default action of this event by calling the preventDefault method on the event object. The return value of this method indicates whether the default action should be executed.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

reason object

The reason object as returned by the component promise

getAsync

Gets current value of property async.

Flag whether the component should be created sync (default) or async. The default will be async when initially the property manifest is set to a truthy value and for the property async no value has been specified. This property can only be applied initially.

Default value is false.

getAutoPrefixId

Gets current value of property autoPrefixId.

Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash. This property can only be applied initially.

Default value is false.

getComponent

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

getHandleValidation

Gets current value of property handleValidation.

Enable/disable validation handling by MessageManager for this component. The resulting Messages will be propagated to the controls. This property can only be applied initially.

Default value is false.

getHeight

Gets current value of property height.

Container height in CSS size

getLifecycle

Gets current value of property lifecycle.

Lifecycle behavior for the Component associated by the ComponentContainer. The default behavior is Legacy. This means that the ComponentContainer takes care that the Component is destroyed when the ComponentContainer is destroyed, but it is not destroyed when a new Component is associated. If you use the usage property to create the Component, the default behavior is Container. This means that the Component is destroyed when the ComponentContainer is destroyed or a new Component is associated. This property must only be applied before a component instance is created.

Default value is Legacy.

getManifest

Gets current value of property manifest.

Controls when and from where to load the manifest for the Component. When set to any truthy value, the manifest will be loaded asynchronously by default and evaluated before the Component controller, if it is set to a falsy value other than undefined, the manifest will be loaded after the controller. A non-empty string value will be interpreted as the URL location from where to load the manifest. A non-null object value will be interpreted as manifest content. This property can only be applied initially.

sap.ui.core.ComponentContainer.getMetadata

Returns a metadata object for class sap.ui.core.ComponentContainer.

getName

Gets current value of property name.

Component name, the package where the component is contained. This property can only be applied initially.

getPropagateModel

Gets current value of property propagateModel.

Defines whether binding information is propagated to the component.

Default value is false.

getSettings

Gets current value of property settings.

The settings object passed to the component when created. This property can only be applied initially.

getUrl

Gets current value of property url.

The URL of the component. This property can only be applied initially.

getUsage

Gets current value of property usage.

The name of a component usage as configured in the app descriptor of the component owning this ComponentContainer.

The configuration from the named usage will be used to create a component instance for this ComponentContainer. If there's no owning component or if its app descriptor does not contain a usage with the given name, an error will be logged.

See Using and Nesting Components for more information about component usages.

This property can only be applied initially.

getWidth

Gets current value of property width.

Container width in CSS size

hidePlaceholder

Hides the placeholder that is shown on the component container.

setAsync

Sets a new value for property async.

Flag whether the component should be created sync (default) or async. The default will be async when initially the property manifest is set to a truthy value and for the property async no value has been specified. This property can only be applied initially.

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

Default value is false.

Param Type DefaultValue Description
bAsync boolean false

New value for property async

setAutoPrefixId

Sets a new value for property autoPrefixId.

Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash. This property can only be applied initially.

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

Default value is false.

Param Type DefaultValue Description
bAutoPrefixId boolean false

New value for property autoPrefixId

setComponent

Sets the component of the container. Depending on the ComponentContainer's lifecycle this might destroy the old associated Component.

Once the component is associated with the container the cross connection to the component will be set and the models will be propagated if defined. If the usage property is set the ComponentLifecycle is processed like a "Container" lifecycle.

Param Type DefaultValue Description
vComponent string sap.ui.core.UIComponent

ID of an element which becomes the new target of this component association. Alternatively, an element instance may be given.

setHandleValidation

Sets a new value for property handleValidation.

Enable/disable validation handling by MessageManager for this component. The resulting Messages will be propagated to the controls. This property can only be applied initially.

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

Default value is false.

Param Type DefaultValue Description
bHandleValidation boolean false

New value for property handleValidation

setHeight

Sets a new value for property height.

Container height in CSS size

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

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

New value for property height

setLifecycle

Sets a new value for property lifecycle.

Lifecycle behavior for the Component associated by the ComponentContainer. The default behavior is Legacy. This means that the ComponentContainer takes care that the Component is destroyed when the ComponentContainer is destroyed, but it is not destroyed when a new Component is associated. If you use the usage property to create the Component, the default behavior is Container. This means that the Component is destroyed when the ComponentContainer is destroyed or a new Component is associated. This property must only be applied before a component instance is created.

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

Default value is Legacy.

Param Type DefaultValue Description
sLifecycle sap.ui.core.ComponentLifecycle Legacy

New value for property lifecycle

setManifest

Sets a new value for property manifest.

Controls when and from where to load the manifest for the Component. When set to any truthy value, the manifest will be loaded asynchronously by default and evaluated before the Component controller, if it is set to a falsy value other than undefined, the manifest will be loaded after the controller. A non-empty string value will be interpreted as the URL location from where to load the manifest. A non-null object value will be interpreted as manifest content. This property can only be applied initially.

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

Param Type DefaultValue Description
oManifest any

New value for property manifest

setName

Sets a new value for property name.

Component name, the package where the component is contained. This property can only be applied initially.

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

Param Type DefaultValue Description
sName string

New value for property name

setPropagateModel

Sets a new value for property propagateModel.

Defines whether binding information is propagated to the component.

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

Default value is false.

Param Type DefaultValue Description
bPropagateModel boolean false

New value for property propagateModel

setSettings

Sets a new value for property settings.

The settings object passed to the component when created. This property can only be applied initially.

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

Param Type DefaultValue Description
oSettings object

New value for property settings

setUrl

Sets a new value for property url.

The URL of the component. This property can only be applied initially.

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

Param Type DefaultValue Description
sUrl sap.ui.core.URI

New value for property url

setUsage

Sets a new value for property usage.

The name of a component usage as configured in the app descriptor of the component owning this ComponentContainer.

The configuration from the named usage will be used to create a component instance for this ComponentContainer. If there's no owning component or if its app descriptor does not contain a usage with the given name, an error will be logged.

See Using and Nesting Components for more information about component usages.

This property can only be applied initially.

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

Param Type DefaultValue Description
sUsage string

New value for property usage

setWidth

Sets a new value for property width.

Container width in CSS size

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

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize

New value for property width

showPlaceholder

Shows the provided placeholder on the component container.

Param Type DefaultValue Description
mSettings object

Object containing the placeholder object

placeholder sap.ui.core.Placeholder

The placeholder instance