Class sap.ui.ux3.DataSetItemModule: sap/ui/ux3/DataSetItem

extends Element

DataSet Item

Deprecated API:Since version 1.38.

Constructor Summary
new sap.ui.ux3.DataSetItem(sId?, mSettings?)Constructor for a new DataSetItem.
Event Summary
selected(oControlEvent)Event Fired when Datset item is selected.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.DataSetItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.DataSetItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.DataSetItem.getMetadata()Returns a metadata object for class sap.ui.ux3.DataSetItem.
attachSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selected event of this sap.ui.ux3.DataSetItem.
detachSelected(fnFunction, oListener)Detaches event handler fnFunction from the selected event of this sap.ui.ux3.DataSetItem.
fireSelected(mArguments?)Fires event selected to attached listeners.
getCheckable()Gets current value of property checkable.
getIconSrc()Gets current value of property iconSrc.
getSubtitle()Gets current value of property subtitle.
getTitle()Gets current value of property title.
setCheckable(bCheckable)Sets a new value for property checkable.
setIconSrc(sIconSrc)Sets a new value for property iconSrc.
setSubtitle(sSubtitle)Sets a new value for property subtitle.
setTitle(sTitle)Sets a new value for property title.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, invalidate, 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.ui.ux3.DataSetItem(sId?, mSettings?)
Constructor for a new DataSetItem.

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

    In addition, all settings applicable to the base type sap.ui.core.Element 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.38.
    Event Detail
    selected(oControlEvent)
    Event Fired when Datset item is selected.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {string}oControlEvent.getParameters.itemId Id of the selected Datset item
    Method Detail
    sap.ui.ux3.DataSetItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.ui.ux3.DataSetItem 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.Element.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.ui.ux3.DataSetItem.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.ui.ux3.DataSetItem.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachSelected(oData?, fnFunction, oListener?): sap.ui.ux3.DataSetItem
    Attaches event handler fnFunction to the selected event of this sap.ui.ux3.DataSetItem.

    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.ui.ux3.DataSetItem itself.

    Event Fired when Datset item is selected.

    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.ui.ux3.DataSetItem itself
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    detachSelected(fnFunction, oListener): sap.ui.ux3.DataSetItem
    Detaches event handler fnFunction from the selected event of this sap.ui.ux3.DataSetItem.

    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.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    fireSelected(mArguments?): sap.ui.ux3.DataSetItem
    Fires event selected to attached listeners.

    Expects the following event parameters:

    • itemId of type stringId of the selected Datset item
    Parameters:
    {Map}mArguments? The arguments to pass along with the event
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    getCheckable(): boolean
    Gets current value of property checkable.

    checkable

    Default value is true.

    Returns:
    {boolean} Value of property checkable
    getIconSrc(): sap.ui.core.URI
    Gets current value of property iconSrc.

    image

    Returns:
    {sap.ui.core.URI} Value of property iconSrc
    getSubtitle(): string
    Gets current value of property subtitle.

    subtitle

    Default value is Subtitle.

    Returns:
    {string} Value of property subtitle
    getTitle(): string
    Gets current value of property title.

    title

    Default value is Title.

    Returns:
    {string} Value of property title
    setCheckable(bCheckable): sap.ui.ux3.DataSetItem
    Sets a new value for property checkable.

    checkable

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

    Default value is true.

    Parameters:
    {boolean}bCheckable New value for property checkable
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    setIconSrc(sIconSrc): sap.ui.ux3.DataSetItem
    Sets a new value for property iconSrc.

    image

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

    Parameters:
    {sap.ui.core.URI}sIconSrc New value for property iconSrc
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    setSubtitle(sSubtitle): sap.ui.ux3.DataSetItem
    Sets a new value for property subtitle.

    subtitle

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

    Default value is Subtitle.

    Parameters:
    {string}sSubtitle New value for property subtitle
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining
    setTitle(sTitle): sap.ui.ux3.DataSetItem
    Sets a new value for property title.

    title

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

    Default value is Title.

    Parameters:
    {string}sTitle New value for property title
    Returns:
    {sap.ui.ux3.DataSetItem} Reference to this in order to allow method chaining