Class sap.ca.ui.PictureTileModule: sap/ca/ui/PictureTile

extends CustomTile

Tile control embedding an image and allowing custom sizing

Deprecated API:Since version 1.22.

PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.

Constructor Summary
new sap.ca.ui.PictureTile(sId?, mSettings?)Constructor for a new PictureTile.
Event Summary
pictureDelete(oControlEvent)Fired when the user deletes a picture
Events borrowed from class sap.m.Tile
press
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.ca.ui.PictureTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.PictureTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.PictureTile.getMetadata()Returns a metadata object for class sap.ca.ui.PictureTile.
attachPictureDelete(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'pictureDelete' event of this sap.ca.ui.PictureTile.
detachPictureDelete(fnFunction, oListener)Detach event handler fnFunction from the 'pictureDelete' event of this sap.ca.ui.PictureTile.
firePictureDelete(mArguments?)Fire event pictureDelete to attached listeners.
getHeight()Getter for property height.
getTileContent()Reference to one PictureViewerItem coming from the PictureViewer.
getWidth()Getter for property width.
setHeight(sHeight)Setter for property height.
setTileContent(vTileContent)Reference to one PictureViewerItem coming from the PictureViewer.
setWidth(sWidth)Setter for property width.
Methods borrowed from class sap.m.CustomTile
destroyContent, getContent, setContent
Methods borrowed from class sap.m.Tile
attachPress, detachPress, firePress, getRemovable, setRemovable
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, 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.ca.ui.PictureTile(sId?, mSettings?)
Constructor for a new PictureTile.

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
    • height : sap.ui.core.CSSSize (default: '32px')
    • width : sap.ui.core.CSSSize (default: '32px')
  • Aggregations
    • Associations
    • Events
      • pictureDelete : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

    In addition, all settings applicable to the base type sap.m.CustomTile 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.22.

    PictureTile is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the sap.m.Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.

    Event Detail
    pictureDelete(oControlEvent)
    Fired when the user deletes a picture
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.ca.ui.PictureTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.ca.ui.PictureTile 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.ca.ui.PictureTile.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.ca.ui.PictureTile.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachPictureDelete(oData?, fnFunction, oListener?): sap.ca.ui.PictureTile
    Attach event handler fnFunction to the 'pictureDelete' event of this sap.ca.ui.PictureTile.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.PictureTile.
    itself.

    Fired when the user deletes a picture

    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.ca.ui.PictureTile.
    itself.
    Returns:
    {sap.ca.ui.PictureTile}this to allow method chaining
    detachPictureDelete(fnFunction, oListener): sap.ca.ui.PictureTile
    Detach event handler fnFunction from the 'pictureDelete' event of this sap.ca.ui.PictureTile.

    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.ca.ui.PictureTile}this to allow method chaining
    firePictureDelete(mArguments?): sap.ca.ui.PictureTile
    Fire event pictureDelete to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.ca.ui.PictureTile}this to allow method chaining
    getHeight(): sap.ui.core.CSSSize
    Getter for property height. height (in pixels) of the picture viewer control.

    Default value is 32px

    Returns:
    {sap.ui.core.CSSSize} the value of property height
    getTileContent(): string
    Reference to one PictureViewerItem coming from the PictureViewer.
    Returns:
    {string} Id of the element which is the current target of the tileContent association, or null
    getWidth(): sap.ui.core.CSSSize
    Getter for property width. width (in pixels) of the picture viewer control.

    Default value is 32px

    Returns:
    {sap.ui.core.CSSSize} the value of property width
    setHeight(sHeight): sap.ca.ui.PictureTile
    Setter for property height.

    Default value is 32px

    Parameters:
    {sap.ui.core.CSSSize}sHeight new value for property height
    Returns:
    {sap.ca.ui.PictureTile}this to allow method chaining
    setTileContent(vTileContent): sap.ca.ui.PictureTile
    Reference to one PictureViewerItem coming from the PictureViewer.
    Parameters:
    {string|sap.ca.ui.PictureViewerItem}vTileContent Id of an element which becomes the new target of this tileContent association. Alternatively, an element instance may be given.
    Returns:
    {sap.ca.ui.PictureTile}this to allow method chaining
    setWidth(sWidth): sap.ca.ui.PictureTile
    Setter for property width.

    Default value is 32px

    Parameters:
    {sap.ui.core.CSSSize}sWidth new value for property width
    Returns:
    {sap.ca.ui.PictureTile}this to allow method chaining