Overlay Control
Deprecated API:Since version 1.38.
Event Summary
close(oControlEvent)Event is fired when the Overlay starts closing. closed(oControlEvent)Event is fired when the Overlay is closed. open(oControlEvent)Event is fired when the Overlay is opened. openNew(oControlEvent)Event is fired when the 'Open' button of the Overlay is clicked. Method Summary
sap.ui.ux3.Overlay.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Overlay with name sClassName
and enriches it with the information contained in oClassInfo
. attachClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the close
event of this sap.ui.ux3.Overlay
. attachClosed(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the closed
event of this sap.ui.ux3.Overlay
. attachOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the open
event of this sap.ui.ux3.Overlay
. attachOpenNew(oData?, fnFunction, oListener?)Attaches event handler fnFunction
to the openNew
event of this sap.ui.ux3.Overlay
. close()Closes the Overlay. detachClose(fnFunction, oListener)Detaches event handler fnFunction
from the close
event of this sap.ui.ux3.Overlay
. detachClosed(fnFunction, oListener)Detaches event handler fnFunction
from the closed
event of this sap.ui.ux3.Overlay
. detachOpen(fnFunction, oListener)Detaches event handler fnFunction
from the open
event of this sap.ui.ux3.Overlay
. detachOpenNew(fnFunction, oListener)Detaches event handler fnFunction
from the openNew
event of this sap.ui.ux3.Overlay
. fireClose(mArguments?)Fires event close
to attached listeners. fireClosed(mArguments?)Fires event closed
to attached listeners. fireOpen(mArguments?)Fires event open
to attached listeners. fireOpenNew(mArguments?)Fires event openNew
to attached listeners. isOpen()Checks whether Overlay is open. open(initialFocusId)Opens the Overlay. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.ui.ux3.Overlay(sId?, mSettings?)
Constructor for a new Overlay.
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:
- Properties
- Events
- close : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- closed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- openNew : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- open : 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:
{string} | sId? | ID for the new control, generated automatically if no ID is given |
{object} | mSettings? | Initial settings for the new control |
- Deprecated:
- Since version 1.38.
Event Detail
close(oControlEvent)
Event is fired when the Overlay starts closing.
Parameters:
closed(oControlEvent)
Event is fired when the Overlay is closed.
Parameters:
open(oControlEvent)
Event is fired when the Overlay is opened.
Parameters:
openNew(oControlEvent)
Event is fired when the 'Open' button of the Overlay is clicked.
Parameters:
Method Detail
sap.ui.ux3.Overlay.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.Overlay 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:
{string} | sClassName | Name of the class being created |
{object} | oClassInfo? | Object literal with information about the class |
{function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
{function} | Created class / constructor function |
Returns a metadata object for class sap.ui.ux3.Overlay.
Returns:
Attaches event handler
fnFunction
to the
close
event of this
sap.ui.ux3.Overlay
.
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.ux3.Overlay
itself.
Event is fired when the Overlay starts closing.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay itself |
Returns:
Attaches event handler
fnFunction
to the
closed
event of this
sap.ui.ux3.Overlay
.
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.ux3.Overlay
itself.
Event is fired when the Overlay is closed.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay itself |
Returns:
Attaches event handler
fnFunction
to the
open
event of this
sap.ui.ux3.Overlay
.
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.ux3.Overlay
itself.
Event is fired when the Overlay is opened.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay itself |
Returns:
Attaches event handler
fnFunction
to the
openNew
event of this
sap.ui.ux3.Overlay
.
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.ux3.Overlay
itself.
Event is fired when the 'Open' button of the Overlay is clicked.
Parameters:
{object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
{function} | fnFunction | The function to be called when the event occurs |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.Overlay itself |
Returns:
close()
Closes the Overlay.
Detaches event handler
fnFunction
from the
close
event of this
sap.ui.ux3.Overlay
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
closed
event of this
sap.ui.ux3.Overlay
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
open
event of this
sap.ui.ux3.Overlay
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
Detaches event handler
fnFunction
from the
openNew
event of this
sap.ui.ux3.Overlay
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to be called, when the event occurs |
{object} | oListener | Context object on which the given function had to be called |
Returns:
fireClose(mArguments?): boolean
Fires event
close
to attached listeners.
Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
Expects the following event parameters:
id
of type string
The ID of the Overlay instance.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
{boolean} | Whether or not to prevent the default action |
fireClosed(mArguments?): boolean
Fires event
closed
to attached listeners.
Listeners may prevent the default action of this event by using the preventDefault
-method on the event object.
Expects the following event parameters:
id
of type string
The ID of the Overlay instance.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
{boolean} | Whether or not to prevent the default action |
Fires event
open
to attached listeners.
Expects the following event parameters:
id
of type string
The ID of the Overlay instance
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event
openNew
to attached listeners.
Expects the following event parameters:
id
of type string
The ID of the Overlay instance.
Parameters:
{Map} | mArguments? | The arguments to pass along with the event |
Returns:
getCloseButtonVisible(): boolean
Gets current value of property
closeButtonVisible
.
Defines whether the 'Close' button shall be visible.
Default value is true
.
Returns:
{boolean} | Value of property closeButtonVisible |
getOpenButtonVisible(): boolean
Gets current value of property
openButtonVisible
.
Defines whether the 'Open' button shall be visible.
Default value is true
.
Returns:
{boolean} | Value of property openButtonVisible |
isOpen(): boolean
Checks whether Overlay is open.
Returns:
open(initialFocusId)
Opens the Overlay.
Parameters:
{string} | initialFocusId | ID of the control that gets focused when the overlay is openend |
Sets a new value for property
closeButtonVisible
.
Defines whether the 'Close' button shall be visible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Parameters:
{boolean} | bCloseButtonVisible | New value for property closeButtonVisible |
Returns:
Sets a new value for property
openButtonVisible
.
Defines whether the 'Open' button shall be visible.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Parameters:
{boolean} | bOpenButtonVisible | New value for property openButtonVisible |
Returns: