Class sap.ca.ui.OverviewTileModule: sap/ca/ui/OverviewTile

extends Tile

Display aTile that presents an overview of a customer

Deprecated API:Since version 1.24.3. This control is not required anymore as per central UX requirements. This control will not be supported anymore.

Constructor Summary
new sap.ca.ui.OverviewTile(sId?, mSettings?)Constructor for a new OverviewTile.
Event Summary
contactPress(oControlEvent)This event is fired when the end user clicks on the contact link.
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.OverviewTile.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.OverviewTile with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.OverviewTile.getMetadata()Returns a metadata object for class sap.ca.ui.OverviewTile.
attachContactPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'contactPress' event of this sap.ca.ui.OverviewTile.
detachContactPress(fnFunction, oListener)Detach event handler fnFunction from the 'contactPress' event of this sap.ca.ui.OverviewTile.
fireContactPress(mArguments?)Fire event contactPress to attached listeners.
getAddress()Getter for property address.
getContact()Getter for property contact.
getContactActive()Getter for property contactActive.
getLastContact()Getter for property lastContact.
getNextContact()Getter for property nextContact.
getOpportunities()Getter for property opportunities.
getRating()Getter for property rating.
getRevenue()Getter for property revenue.
getTitle()Getter for property title.
getVisible()Getter for property visible.
getWidth()Getter for property width.
init()The initialization method
setAddress(sAddress)Setter for property address.
setContact(sContact)Setter for property contact.
setContactActive(bContactActive)Setter for property contactActive.
setIcon(sIcon)Setter for property icon.
setLastContact(sLastContact)Setter for property lastContact.
setNextContact(sNextContact)Setter for property nextContact.
setOpportunities(sOpportunities)Setter for property opportunities.
setRating(sRating)Setter for property rating.
setRevenue(sRevenue)Setter for property revenue.
setTitle(sTitle)Setter for property title.
setVisible(bVisible)Setter for property visible.
setWidth(sWidth)Setter for property width.
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, hasStyleClass, invalidate, isBusy, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, 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.OverviewTile(sId?, mSettings?)
Constructor for a new OverviewTile.

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

      In addition, all settings applicable to the base type sap.m.Tile 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.24.3. This control is not required anymore as per central UX requirements. This control will not be supported anymore.
      Event Detail
      contactPress(oControlEvent)
      This event is fired when the end user clicks on the contact link.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.ca.ui.OverviewTile.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.ca.ui.OverviewTile 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.OverviewTile.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.ca.ui.OverviewTile.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachContactPress(oData?, fnFunction, oListener?): sap.ca.ui.OverviewTile
      Attach event handler fnFunction to the 'contactPress' event of this sap.ca.ui.OverviewTile.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ca.ui.OverviewTile.
      itself.

      This event is fired when the end user clicks on the contact link.

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

      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.OverviewTile}this to allow method chaining
      fireContactPress(mArguments?): sap.ca.ui.OverviewTile
      Fire event contactPress to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      getAddress(): string
      Getter for property address. This property is used to set the address field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property address
      getContact(): string
      Getter for property contact. This property is used to set the contact of the tile

      Default value is null

      Returns:
      {string} the value of property contact
      getContactActive(): boolean
      Getter for property contactActive. This property is used to enable an event to be thrown when clicking on the contact's name

      Default value is false

      Returns:
      {boolean} the value of property contactActive
      getLastContact(): string
      Getter for property lastContact. This property is used to set the last contact field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property lastContact
      getNextContact(): string
      Getter for property nextContact. This property is used to set the next contact field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property nextContact
      getOpportunities(): string
      Getter for property opportunities. This property is used to set the opportunities field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property opportunities
      getRating(): string
      Getter for property rating. This property is used to set the rating field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property rating
      getRevenue(): string
      Getter for property revenue. This property is used to set the revenue to date field in the form of the tile

      Default value is null

      Returns:
      {string} the value of property revenue
      getTitle(): string
      Getter for property title. This property is used to set the title of the tile

      Default value is null

      Returns:
      {string} the value of property title
      getVisible(): boolean
      Getter for property visible. This property is used to show/hide the tile

      Default value is true

      Returns:
      {boolean} the value of property visible
      getWidth(): sap.ui.core.CSSSize
      Getter for property width. This property is used to set the width of the control

      Default value is empty/undefined

      Returns:
      {sap.ui.core.CSSSize} the value of property width
      init(): void
      The initialization method
      setAddress(sAddress): sap.ca.ui.OverviewTile
      Setter for property address.

      Default value is null

      Parameters:
      {string}sAddress new value for property address
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setContact(sContact): sap.ca.ui.OverviewTile
      Setter for property contact.

      Default value is null

      Parameters:
      {string}sContact new value for property contact
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setContactActive(bContactActive): sap.ca.ui.OverviewTile
      Setter for property contactActive.

      Default value is false

      Parameters:
      {boolean}bContactActive new value for property contactActive
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setIcon(sIcon): sap.ca.ui.OverviewTile
      Setter for property icon.

      Default value is null

      Parameters:
      {sap.ui.core.URI}sIcon new value for property icon
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setLastContact(sLastContact): sap.ca.ui.OverviewTile
      Setter for property lastContact.

      Default value is null

      Parameters:
      {string}sLastContact new value for property lastContact
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setNextContact(sNextContact): sap.ca.ui.OverviewTile
      Setter for property nextContact.

      Default value is null

      Parameters:
      {string}sNextContact new value for property nextContact
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setOpportunities(sOpportunities): sap.ca.ui.OverviewTile
      Setter for property opportunities.

      Default value is null

      Parameters:
      {string}sOpportunities new value for property opportunities
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setRating(sRating): sap.ca.ui.OverviewTile
      Setter for property rating.

      Default value is null

      Parameters:
      {string}sRating new value for property rating
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setRevenue(sRevenue): sap.ca.ui.OverviewTile
      Setter for property revenue.

      Default value is null

      Parameters:
      {string}sRevenue new value for property revenue
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setTitle(sTitle): sap.ca.ui.OverviewTile
      Setter for property title.

      Default value is null

      Parameters:
      {string}sTitle new value for property title
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setVisible(bVisible): sap.ca.ui.OverviewTile
      Setter for property visible.

      Default value is true

      Parameters:
      {boolean}bVisible new value for property visible
      Returns:
      {sap.ca.ui.OverviewTile}this to allow method chaining
      setWidth(sWidth): sap.ca.ui.OverviewTile
      Setter for property width.

      Default value is empty/undefined

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