abstract class sap.m.P13nPanel

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

An abstract base type for panels aggregation in P13nDialog control.


Constructor

Constructor for a new P13nPanel.

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.P13nPanel(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
changeNotifier object

Callback which notifies a change on this panel.

Visibility: public
title string

Title text appears in the panel.

Visibility: public
titleLarge string

Large title text appears e.g. in dialog header in case that only one panel is shown.

Since: 1.30.0.

Visibility: public
type string

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

Visibility: public
validationExecutor object

Callback method which is called in order to validate end user entry.

Visibility: public
validationListener object

Callback method which is called in order to register for validation result.

Visibility: public
verticalScrolling boolean true

Enables the vertical Scrolling on the P13nDialog when the panel is shown.

Visibility: public

Aggregations

Default Aggregation: items

Name Cardinality Type Description
items (default) 0..n sap.m.P13nItem

Defines personalization items (e.g. columns in the P13nColumnsPanel).


Events Overview

Event Description
beforeNavigationTo

Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed

Since: 1.28.0.

beforeNavigationTo

Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed

Since: 1.28.0.

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

Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

attachBeforeNavigationTo

Attaches event handler fnFunction to the beforeNavigationTo event of this sap.m.P13nPanel.

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.P13nPanel itself.

Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed

beforeNavigationTo

This method defines the point in time before the panel becomes active.

bindItems

Binds aggregation items to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

destroyItems

Destroys all the items in the aggregation items.

detachBeforeNavigationTo

Detaches event handler fnFunction from the beforeNavigationTo event of this sap.m.P13nPanel.

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

sap.m.P13nPanel.extend

Creates a new subclass of class sap.m.P13nPanel 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.

fireBeforeNavigationTo

Fires event beforeNavigationTo to attached listeners.

getChangeNotifier

Gets current value of property changeNotifier.

Callback which notifies a change on this panel.

getItems

Gets content of aggregation items.

Defines personalization items (e.g. columns in the P13nColumnsPanel).

sap.m.P13nPanel.getMetadata

Returns a metadata object for class sap.m.P13nPanel.

getOkPayload

This method can be overwritten by subclass in order to return a payload for Ok action

Since 1.50 replaced by the event of the respective inherited control, for example {@link sap.m.P13nColumnsPanel#event:changeColumnsItems} of <code>P13nColumnsPanel</code> control.
getResetPayload

This method can be overwritten by subclass in order to return a payload for Reset action

getTitle

Gets current value of property title.

Title text appears in the panel.

getTitleLarge

Gets current value of property titleLarge.

Large title text appears e.g. in dialog header in case that only one panel is shown.

getType

Gets current value of property type.

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

getValidationExecutor

Gets current value of property validationExecutor.

Callback method which is called in order to validate end user entry.

getValidationListener

Gets current value of property validationListener.

Callback method which is called in order to register for validation result.

getVerticalScrolling

Gets current value of property verticalScrolling.

Enables the vertical Scrolling on the P13nDialog when the panel is shown.

Default value is true.

indexOfItem

Checks for the provided sap.m.P13nItem in the aggregation items. and returns its index if found or -1 otherwise.

insertItem

Inserts a item into the aggregation items.

onAfterNavigationFrom

This method can be overwritten by subclass in order to cleanup after navigation, e.g. to remove invalid content on the panel.

onBeforeNavigationFrom

This method can be overwritten by subclass in order to prevent navigation to another panel. This could be the case if some content on the panel is considered 'invalid'.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

setChangeNotifier

Sets a new value for property changeNotifier.

Callback which notifies a change on this panel.

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

setTitle

Sets a new value for property title.

Title text appears in the panel.

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

setTitleLarge

Sets a new value for property titleLarge.

Large title text appears e.g. in dialog header in case that only one panel is shown.

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

setType

Sets a new value for property type.

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

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

setValidationExecutor

Sets a new value for property validationExecutor.

Callback method which is called in order to validate end user entry.

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

setValidationListener

Sets a new value for property validationListener.

Callback method which is called in order to register for validation result.

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

setVerticalScrolling

Sets a new value for property verticalScrolling.

Enables the vertical Scrolling on the P13nDialog when the panel is shown.

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

Default value is true.

unbindItems

Unbinds aggregation items from model data.

addItem

Adds some item to the aggregation items.

Param Type DefaultValue Description
oItem sap.m.P13nItem

The item to add; if empty, nothing is inserted

attachBeforeNavigationTo

Attaches event handler fnFunction to the beforeNavigationTo event of this sap.m.P13nPanel.

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.P13nPanel itself.

Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed

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.m.P13nPanel itself

beforeNavigationTo

This method defines the point in time before the panel becomes active.

bindItems

Binds aggregation items to model data.

See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.

Param Type DefaultValue Description
oBindingInfo sap.ui.base.ManagedObject.AggregationBindingInfo

The binding information

destroyItems

Destroys all the items in the aggregation items.

detachBeforeNavigationTo

Detaches event handler fnFunction from the beforeNavigationTo event of this sap.m.P13nPanel.

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.m.P13nPanel.extend

Creates a new subclass of class sap.m.P13nPanel 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.

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

fireBeforeNavigationTo

Fires event beforeNavigationTo to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getChangeNotifier

Gets current value of property changeNotifier.

Callback which notifies a change on this panel.

getItems

Gets content of aggregation items.

Defines personalization items (e.g. columns in the P13nColumnsPanel).

sap.m.P13nPanel.getMetadata

Returns a metadata object for class sap.m.P13nPanel.

getOkPayload

This method can be overwritten by subclass in order to return a payload for Ok action

Since 1.50 replaced by the event of the respective inherited control, for example {@link sap.m.P13nColumnsPanel#event:changeColumnsItems} of <code>P13nColumnsPanel</code> control.

getResetPayload

This method can be overwritten by subclass in order to return a payload for Reset action

getTitle

Gets current value of property title.

Title text appears in the panel.

getTitleLarge

Gets current value of property titleLarge.

Large title text appears e.g. in dialog header in case that only one panel is shown.

getType

Gets current value of property type.

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

getValidationExecutor

Gets current value of property validationExecutor.

Callback method which is called in order to validate end user entry.

getValidationListener

Gets current value of property validationListener.

Callback method which is called in order to register for validation result.

getVerticalScrolling

Gets current value of property verticalScrolling.

Enables the vertical Scrolling on the P13nDialog when the panel is shown.

Default value is true.

indexOfItem

Checks for the provided sap.m.P13nItem in the aggregation items. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oItem sap.m.P13nItem

The item whose index is looked for

insertItem

Inserts a item into the aggregation items.

Param Type DefaultValue Description
oItem sap.m.P13nItem

The item to insert; if empty, nothing is inserted

iIndex int

The 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position

onAfterNavigationFrom

This method can be overwritten by subclass in order to cleanup after navigation, e.g. to remove invalid content on the panel.

onBeforeNavigationFrom

This method can be overwritten by subclass in order to prevent navigation to another panel. This could be the case if some content on the panel is considered 'invalid'.

removeAllItems

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

removeItem

Removes a item from the aggregation items.

Param Type DefaultValue Description
vItem int string sap.m.P13nItem

The item to remove or its index or id

setChangeNotifier

Sets a new value for property changeNotifier.

Callback which notifies a change on this panel.

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

Param Type DefaultValue Description
oChangeNotifier object

New value for property changeNotifier

setTitle

Sets a new value for property title.

Title text appears in the panel.

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

Param Type DefaultValue Description
sTitle string

New value for property title

setTitleLarge

Sets a new value for property titleLarge.

Large title text appears e.g. in dialog header in case that only one panel is shown.

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

Param Type DefaultValue Description
sTitleLarge string

New value for property titleLarge

setType

Sets a new value for property type.

Panel type for generic use. Due to extensibility reason the type of type property should be string. So it is feasible to add a custom panel without expanding the type.

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

Param Type DefaultValue Description
sType string

New value for property type

setValidationExecutor

Sets a new value for property validationExecutor.

Callback method which is called in order to validate end user entry.

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

Param Type DefaultValue Description
oValidationExecutor object

New value for property validationExecutor

setValidationListener

Sets a new value for property validationListener.

Callback method which is called in order to register for validation result.

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

Param Type DefaultValue Description
oValidationListener object

New value for property validationListener

setVerticalScrolling

Sets a new value for property verticalScrolling.

Enables the vertical Scrolling on the P13nDialog when the panel is shown.

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

Default value is true.

Param Type DefaultValue Description
bVerticalScrolling boolean true

New value for property verticalScrolling

unbindItems

Unbinds aggregation items from model data.