An abstract base type for panels
aggregation in P13nDialog
control.
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 |
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. |
|
type | string | Panel type for generic use. Due to extensibility reason the type of |
|
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 |
Default Aggregation: items
Name | Cardinality | Type | Description |
---|---|---|---|
items (default) | 0..n | sap.m.P13nItem |
Defines personalization items (e.g. columns in the |
Event | Description |
---|---|
beforeNavigationTo |
Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
attachBeforeNavigationTo |
Attaches event handler When called, the context of the event handler (its 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 |
destroyItems |
Destroys all the items in the aggregation items. |
detachBeforeNavigationTo |
Detaches event handler 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
|
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 |
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 |
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 Default value is |
indexOfItem |
Checks for the provided |
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 |
setTitle |
Sets a new value for property title. Title text appears in the panel. When called with a value of |
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 |
setType |
Sets a new value for property type. Panel type for generic use. Due to extensibility reason the type of When called with a value of |
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 |
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 |
setVerticalScrolling |
Sets a new value for property verticalScrolling. Enables the vertical Scrolling on the When called with a value of Default value is |
unbindItems |
Unbinds aggregation items from model data. |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.m.P13nItem |
The item to add; if empty, nothing is inserted |
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 |
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 |
Gets current value of property changeNotifier.
Callback which notifies a change on this panel.
Gets content of aggregation items.
Defines personalization items (e.g. columns in the P13nColumnsPanel
).
This method can be overwritten by subclass in order to return a payload for Ok action
This method can be overwritten by subclass in order to return a payload for Reset action
Gets current value of property titleLarge.
Large title text appears e.g. in dialog header in case that only one panel is shown.
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.
Gets current value of property validationExecutor.
Callback method which is called in order to validate end user entry.
Gets current value of property validationListener.
Callback method which is called in order to register for validation result.
Gets current value of property verticalScrolling.
Enables the vertical Scrolling on the P13nDialog
when the panel is shown.
Default value is true
.
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 |
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 |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |