class sap.m.p13n.SelectionPanel

Control sample: sap.m.p13n.SelectionPanel
Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/p13n/SelectionPanel
Application Component: CA-UI5-CTR

This control can be used as personalization panel to define content that may be added/removed for an associated control instance during runtime by the user.


Constructor

Constructor for a new SelectionPanel.

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.m.p13n.SelectionPanel(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
activeColumn string empty string

The secondary column in the panel showing the movement buttons for reordering.

Visibility: public
enableCount boolean false

Enables a count for selected items compared to available items as ' (3 / 12)' in addition for the first provided column text

Visibility: public
fieldColumn string ...see text or source

The first column in the panel describing the selectable fields.

Visibility: public
itemFactory function

An optional callback that may be used to display additional custom content in each selectable item. This factory can be toggled by executing the sap.m.p13n.SelectionPanel#showFactory method.

Visibility: public
showHeader boolean false

Shows an additional header with a SearchField and 'Show Selected' button

Visibility: public

Borrowed Properties

Name Type Default Value Description
enableReorder boolean true

Determines whether the reordering of personalization items should be enabled.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
messageStrip 0..1 sap.m.MessageStrip

Defines an optional message strip to be displayed in the content area


Methods Overview

Method Description
sap.m.p13n.SelectionPanel.extend

Creates a new subclass of class sap.m.p13n.SelectionPanel with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.p13n.BasePanel.extend.

getActiveColumn

Gets current value of property activeColumn.

The secondary column in the panel showing the movement buttons for reordering.

Default value is empty string.

getEnableCount

Gets current value of property enableCount.

Enables a count for selected items compared to available items as ' (3 / 12)' in addition for the first provided column text

Default value is false.

getFieldColumn

Gets current value of property fieldColumn.

The first column in the panel describing the selectable fields.

Default value is ...see text or source.

getItemFactory

Gets current value of property itemFactory.

An optional callback that may be used to display additional custom content in each selectable item. This factory can be toggled by executing the sap.m.p13n.SelectionPanel#showFactory method.

sap.m.p13n.SelectionPanel.getMetadata

Returns a metadata object for class sap.m.p13n.SelectionPanel.

getShowHeader

Gets current value of property showHeader.

Shows an additional header with a SearchField and 'Show Selected' button

Default value is false.

setActiveColumn

Sets a new value for property activeColumn.

The secondary column in the panel showing the movement buttons for reordering.

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

Default value is empty string.

setEnableCount

Sets a new value for property enableCount.

Enables a count for selected items compared to available items as ' (3 / 12)' in addition for the first provided column text

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

Default value is false.

setFieldColumn

Sets a new value for property fieldColumn.

The first column in the panel describing the selectable fields.

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

Default value is ...see text or source.

setItemFactory

Sets a new value for property itemFactory.

An optional callback that may be used to display additional custom content in each selectable item. This factory can be toggled by executing the sap.m.p13n.SelectionPanel#showFactory method.

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

setShowHeader

Sets a new value for property showHeader.

Shows an additional header with a SearchField and 'Show Selected' button

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

Default value is false.

sap.m.p13n.SelectionPanel.extend

Creates a new subclass of class sap.m.p13n.SelectionPanel with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.p13n.BasePanel.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

getActiveColumn

Gets current value of property activeColumn.

The secondary column in the panel showing the movement buttons for reordering.

Default value is empty string.

getEnableCount

Gets current value of property enableCount.

Enables a count for selected items compared to available items as ' (3 / 12)' in addition for the first provided column text

Default value is false.

getFieldColumn

Gets current value of property fieldColumn.

The first column in the panel describing the selectable fields.

Default value is ...see text or source.

getItemFactory

Gets current value of property itemFactory.

An optional callback that may be used to display additional custom content in each selectable item. This factory can be toggled by executing the sap.m.p13n.SelectionPanel#showFactory method.

sap.m.p13n.SelectionPanel.getMetadata

Returns a metadata object for class sap.m.p13n.SelectionPanel.

getShowHeader

Gets current value of property showHeader.

Shows an additional header with a SearchField and 'Show Selected' button

Default value is false.

setActiveColumn

Sets a new value for property activeColumn.

The secondary column in the panel showing the movement buttons for reordering.

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

Default value is empty string.

Param Type DefaultValue Description
sActiveColumn string ""

New value for property activeColumn

setEnableCount

Sets a new value for property enableCount.

Enables a count for selected items compared to available items as ' (3 / 12)' in addition for the first provided column text

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

Default value is false.

Param Type DefaultValue Description
bEnableCount boolean false

New value for property enableCount

setFieldColumn

Sets a new value for property fieldColumn.

The first column in the panel describing the selectable fields.

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

Default value is ...see text or source.

Param Type DefaultValue Description
sFieldColumn string ...see text or source

New value for property fieldColumn

setItemFactory

Sets a new value for property itemFactory.

An optional callback that may be used to display additional custom content in each selectable item. This factory can be toggled by executing the sap.m.p13n.SelectionPanel#showFactory method.

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

Param Type DefaultValue Description
fnItemFactory function

New value for property itemFactory

setShowHeader

Sets a new value for property showHeader.

Shows an additional header with a SearchField and 'Show Selected' button

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

Default value is false.

Param Type DefaultValue Description
bShowHeader boolean false

New value for property showHeader