Class sap.m.ImageContentModule: sap/m/ImageContent

extends Control

This control can be displayed as image content in a tile.


Since: 1.38.
Constructor Summary
new sap.m.ImageContent(sId?, mSettings?)Constructor for a new sap.m.ImageContent control.
Event Summary
press(oControlEvent)The event is fired when the user chooses the image content.
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.m.ImageContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ImageContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ImageContent.getMetadata()Returns a metadata object for class sap.m.ImageContent.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.ImageContent.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.ImageContent.
firePress(mArguments?)Fires event press to attached listeners.
getDescription()Gets current value of property description.
getSrc()Gets current value of property src.
setDescription(sDescription)Sets a new value for property description.
setSrc(sSrc)Sets a new value for property src.
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.m.ImageContent(sId?, mSettings?)
Constructor for a new sap.m.ImageContent control.

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
  • Aggregations
    • Events
      • press : 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
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the image content.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.m.ImageContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.m.ImageContent 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
    sap.m.ImageContent.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.ImageContent.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachPress(oData?, fnFunction, oListener?): sap.m.ImageContent
    Attaches event handler fnFunction to the press event of this sap.m.ImageContent.

    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.m.ImageContent itself.

    The event is fired when the user chooses the image content.

    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.m.ImageContent itself
    Returns:
    {sap.m.ImageContent} Reference to this in order to allow method chaining
    detachPress(fnFunction, oListener): sap.m.ImageContent
    Detaches event handler fnFunction from the press event of this sap.m.ImageContent.

    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.m.ImageContent} Reference to this in order to allow method chaining
    firePress(mArguments?): sap.m.ImageContent
    Fires event press to attached listeners.
    Parameters:
    {Map}mArguments? The arguments to pass along with the event
    Returns:
    {sap.m.ImageContent} Reference to this in order to allow method chaining
    getDescription(): string
    Gets current value of property description.

    Description of image. This text is used to provide ScreenReader information.

    Returns:
    {string} Value of property description
    getSrc(): sap.ui.core.URI
    Gets current value of property src.

    The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.

    Returns:
    {sap.ui.core.URI} Value of property src
    setDescription(sDescription): sap.m.ImageContent
    Sets a new value for property description.

    Description of image. This text is used to provide ScreenReader information.

    When called with a value of null or undefined, the default value of the property will be restored.

    Parameters:
    {string}sDescription New value for property description
    Returns:
    {sap.m.ImageContent} Reference to this in order to allow method chaining
    setSrc(sSrc): sap.m.ImageContent
    Sets a new value for property src.

    The image to be displayed as a graphical element within the imageContent. This can be an image or an icon from the icon font.

    When called with a value of null or undefined, the default value of the property will be restored.

    Parameters:
    {sap.ui.core.URI}sSrc New value for property src
    Returns:
    {sap.m.ImageContent} Reference to this in order to allow method chaining