Class sap.suite.ui.commons.GenericTileModule: sap/suite/ui/commons/GenericTile

extends Control

The tile control that displays the title, description, and customizable main area.

Deprecated API:Since version 1.34. Deprecated. Moved to openui5.

Constructor Summary
new sap.suite.ui.commons.GenericTile(sId?, mSettings?)Constructor for a new GenericTile.
Event Summary
press(oControlEvent)The event is fired when the user chooses the tile.
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.suite.ui.commons.GenericTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.GenericTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.GenericTile.getMetadata()Returns a metadata object for class sap.suite.ui.commons.GenericTile.
addTileContent(oTileContent)Adds some tileContent oTileContent to the aggregation named tileContent.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.GenericTile.
destroyIcon()Destroys the icon in the aggregation named icon.
destroyTileContent()Destroys all the tileContent in the aggregation named tileContent.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.GenericTile.
firePress(mArguments?)Fire event press to attached listeners.
getBackgroundImage()Getter for property backgroundImage.
getFailedText()Getter for property failedText.
getFrameType()Getter for property frameType.
getHeader()Getter for property header.
getHeaderImage()Getter for property headerImage.
getIcon()Getter for aggregation icon.
getImageDescription()Getter for property imageDescription.
getSize()Getter for property size.
getState()Getter for property state.
getSubheader()Getter for property subheader.
getTileContent()Getter for aggregation tileContent.
indexOfTileContent(oTileContent)Checks for the provided sap.suite.ui.commons.TileContent in the aggregation named tileContent and returns its index if found or -1 otherwise.
insertTileContent(oTileContent, iIndex)Inserts a tileContent into the aggregation named tileContent.
removeAllTileContent()Removes all the controls in the aggregation named tileContent.
removeTileContent(vTileContent)Removes an tileContent from the aggregation named tileContent.
setBackgroundImage(sBackgroundImage)Setter for property backgroundImage.
setFailedText(sFailedText)Setter for property failedText.
setFrameType(oFrameType)Setter for property frameType.
setHeader(sHeader)Setter for property header.
setHeaderImage(sHeaderImage)Setter for property headerImage.
setIcon(oIcon)Setter for the aggregated icon.
setImageDescription(sImageDescription)Setter for property imageDescription.
setSize(oSize)Setter for property size.
setState(oState)Setter for property state.
setSubheader(sSubheader)Setter for property subheader.
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.suite.ui.commons.GenericTile(sId?, mSettings?)
Constructor for a new GenericTile.

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
  • Associations
    • Events
      • press : 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
    Deprecated:
    Since version 1.34. Deprecated. Moved to openui5.
    Event Detail
    press(oControlEvent)
    The event is fired when the user chooses the tile.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.suite.ui.commons.GenericTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.GenericTile 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.suite.ui.commons.GenericTile.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.GenericTile.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addTileContent(oTileContent): sap.suite.ui.commons.GenericTile
    Adds some tileContent oTileContent to the aggregation named tileContent.
    Parameters:
    {sap.suite.ui.commons.TileContent}oTileContent the tileContent to add; if empty, nothing is inserted
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.GenericTile
    Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.GenericTile.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.GenericTile.
    itself.

    The event is fired when the user chooses the tile.

    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.suite.ui.commons.GenericTile.
    itself.
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    destroyIcon(): sap.suite.ui.commons.GenericTile
    Destroys the icon in the aggregation named icon.
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    destroyTileContent(): sap.suite.ui.commons.GenericTile
    Destroys all the tileContent in the aggregation named tileContent.
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    detachPress(fnFunction, oListener): sap.suite.ui.commons.GenericTile
    Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.GenericTile.

    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.suite.ui.commons.GenericTile}this to allow method chaining
    firePress(mArguments?): sap.suite.ui.commons.GenericTile
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    getBackgroundImage(): sap.ui.core.URI
    Getter for property backgroundImage. The URI of the background image.

    Default value is empty/undefined

    Returns:
    {sap.ui.core.URI} the value of property backgroundImage
    getFailedText(): string
    Getter for property failedText. The message that appears when the control is in the Failed state.

    Default value is empty/undefined

    Since:
    1.23
    Returns:
    {string} the value of property failedText
    getFrameType(): sap.suite.ui.commons.FrameType
    Getter for property frameType. The frame type: 1x1 or 2x1.

    Default value is OneByOne

    Returns:
    {sap.suite.ui.commons.FrameType} the value of property frameType
    getHeader(): string
    Getter for property header. The header of the tile.

    Default value is empty/undefined

    Returns:
    {string} the value of property header
    getHeaderImage(): sap.ui.core.URI
    Getter for property headerImage. The image to be displayed as a graphical element within the header. This can be an image or an icon from the icon font.

    Default value is empty/undefined

    Returns:
    {sap.ui.core.URI} the value of property headerImage
    getIcon(): sap.ui.core.Control
    Getter for aggregation icon.
    An icon or image to be displayed in the control.
    Returns:
    {sap.ui.core.Control}
    getImageDescription(): string
    Getter for property imageDescription. Description of a header image that is used in the tooltip.

    Default value is empty/undefined

    Since:
    1.25
    Returns:
    {string} the value of property imageDescription
    getSize(): sap.suite.ui.commons.InfoTileSize
    Getter for property size. The size of the tile. If not set, then the default size is applied based on the device tile.

    Default value is Auto

    Returns:
    {sap.suite.ui.commons.InfoTileSize} the value of property size
    getState(): sap.suite.ui.commons.LoadState
    Getter for property state. The load status.

    Default value is Loaded

    Since:
    1.22
    Returns:
    {sap.suite.ui.commons.LoadState} the value of property state
    getSubheader(): string
    Getter for property subheader. The subheader of the tile.

    Default value is empty/undefined

    Returns:
    {string} the value of property subheader
    getTileContent(): sap.suite.ui.commons.TileContent[]
    Getter for aggregation tileContent.
    The switchable view that depends on the tile type.
    Returns:
    {sap.suite.ui.commons.TileContent[]}
    indexOfTileContent(oTileContent): int
    Checks for the provided sap.suite.ui.commons.TileContent in the aggregation named tileContent and returns its index if found or -1 otherwise.
    Parameters:
    {sap.suite.ui.commons.TileContent}oTileContent the tileContent whose index is looked for.
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertTileContent(oTileContent, iIndex): sap.suite.ui.commons.GenericTile
    Inserts a tileContent into the aggregation named tileContent.
    Parameters:
    {sap.suite.ui.commons.TileContent}oTileContent the tileContent to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the tileContent should be inserted at; for a negative value of iIndex, the tileContent is inserted at position 0; for a value greater than the current size of the aggregation, the tileContent is inserted at the last position
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    removeAllTileContent(): sap.suite.ui.commons.TileContent[]
    Removes all the controls in the aggregation named tileContent.
    Additionally unregisters them from the hosting UIArea.
    Returns:
    {sap.suite.ui.commons.TileContent[]} an array of the removed elements (might be empty)
    removeTileContent(vTileContent): sap.suite.ui.commons.TileContent
    Removes an tileContent from the aggregation named tileContent.
    Parameters:
    {int|string|sap.suite.ui.commons.TileContent}vTileContent the tileContent to remove or its index or id
    Returns:
    {sap.suite.ui.commons.TileContent} the removed tileContent or null
    setBackgroundImage(sBackgroundImage): sap.suite.ui.commons.GenericTile
    Setter for property backgroundImage.

    Default value is empty/undefined

    Parameters:
    {sap.ui.core.URI}sBackgroundImage new value for property backgroundImage
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setFailedText(sFailedText): sap.suite.ui.commons.GenericTile
    Setter for property failedText.

    Default value is empty/undefined

    Parameters:
    {string}sFailedText new value for property failedText
    Since:
    1.23
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setFrameType(oFrameType): sap.suite.ui.commons.GenericTile
    Setter for property frameType.

    Default value is OneByOne

    Parameters:
    {sap.suite.ui.commons.FrameType}oFrameType new value for property frameType
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setHeader(sHeader): sap.suite.ui.commons.GenericTile
    Setter for property header.

    Default value is empty/undefined

    Parameters:
    {string}sHeader new value for property header
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setHeaderImage(sHeaderImage): sap.suite.ui.commons.GenericTile
    Setter for property headerImage.

    Default value is empty/undefined

    Parameters:
    {sap.ui.core.URI}sHeaderImage new value for property headerImage
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setIcon(oIcon): sap.suite.ui.commons.GenericTile
    Setter for the aggregated icon.
    Parameters:
    {sap.ui.core.Control}oIcon
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setImageDescription(sImageDescription): sap.suite.ui.commons.GenericTile
    Setter for property imageDescription.

    Default value is empty/undefined

    Parameters:
    {string}sImageDescription new value for property imageDescription
    Since:
    1.25
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setSize(oSize): sap.suite.ui.commons.GenericTile
    Setter for property size.

    Default value is Auto

    Parameters:
    {sap.suite.ui.commons.InfoTileSize}oSize new value for property size
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setState(oState): sap.suite.ui.commons.GenericTile
    Setter for property state.

    Default value is Loaded

    Parameters:
    {sap.suite.ui.commons.LoadState}oState new value for property state
    Since:
    1.22
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining
    setSubheader(sSubheader): sap.suite.ui.commons.GenericTile
    Setter for property subheader.

    Default value is empty/undefined

    Parameters:
    {string}sSubheader new value for property subheader
    Returns:
    {sap.suite.ui.commons.GenericTile}this to allow method chaining