ShellOverlay to be opened in front of an sap.ui.unified.Shell
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#constructor for a general description of the syntax of the settings object.
new sap.ui.unified.ShellOverlay(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 |
Default Aggregation: content
Name | Cardinality | Type | Description |
---|---|---|---|
content (default) | 0..n | sap.ui.core.Control |
The content to appear in the overlay. |
search | 0..1 | sap.ui.core.Control |
Experimental (This aggregation might change in future!): The search control which should be displayed in the overlay header. |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). |
shell | 0..1 | sap.ui.unified.ShellLayout |
Reference to the sap.ui.unified.Shell or sap.ui.unified.ShellLayout control. |
Method | Description |
---|---|
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
addContent |
Adds some content to the aggregation content. |
attachClosed |
Attaches event handler When called, the context of the event handler (its Fired when the overlay was closed. |
close |
Closes the ShellOverlay. |
destroyContent |
Destroys all the content in the aggregation content. |
destroySearch |
Destroys the search in the aggregation search. |
detachClosed |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.unified.ShellOverlay.extend |
Creates a new subclass of class sap.ui.unified.ShellOverlay with name
|
fireClosed |
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. The content to appear in the overlay. |
sap.ui.unified.ShellOverlay.getMetadata |
Returns a metadata object for class sap.ui.unified.ShellOverlay. |
getSearch |
Gets content of aggregation search. Experimental (This aggregation might change in future!): The search control which should be displayed in the overlay header. |
getShell |
ID of the element which is the current target of the association shell, or |
indexOfContent |
Checks for the provided |
insertContent |
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. Additionally, it unregisters them from the hosting UIArea. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
removeContent |
Removes a content from the aggregation content. |
setSearch |
Sets the aggregated search. |
setShell |
Sets the associated shell. |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
Adds some content to the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to add; if empty, nothing is inserted |
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.
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 closed event of this sap.ui.unified.ShellOverlay
.
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.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.
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 closed to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns a metadata object for class sap.ui.unified.ShellOverlay.
Gets content of aggregation search.
Experimental (This aggregation might change in future!): The search control which should be displayed in the overlay header.
Checks for the provided sap.ui.core.Control
in the aggregation content. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content whose index is looked for |
Inserts a content into the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContent | sap.ui.core.Control |
The content to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
Removes a content from the aggregation content.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContent | int string sap.ui.core.Control |
The content to remove or its index or id |
Sets the aggregated search.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSearch | sap.ui.core.Control |
The search to set |
Sets the associated shell.
Param | Type | DefaultValue | Description |
---|---|---|---|
oShell | sap.ui.core.ID sap.ui.unified.ShellLayout |
ID of an element which becomes the new target of this shell association; alternatively, an element instance may be given |