Class sap.uiext.inbox.composite.InboxAttachmentsTileContainerModule: sap/uiext/inbox/composite/InboxAttachmentsTileContainer

extends Control

InboxAttachmentsTileContainer

Constructor Summary
new sap.uiext.inbox.composite.InboxAttachmentsTileContainer(sId?, mSettings?)Constructor for a new composite/InboxAttachmentsTileContainer.
Event Summary
uploadButtonPress(oControlEvent)event is fired to add all the header parameters just before uploading a file
uploadFailed(oControlEvent)event is fired when uploading a file has failed
uploadSuccess(oControlEvent)event is fired when uploading a file is completed successfully
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.uiext.inbox.composite.InboxAttachmentsTileContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uiext.inbox.composite.InboxAttachmentsTileContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.uiext.inbox.composite.InboxAttachmentsTileContainer.getMetadata()Returns a metadata object for class sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
addAttachment(oAttachment)Adds some attachment oAttachment to the aggregation named attachments.
addUploadHeader()method to add a header parameter while uploading a file.
attachUploadButtonPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'uploadButtonPress' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
attachUploadFailed(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'uploadFailed' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
attachUploadSuccess(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'uploadSuccess' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
destroyAttachments()Destroys all the attachments in the aggregation named attachments.
detachUploadButtonPress(fnFunction, oListener)Detach event handler fnFunction from the 'uploadButtonPress' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
detachUploadFailed(fnFunction, oListener)Detach event handler fnFunction from the 'uploadFailed' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
detachUploadSuccess(fnFunction, oListener)Detach event handler fnFunction from the 'uploadSuccess' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
fireUploadButtonPress(mArguments?)Fire event uploadButtonPress to attached listeners.
fireUploadFailed(mArguments?)Fire event uploadFailed to attached listeners.
fireUploadSuccess(mArguments?)Fire event uploadSuccess to attached listeners.
getAttachments()Getter for aggregation attachments.
getEnteredDescription()Getter for property enteredDescription.
getFileName()Getter for property fileName.
getFileType()Getter for property fileType.
getIsFileSelected()Getter for property isFileSelected.
getShowAddTile()Getter for property showAddTile.
getUploadUrl()Getter for property uploadUrl.
indexOfAttachment(oAttachment)Checks for the provided sap.uiext.inbox.composite.InboxAttachmentTile in the aggregation named attachments and returns its index if found or -1 otherwise.
insertAttachment(oAttachment, iIndex)Inserts a attachment into the aggregation named attachments.
removeAllAttachments()Removes all the controls in the aggregation named attachments.
removeAttachment(vAttachment)Removes an attachment from the aggregation named attachments.
removeUploadHeader()method to remove a headerParameter of fileUploader
setEnteredDescription(sEnteredDescription)Setter for property enteredDescription.
setFileName(sFileName)Setter for property fileName.
setFileType(sFileType)Setter for property fileType.
setIsFileSelected(bIsFileSelected)Setter for property isFileSelected.
setShowAddTile(bShowAddTile)Setter for property showAddTile.
setUploadUrl(sUploadUrl)Setter for property uploadUrl.
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, init, 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.uiext.inbox.composite.InboxAttachmentsTileContainer(sId?, mSettings?)
Constructor for a new composite/InboxAttachmentsTileContainer.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

  • Properties
  • Aggregations
    • attachments : sap.uiext.inbox.composite.InboxAttachmentTile[]
  • Associations
    • Events
      • uploadButtonPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • uploadSuccess : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • uploadFailed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    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
    uploadButtonPress(oControlEvent)
    event is fired to add all the header parameters just before uploading a file
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    uploadFailed(oControlEvent)
    event is fired when uploading a file has failed
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    uploadSuccess(oControlEvent)
    event is fired when uploading a file is completed successfully
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.uiext.inbox.composite.InboxAttachmentsTileContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.uiext.inbox.composite.InboxAttachmentsTileContainer with name sClassName and enriches it with the information contained in oClassInfo.

    oClassInfo might contain the same kind of informations as described in Element.extend.

    Parameters:
    {string}sClassName name of the class to be created
    {object}oClassInfo? object literal with informations about the class
    {function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
    Returns:
    {function} the created class / constructor function
    sap.uiext.inbox.composite.InboxAttachmentsTileContainer.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addAttachment(oAttachment): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Adds some attachment oAttachment to the aggregation named attachments.
    Parameters:
    {sap.uiext.inbox.composite.InboxAttachmentTile}oAttachment the attachment to add; if empty, nothing is inserted
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    addUploadHeader(): void
    method to add a header parameter while uploading a file. This method takes header name and header value as input.
    attachUploadButtonPress(oData?, fnFunction, oListener?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Attach event handler fnFunction to the 'uploadButtonPress' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.

    event is fired to add all the header parameters just before uploading a file

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    attachUploadFailed(oData?, fnFunction, oListener?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Attach event handler fnFunction to the 'uploadFailed' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.

    event is fired when uploading a file has failed

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    attachUploadSuccess(oData?, fnFunction, oListener?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Attach event handler fnFunction to the 'uploadSuccess' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.

    event is fired when uploading a file is completed successfully

    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 call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.
    itself.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    destroyAttachments(): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Destroys all the attachments in the aggregation named attachments.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    detachUploadButtonPress(fnFunction, oListener): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Detach event handler fnFunction from the 'uploadButtonPress' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    detachUploadFailed(fnFunction, oListener): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Detach event handler fnFunction from the 'uploadFailed' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    detachUploadSuccess(fnFunction, oListener): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Detach event handler fnFunction from the 'uploadSuccess' event of this sap.uiext.inbox.composite.InboxAttachmentsTileContainer.

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

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    fireUploadButtonPress(mArguments?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Fire event uploadButtonPress to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    fireUploadFailed(mArguments?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Fire event uploadFailed to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    fireUploadSuccess(mArguments?): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Fire event uploadSuccess to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    getAttachments(): sap.uiext.inbox.composite.InboxAttachmentTile[]
    Getter for aggregation attachments.
    aggregation for attachments tile
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentTile[]}
    getEnteredDescription(): string
    Getter for property enteredDescription. description string entered by user while uploading a file

    Default value is empty/undefined

    Returns:
    {string} the value of property enteredDescription
    getFileName(): string
    Getter for property fileName. name of the selected file for uploading

    Default value is empty/undefined

    Returns:
    {string} the value of property fileName
    getFileType(): string
    Getter for property fileType. type of the selected file for uploading

    Default value is empty/undefined

    Returns:
    {string} the value of property fileType
    getIsFileSelected(): boolean
    Getter for property isFileSelected. boolean property to indicate if user has selected a file to upload

    Default value is empty/undefined

    Returns:
    {boolean} the value of property isFileSelected
    getShowAddTile(): boolean
    Getter for property showAddTile. boolean value to indicate whether to show Add Attachment tile

    Default value is true

    Returns:
    {boolean} the value of property showAddTile
    getUploadUrl(): string
    Getter for property uploadUrl. URL to upload the selected file

    Default value is empty/undefined

    Returns:
    {string} the value of property uploadUrl
    indexOfAttachment(oAttachment): int
    Checks for the provided sap.uiext.inbox.composite.InboxAttachmentTile in the aggregation named attachments and returns its index if found or -1 otherwise.
    Parameters:
    {sap.uiext.inbox.composite.InboxAttachmentTile}oAttachment the attachment whose index is looked for.
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertAttachment(oAttachment, iIndex): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Inserts a attachment into the aggregation named attachments.
    Parameters:
    {sap.uiext.inbox.composite.InboxAttachmentTile}oAttachment the attachment to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the attachment should be inserted at; for a negative value of iIndex, the attachment is inserted at position 0; for a value greater than the current size of the aggregation, the attachment is inserted at the last position
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    removeAllAttachments(): sap.uiext.inbox.composite.InboxAttachmentTile[]
    Removes all the controls in the aggregation named attachments.
    Additionally unregisters them from the hosting UIArea.
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentTile[]} an array of the removed elements (might be empty)
    removeAttachment(vAttachment): sap.uiext.inbox.composite.InboxAttachmentTile
    Removes an attachment from the aggregation named attachments.
    Parameters:
    {int|string|sap.uiext.inbox.composite.InboxAttachmentTile}vAttachment the attachment to remove or its index or id
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentTile} the removed attachment or null
    removeUploadHeader(): void
    method to remove a headerParameter of fileUploader
    setEnteredDescription(sEnteredDescription): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property enteredDescription.

    Default value is empty/undefined

    Parameters:
    {string}sEnteredDescription new value for property enteredDescription
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    setFileName(sFileName): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property fileName.

    Default value is empty/undefined

    Parameters:
    {string}sFileName new value for property fileName
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    setFileType(sFileType): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property fileType.

    Default value is empty/undefined

    Parameters:
    {string}sFileType new value for property fileType
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    setIsFileSelected(bIsFileSelected): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property isFileSelected.

    Default value is empty/undefined

    Parameters:
    {boolean}bIsFileSelected new value for property isFileSelected
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    setShowAddTile(bShowAddTile): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property showAddTile.

    Default value is true

    Parameters:
    {boolean}bShowAddTile new value for property showAddTile
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining
    setUploadUrl(sUploadUrl): sap.uiext.inbox.composite.InboxAttachmentsTileContainer
    Setter for property uploadUrl.

    Default value is empty/undefined

    Parameters:
    {string}sUploadUrl new value for property uploadUrl
    Returns:
    {sap.uiext.inbox.composite.InboxAttachmentsTileContainer}this to allow method chaining