abstract class sap.ui.table.plugins.SelectionPlugin

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/table/plugins/SelectionPlugin
Application Component: CA-UI5-TBL

Implements the selection methods for a table.


Constructor

Constructs an instance of sap.ui.table.plugins.SelectionPlugin

The following restrictions apply:

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.table.plugins.SelectionPlugin()

Properties

Name Type Default Value Description
selectionMode sap.ui.table.SelectionMode MultiToggle

Defines whether single or multiple items can be selected.

Visibility: hidden

Events Overview

Event Description
selectionChange

This event is fired when the selection is changed.

selectionChange

This event is fired when the selection is changed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.table.plugins.SelectionPlugin.

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.table.plugins.SelectionPlugin itself.

This event is fired when the selection is changed.

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.table.plugins.SelectionPlugin.

The passed function and listener object must match the ones used for event registration.

sap.ui.table.plugins.SelectionPlugin.extend

Creates a new subclass of class sap.ui.table.plugins.SelectionPlugin 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.

fireSelectionChange

Fires event selectionChange to attached listeners.

sap.ui.table.plugins.SelectionPlugin.getMetadata

Returns a metadata object for class sap.ui.table.plugins.SelectionPlugin.

attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.table.plugins.SelectionPlugin.

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.table.plugins.SelectionPlugin itself.

This event is fired when the selection is changed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.table.plugins.SelectionPlugin itself

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.table.plugins.SelectionPlugin.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.table.plugins.SelectionPlugin.extend

Creates a new subclass of class sap.ui.table.plugins.SelectionPlugin 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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireSelectionChange

Fires event selectionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

sap.ui.table.plugins.SelectionPlugin.getMetadata

Returns a metadata object for class sap.ui.table.plugins.SelectionPlugin.