Class sap.ui.unified.ShellOverlayModule: sap/ui/unified/ShellOverlay

extends Control

ShellOverlay to be opened in front of an sap.ui.unified.Shell
Deprecated API:
Since version 1.44.0.

Since: 1.16.3.
Constructor Summary
new sap.ui.unified.ShellOverlay(sId?, mSettings?)Constructor for a new ShellOverlay.
Event Summary
closed(oControlEvent)Fired when the overlay was closed.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.unified.ShellOverlay.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.ShellOverlay with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.ShellOverlay.getMetadata()Returns a metadata object for class sap.ui.unified.ShellOverlay.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
addContent(oContent)Adds some content to the aggregation content.
attachClosed(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the closed event of this sap.ui.unified.ShellOverlay.
close()Closes the ShellOverlay.
destroyContent()Destroys all the content in the aggregation content.
destroySearch()Destroys the search in the aggregation search.
detachClosed(fnFunction, oListener)Detaches event handler fnFunction from the closed event of this sap.ui.unified.ShellOverlay.
fireClosed(mParameters?)Fires event closed to attached listeners.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getContent()Gets content of aggregation content.
getSearch()Gets content of aggregation search.
getShell()ID of the element which is the current target of the association shell, or null.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
open()Opens the ShellOverlay.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAllContent()Removes all the controls from the aggregation content.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
removeContent(vContent)Removes a content from the aggregation content.
setSearch(oSearch)Sets the aggregated search.
setShell(oShell)Sets the associated shell.
Constructor Detail
new sap.ui.unified.ShellOverlay(sId?, mSettings?)

Constructor for a new ShellOverlay.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Aggregations

    • content : sap.ui.core.Control[] (default)
    • search : sap.ui.core.Control

  • Associations

    • shell : (sap.ui.core.ID | sap.ui.unified.ShellLayout)
    • ariaLabelledBy : (sap.ui.core.ID | sap.ui.core.Control)[]

  • Events

    • closed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
closed(oControlEvent)
Fired when the overlay was closed.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Method Detail
sap.ui.unified.ShellOverlay.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.unified.ShellOverlay.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.ShellOverlay.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.ui.unified.ShellOverlay
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
addContent(oContent): sap.ui.unified.ShellOverlay
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
attachClosed(oData?, fnFunction, oListener?): sap.ui.unified.ShellOverlay

Attaches event handler fnFunction to the closed event of this sap.ui.unified.ShellOverlay.

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.unified.ShellOverlay itself.

Fired when the overlay was closed.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.unified.ShellOverlay itself
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
close()
Closes the ShellOverlay.
destroyContent(): sap.ui.unified.ShellOverlay
Destroys all the content in the aggregation content.
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
destroySearch(): sap.ui.unified.ShellOverlay
Destroys the search in the aggregation search.
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
detachClosed(fnFunction, oListener): sap.ui.unified.ShellOverlay

Detaches event handler fnFunction from the closed event of this sap.ui.unified.ShellOverlay.

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

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
fireClosed(mParameters?): sap.ui.unified.ShellOverlay
Fires event closed to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

The content to appear in the overlay.

Returns:
sap.ui.core.Control[]
getSearch(): sap.ui.core.Control

Gets content of aggregation search.

Experimental (This aggregation might change in future!): The search control which should be displayed in the overlay header.

Returns:
sap.ui.core.Control
getShell(): sap.ui.core.ID
ID of the element which is the current target of the association shell, or null.
Returns:
sap.ui.core.ID
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.unified.ShellOverlay
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
open()
Opens the ShellOverlay.
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
int|string|sap.ui.core.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
setSearch(oSearch): sap.ui.unified.ShellOverlay
Sets the aggregated search.
Parameters:
sap.ui.core.ControloSearchThe search to set
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining
setShell(oShell): sap.ui.unified.ShellOverlay
Sets the associated shell.
Parameters:
sap.ui.core.ID|sap.ui.unified.ShellLayoutoShellID of an element which becomes the new target of this shell association; alternatively, an element instance may be given
Returns:
sap.ui.unified.ShellOverlayReference to this in order to allow method chaining