Class sap.suite.ui.commons.NewsContentModule: sap/suite/ui/commons/NewsContent

extends Control

This control displays the news content text and subheader in a tile.

Deprecated API:Since version 1.34. Deprecated. sap.m.NewsContent should be used.

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

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
    • size : sap.suite.ui.commons.InfoTileSize (default: sap.suite.ui.commons.InfoTileSize.Auto)
    • contentText : string
    • subheader : string
  • 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. sap.m.NewsContent should be used.
      Event Detail
      press(oControlEvent)
      The event is fired when the user chooses the news content.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      Method Detail
      sap.suite.ui.commons.NewsContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.NewsContent 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.NewsContent.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.NewsContent.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachPress(oData?, fnFunction, oListener?): sap.suite.ui.commons.NewsContent
      Attach event handler fnFunction to the 'press' event of this sap.suite.ui.commons.NewsContent.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NewsContent.
      itself.

      The event is fired when the user chooses the news 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.NewsContent.
      itself.
      Returns:
      {sap.suite.ui.commons.NewsContent}this to allow method chaining
      detachPress(fnFunction, oListener): sap.suite.ui.commons.NewsContent
      Detach event handler fnFunction from the 'press' event of this sap.suite.ui.commons.NewsContent.

      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.NewsContent}this to allow method chaining
      firePress(mArguments?): sap.suite.ui.commons.NewsContent
      Fire event press to attached listeners.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NewsContent}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
      setContentText(sContentText): sap.suite.ui.commons.NewsContent
      Setter for property contentText.

      Default value is empty/undefined

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

      Default value is empty/undefined

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