Class sap.ui.fl.transport.TransportDialogModule: sap/ui/fl/transport/TransportDialog

extends Dialog

The Transport Dialog Control can be used to implement a value help for selecting an ABAP package and transport request. It is not a generic utility, but part of the Variantmanament and therefore cannot be used in any other application.

Constructor Summary
new sap.ui.fl.transport.TransportDialog(sId?, mSettings?)Constructor for a new transport/TransportDialog.
Event Summary
cancel(oControlEvent)This event will be fired when the user clicks the Cancel button on the dialog.
ok(oControlEvent)This event will be fired when the user clicks the OK button on the dialog.
Events borrowed from class sap.m.Dialog
afterClose, afterOpen, beforeClose, beforeOpen
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.fl.transport.TransportDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.fl.transport.TransportDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.fl.transport.TransportDialog.getMetadata()Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.ui.fl.transport.TransportDialog.
attachOk(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ok event of this sap.ui.fl.transport.TransportDialog.
detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.ui.fl.transport.TransportDialog.
detachOk(fnFunction, oListener)Detaches event handler fnFunction from the ok event of this sap.ui.fl.transport.TransportDialog.
fireCancel(mArguments?)Fires event cancel to attached listeners.
fireOk(mArguments?)Fires event ok to attached listeners.
getHidePackage()Gets current value of property hidePackage.
getLrepObject()Gets current value of property lrepObject.
getPkg()Gets current value of property pkg.
getTransports()Gets current value of property transports.
setHidePackage(bHide)Flag indicating whether the selection of an ABAP package is to be hidden or not.
setLrepObject(oObject)The LREP object for which as transport request has to be selected.
setPkg(sPackage)An ABAP package that can be used as default for the ABAP package selection.
setTransports(aSelection)The set of ABAP transport requests that can be selected by a user.
Methods borrowed from class sap.m.Dialog
_getAnyHeader, addAriaDescribedBy, addAriaLabelledBy, addButton, addContent, attachAfterClose, attachAfterOpen, attachBeforeClose, attachBeforeOpen, close, destroyBeginButton, destroyButtons, destroyContent, destroyCustomHeader, destroyEndButton, destroySubHeader, detachAfterClose, detachAfterOpen, detachBeforeClose, detachBeforeOpen, fireAfterClose, fireAfterOpen, fireBeforeClose, fireBeforeOpen, getAriaDescribedBy, getAriaLabelledBy, getBeginButton, getButtons, getContent, getContentHeight, getContentWidth, getCustomHeader, getDraggable, getEndButton, getHorizontalScrolling, getIcon, getInitialFocus, getLeftButton, getResizable, getRightButton, getShowHeader, getState, getStretch, getStretchOnPhone, getSubHeader, getTitle, getType, getVerticalScrolling, indexOfButton, indexOfContent, insertButton, insertContent, isOpen, open, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAllButtons, removeAllContent, removeAriaDescribedBy, removeAriaLabelledBy, removeButton, removeContent, setBeginButton, setContentHeight, setContentWidth, setCustomHeader, setDraggable, setEndButton, setHorizontalScrolling, setIcon, setInitialFocus, setLeftButton, setResizable, setRightButton, setShowHeader, setState, setStretch, setStretchOnPhone, setSubHeader, setTitle, setType, setVerticalScrolling
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, onAfterRendering, onBeforeRendering, 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, exit, 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.fl.transport.TransportDialog(sId?, mSettings?)
Constructor for a new transport/TransportDialog.

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
    • ok : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • cancel : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.m.Dialog 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
Event Detail
cancel(oControlEvent)
This event will be fired when the user clicks the Cancel button on the dialog.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
ok(oControlEvent)
This event will be fired when the user clicks the OK button on the dialog.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.fl.transport.TransportDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.fl.transport.TransportDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Dialog.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.fl.transport.TransportDialog.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.fl.transport.TransportDialog.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachCancel(oData?, fnFunction, oListener?): sap.ui.fl.transport.TransportDialog
Attaches event handler fnFunction to the cancel event of this sap.ui.fl.transport.TransportDialog.

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.fl.transport.TransportDialog itself.

This event will be fired when the user clicks the Cancel button on the dialog.

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.fl.transport.TransportDialog itself
Returns:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
attachOk(oData?, fnFunction, oListener?): sap.ui.fl.transport.TransportDialog
Attaches event handler fnFunction to the ok event of this sap.ui.fl.transport.TransportDialog.

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.fl.transport.TransportDialog itself.

This event will be fired when the user clicks the OK button on the dialog.

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.fl.transport.TransportDialog itself
Returns:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
detachCancel(fnFunction, oListener): sap.ui.fl.transport.TransportDialog
Detaches event handler fnFunction from the cancel event of this sap.ui.fl.transport.TransportDialog.

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:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
detachOk(fnFunction, oListener): sap.ui.fl.transport.TransportDialog
Detaches event handler fnFunction from the ok event of this sap.ui.fl.transport.TransportDialog.

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:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
fireCancel(mArguments?): sap.ui.fl.transport.TransportDialog
Fires event cancel to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
fireOk(mArguments?): sap.ui.fl.transport.TransportDialog
Fires event ok to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.fl.transport.TransportDialog} Reference to this in order to allow method chaining
getHidePackage(): boolean
Gets current value of property hidePackage.

Flag indicating whether the selection of an ABAP package is to be hidden or not.

Returns:
{boolean} Value of property hidePackage
getLrepObject(): any
Gets current value of property lrepObject.

The LREP object for which as transport request has to be selected

Returns:
{any} Value of property lrepObject
getPkg(): string
Gets current value of property pkg.

An ABAP package that can be used as default for the ABAP package selection.

Returns:
{string} Value of property pkg
getTransports(): any
Gets current value of property transports.

The set of ABAP transport requests that can be selected by a user.

Returns:
{any} Value of property transports
setHidePackage(bHide)
Flag indicating whether the selection of an ABAP package is to be hidden or not.
Parameters:
{boolean}bHide if set to true, the package selection is hidden.
setLrepObject(oObject)
The LREP object for which as transport request has to be selected. The property can only be set once and afterwards it cannot be changed.
Parameters:
{object}oObject an LREP object for which as transport request has to be selected. The object has the attributes name, namespace and type.
setPkg(sPackage)
An ABAP package that can be used as default for the ABAP package selection. The property can only be set once and afterwards it cannot be changed.
Parameters:
{string}sPackage an ABAP package that can be used as default for the ABAP package selection.
setTransports(aSelection)
The set of ABAP transport requests that can be selected by a user.
Parameters:
{array}aSelection the set of ABAP transport requests that can be selected by a user.