Class sap.ui.ux3.OverlayDialogModule: sap/ui/ux3/OverlayDialog

extends Overlay

Dialog implementation based on the Overlay. If used in a Shell it leaves the Tool-Palette, Pane-Bar and Header-Items accessible.

Deprecated API:Since version 1.38.

Constructor Summary
new sap.ui.ux3.OverlayDialog(sId?, mSettings?)Constructor for a new OverlayDialog.
Events borrowed from class sap.ui.ux3.Overlay
close, closed, open, openNew
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.OverlayDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.OverlayDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.OverlayDialog.getMetadata()Returns a metadata object for class sap.ui.ux3.OverlayDialog.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
getHeight()Gets current value of property height.
getWidth()Gets current value of property width.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setHeight(sHeight)The height for the OverlayDialog.
setOpenButtonVisible(bVisible)This Method is not supported for the OverlayDialog.
setWidth(sWidth)The width for the OverlayDialog.
Methods borrowed from class sap.ui.ux3.Overlay
attachClose, attachClosed, attachOpen, attachOpenNew, close, detachClose, detachClosed, detachOpen, detachOpenNew, fireClose, fireClosed, fireOpen, fireOpenNew, getCloseButtonVisible, getOpenButtonVisible, isOpen, open, setCloseButtonVisible
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
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
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.ux3.OverlayDialog(sId?, mSettings?)
Constructor for a new OverlayDialog.

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
    • width : sap.ui.core.CSSSize (default: auto)
    • height : sap.ui.core.CSSSize (default: auto)
  • Aggregations

In addition, all settings applicable to the base type sap.ui.ux3.Overlay 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.
Method Detail
sap.ui.ux3.OverlayDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.OverlayDialog 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.ux3.Overlay.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
sap.ui.ux3.OverlayDialog.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.OverlayDialog.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.ui.ux3.OverlayDialog
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.OverlayDialog} Reference to this in order to allow method chaining
destroyContent(): sap.ui.ux3.OverlayDialog
Destroys all the content in the aggregation content.
Returns:
{sap.ui.ux3.OverlayDialog} Reference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

Content for the OverlayDialog.

Returns:
{sap.ui.core.Control[]}
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Determines the height of the Overlay Dialog. If the height is set to "auto" it is always 50% of the overlay height.

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property height
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Determines the width of the Overlay Dialog. If the width is set to "auto" it is always 50% of the overlay width.

Default value is auto.

Returns:
{sap.ui.core.CSSSize} Value of property width
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.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.ux3.OverlayDialog
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex the 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.ux3.OverlayDialog} Reference to this in order to allow method chaining
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)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
setHeight(sHeight)
The height for the OverlayDialog.
Parameters:
{sap.ui.core.CSSSize}sHeight
setOpenButtonVisible(bVisible)
This Method is not supported for the OverlayDialog.
Parameters:
{boolean}bVisible
setWidth(sWidth)
The width for the OverlayDialog.
Parameters:
{sap.ui.core.CSSSize}sWidth