class sap.m.p13n.BasePanel

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

This control serves as base class for personalization implementations. This base class is faceless and should be inherited to implement control specific personalization panels.


Constructor

Constructor for a new BasePanel.

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.BasePanel(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
enableReorder boolean true

Determines whether the reordering of personalization items should be enabled.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_content 0..1 sap.ui.core.Control

Content to be set for the BasePanel.

_template 0..1 sap.ui.core.Control

This template is going to be set from the implementing panel using the BasePanel control, by setting the template for the columns of the inner sap.m.Table.

messageStrip 0..1 sap.m.MessageStrip

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


Events Overview

Event Description
change

This event is fired if there has been made any change within the BasePanel control.

change

This event is fired if there has been made any change within the BasePanel control.

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

Methods Overview

Method Description
attachChange

Attaches event handler fnFunction to the change event of this sap.m.p13n.BasePanel.

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.p13n.BasePanel itself.

This event is fired if there has been made any change within the BasePanel control.

destroyMessageStrip

Destroys the messageStrip in the aggregation messageStrip.

detachChange

Detaches event handler fnFunction from the change event of this sap.m.p13n.BasePanel.

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

sap.m.p13n.BasePanel.extend

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

fireChange

Fires event change to attached listeners.

getEnableReorder

Gets current value of property enableReorder.

Determines whether the reordering of personalization items should be enabled.

Default value is true.

sap.m.p13n.BasePanel.getMetadata

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

attachChange

Attaches event handler fnFunction to the change event of this sap.m.p13n.BasePanel.

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.p13n.BasePanel itself.

This event is fired if there has been made any change within the BasePanel control.

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.p13n.BasePanel itself

destroyMessageStrip

Destroys the messageStrip in the aggregation messageStrip.

detachChange

Detaches event handler fnFunction from the change event of this sap.m.p13n.BasePanel.

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.p13n.BasePanel.extend

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

fireChange

Fires event change to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getEnableReorder

Gets current value of property enableReorder.

Determines whether the reordering of personalization items should be enabled.

Default value is true.

sap.m.p13n.BasePanel.getMetadata

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