Class sap.m.NewsContentModule: sap/m/NewsContent

extends Control

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


Since: 1.34.
Constructor Summary
new sap.m.NewsContent(sId?, mSettings?)Constructor for a new sap.m.NewsContent control.
Event Summary
press(oControlEvent)The event is fired when the user chooses the news content.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.NewsContent.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.NewsContent with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.NewsContent.getMetadata()Returns a metadata object for class sap.m.NewsContent.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.m.NewsContent.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.m.NewsContent.
firePress(mArguments?)Fires event press to attached listeners.
getContentText()Gets current value of property contentText.
getSubheader()Gets current value of property subheader.
setSubheader(sSubheader)Sets a new value for property subheader.
getSize()Gets current value of property size.
setSize(sSize)Sets a new value for property size.
Constructor Detail
new sap.m.NewsContent(sId?, mSettings?)
Constructor for a new sap.m.NewsContent 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 news content.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.m.NewsContent.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.m.NewsContent 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.NewsContent.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.NewsContent.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachPress(oData?, fnFunction, oListener?): sap.m.NewsContent
    Attaches event handler fnFunction to the press event of this sap.m.NewsContent.

    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.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 be called when the event occurs
    {object}oListener? Context object to call the event handler with. Defaults to this sap.m.NewsContent itself
    Returns:
    {sap.m.NewsContent} Reference to this in order to allow method chaining
    detachPress(fnFunction, oListener): sap.m.NewsContent
    Detaches event handler fnFunction from the press event of this sap.m.NewsContent.

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

    The content text.

    Returns:
    {string} Value of property contentText
    getSubheader(): string
    Gets current value of property subheader.

    The subheader.

    Returns:
    {string} Value of property subheader
    setSubheader(sSubheader): sap.m.NewsContent
    Sets a new value for property subheader.

    The subheader.

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

    Parameters:
    {string}sSubheader New value for property subheader
    Returns:
    {sap.m.NewsContent} Reference to this in order to allow method chaining
    getSize(): sap.m.Size
    Gets current value of 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.

    Deprecated:
    Since version 1.38.0. The NewsContent control has now a fixed size, depending on the used media (desktop, tablet or phone).
    Returns:
    {sap.m.Size} Value of property size
    setSize(sSize): sap.m.NewsContent
    Sets a new value for property size.

    Updates the size of the chart. If not set then the default size is applied based on the device tile.

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

    Default value is Auto.

    Parameters:
    {sap.m.Size}sSize New value for property size
    Deprecated:
    Since version 1.38.0. The NewsContent control has now a fixed size, depending on the used media (desktop, tablet or phone).
    Returns:
    {sap.m.NewsContent} Reference to this in order to allow method chaining