Class sap.suite.ui.commons.JamContentModule: sap/suite/ui/commons/JamContent

extends Control

This control displays the jam content text, subheader, and numeric value in a tile.

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

Constructor Summary
new sap.suite.ui.commons.JamContent(sId?, mSettings?)Constructor for a new JamContent.
Event Summary
press(oControlEvent)The event is fired when the user chooses the jam 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.suite.ui.commons.JamContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.JamContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.JamContent.getMetadata()Returns a metadata object for class sap.suite.ui.commons.JamContent.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.JamContent.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.JamContent.
firePress(mArguments?)Fire event press to attached listeners.
getContentText()Getter for property contentText.
getSize()Getter for property size.
getSubheader()Getter for property subheader.
getTruncateValueTo()Getter for property truncateValueTo.
getValue()Getter for property value.
getValueColor()Getter for property valueColor.
setContentText(sContentText)Setter for property contentText.
setSize(oSize)Setter for property size.
setSubheader(sSubheader)Setter for property subheader.
setTruncateValueTo(iTruncateValueTo)Setter for property truncateValueTo.
setValue(sValue)Setter for property value.
setValueColor(oValueColor)Setter for property valueColor.
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.JamContent(sId?, mSettings?)
Constructor for a new JamContent.

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

      The event is fired when the user chooses the jam 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 call, when the event occurs.
      {object}oListener? Context object to call the event handler with. Defaults to this sap.suite.ui.commons.JamContent.
      itself.
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      detachPress(fnFunction, oListener): sap.suite.ui.commons.JamContent
      Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.JamContent.

      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.JamContent}this to allow method chaining
      firePress(mArguments?): sap.suite.ui.commons.JamContent
      Fire event press to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      getContentText(): string
      Getter for property contentText. The content text.

      Default value is empty/undefined

      Returns:
      {string} the value of property contentText
      getSize(): sap.suite.ui.commons.InfoTileSize
      Getter for property size. Updates the size of the chart. 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
      getSubheader(): string
      Getter for property subheader. The subheader.

      Default value is empty/undefined

      Returns:
      {string} the value of property subheader
      getTruncateValueTo(): int
      Getter for property truncateValueTo. The number of characters to display for the value property.

      Default value is 4

      Returns:
      {int} the value of property truncateValueTo
      getValue(): string
      Getter for property value. The actual value.

      Default value is empty/undefined

      Returns:
      {string} the value of property value
      getValueColor(): sap.suite.ui.commons.InfoTileValueColor
      Getter for property valueColor. The semantic color of the value.

      Default value is empty/undefined

      Returns:
      {sap.suite.ui.commons.InfoTileValueColor} the value of property valueColor
      setContentText(sContentText): sap.suite.ui.commons.JamContent
      Setter for property contentText.

      Default value is empty/undefined

      Parameters:
      {string}sContentText new value for property contentText
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      setSize(oSize): sap.suite.ui.commons.JamContent
      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.JamContent}this to allow method chaining
      setSubheader(sSubheader): sap.suite.ui.commons.JamContent
      Setter for property subheader.

      Default value is empty/undefined

      Parameters:
      {string}sSubheader new value for property subheader
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      setTruncateValueTo(iTruncateValueTo): sap.suite.ui.commons.JamContent
      Setter for property truncateValueTo.

      Default value is 4

      Parameters:
      {int}iTruncateValueTo new value for property truncateValueTo
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      setValue(sValue): sap.suite.ui.commons.JamContent
      Setter for property value.

      Default value is empty/undefined

      Parameters:
      {string}sValue new value for property value
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining
      setValueColor(oValueColor): sap.suite.ui.commons.JamContent
      Setter for property valueColor.

      Default value is empty/undefined

      Parameters:
      {sap.suite.ui.commons.InfoTileValueColor}oValueColor new value for property valueColor
      Returns:
      {sap.suite.ui.commons.JamContent}this to allow method chaining