The P13nDialog control provides a dialog that contains one or more panels. On each of the panels, one or more changes with regards to a table can be processed. For example, a panel to set a column to invisible, change the order of the columns or a panel to sort or filter tables.
Constructor for a new P13nDialog.
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.P13nDialog(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 |
---|---|---|---|
initialVisiblePanelType | string | This property determines which panel is initially shown when dialog is opened. If not defined then the first visible panel of |
|
showReset | boolean | false | This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the 'Reset' button will trigger the |
showResetEnabled | boolean | false | This property determines whether the 'Restore' button is enabled and is taken into account only if |
validationExecutor | object | Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order to perform cross-model validation checks. Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
closeOnNavigation | boolean | true | Indicates whether the Dialog will be closed automatically when a routing navigation occurs. |
contentHeight | sap.ui.core.CSSSize | Preferred height of the content in the Dialog. If the preferred height is bigger than the available space on a screen, it will be overwritten by the maximum available height on a screen in order to make sure that the Dialog isn't cut off. |
|
contentWidth | sap.ui.core.CSSSize | Preferred width of the content in the Dialog. This property affects the width of the Dialog on a phone in landscape mode, a tablet or a desktop, because the Dialog has a fixed width on a phone in portrait mode. If the preferred width is less than the minimum width of the Dialog or more than the available width of the screen, it will be overwritten by the min or max value. The current mininum value of the Dialog width on tablet is 400px. |
|
draggable | boolean | false | Indicates whether the Dialog is draggable. If this property is set to |
escapeHandler | function | This property expects a function with one parameter of type Promise. In the function, you should call either |
|
horizontalScrolling | boolean | true | Indicates if the user can scroll horizontally inside the Dialog when the content is bigger than the content area. The Dialog detects if there's |
icon | sap.ui.core.URI | Icon displayed in the Dialog header. This |
|
resizable | boolean | false | Indicates whether the Dialog is resizable. If this property is set to |
showHeader | boolean | true | Determines whether the header is shown inside the Dialog. If this property is set to |
state | sap.ui.core.ValueState | None | Affects the If a value other than |
stretch | boolean | false | Determines if the Dialog will be stretched to full screen on mobile. On desktop, the Dialog will be stretched to approximately 90% of the viewport. This property is only applicable to a Standard Dialog. Message-type Dialog ignores it. |
stretchOnPhone | boolean | false | Determines whether the Dialog will be displayed on full screen on a phone. |
title | string | Title text appears in the Dialog header. Visibility: public |
|
titleAlignment | sap.m.TitleAlignment | Auto | Specifies the Title alignment (theme specific). If set to |
type | sap.m.DialogType | Standard | The |
verticalScrolling | boolean | true | Indicates if the user can scroll vertically inside the Dialog when the content is bigger than the content area. The Dialog detects if there's |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
panels | 0..n | sap.m.P13nPanel |
The dialog panels displayed in the dialog. |
Name | Cardinality | Type | Description |
---|---|---|---|
beginButton | 0..1 | sap.m.Button |
The button which is rendered to the left side (right side in RTL mode) of the |
buttons | 0..n | sap.m.Button |
Buttons can be added to the footer area of the Dialog through this aggregation. When this aggregation is set, any change to the |
content | 0..n | sap.ui.core.Control |
The content inside the Dialog. |
customHeader | 0..1 | sap.m.IBar |
When it is set, the |
endButton | 0..1 | sap.m.Button |
The button which is rendered to the right side (left side in RTL mode) of the |
subHeader | 0..1 | sap.m.IBar |
When a |
Event fired if the 'cancel' button in P13nDialog
is clicked.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object |
Method | Description |
---|---|
addPanel |
Adds some panel to the aggregation panels. |
attachCancel |
Attaches event handler When called, the context of the event handler (its Event fired if the 'cancel' button in |
attachOk |
Attaches event handler When called, the context of the event handler (its Event fired if the 'ok' button in |
attachReset |
Attaches event handler When called, the context of the event handler (its Event fired if the 'reset' button in |
bindPanels |
Binds aggregation panels to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of |
destroyPanels |
Destroys all the panels in the aggregation panels. |
detachCancel |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachOk |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachReset |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.P13nDialog.extend |
Creates a new subclass of class sap.m.P13nDialog with name
|
fireCancel |
Fires event cancel to attached listeners. |
fireOk |
Fires event ok to attached listeners. |
fireReset |
Fires event reset to attached listeners. |
getInitialVisiblePanelType |
Gets current value of property initialVisiblePanelType. This property determines which panel is initially shown when dialog is opened. If not defined then the first visible panel of |
sap.m.P13nDialog.getMetadata |
Returns a metadata object for class sap.m.P13nDialog. |
getPanels |
Gets content of aggregation panels. The dialog panels displayed in the dialog. |
getShowReset |
Gets current value of property showReset. This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the 'Reset' button will trigger the Default value is |
getShowResetEnabled |
Gets current value of property showResetEnabled. This property determines whether the 'Restore' button is enabled and is taken into account only if Default value is |
getValidationExecutor |
Gets current value of property validationExecutor. Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order to perform cross-model validation checks. |
getVisiblePanel |
Returns visible panel. |
indexOfPanel |
Checks for the provided |
insertPanel |
Inserts a panel into the aggregation panels. |
removeAllPanels |
Removes all the controls from the aggregation panels. Additionally, it unregisters them from the hosting UIArea. |
removePanel |
Removes a panel from the aggregation panels. |
setInitialVisiblePanelType |
Sets a new value for property initialVisiblePanelType. This property determines which panel is initially shown when dialog is opened. If not defined then the first visible panel of When called with a value of |
setShowReset |
Sets a new value for property showReset. This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the 'Reset' button will trigger the When called with a value of Default value is |
setShowResetEnabled |
Sets a new value for property showResetEnabled. This property determines whether the 'Restore' button is enabled and is taken into account only if When called with a value of Default value is |
setValidationExecutor |
Sets a new value for property validationExecutor. Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order to perform cross-model validation checks. When called with a value of |
unbindPanels |
Unbinds aggregation panels from model data. |
Adds some panel to the aggregation panels.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPanel | sap.m.P13nPanel |
The panel to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the cancel event of this sap.m.P13nDialog
.
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.P13nDialog
itself.
Event fired if the 'cancel' button in P13nDialog
is clicked.
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 |
Attaches event handler fnFunction
to the ok event of this sap.m.P13nDialog
.
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.P13nDialog
itself.
Event fired if the 'ok' button in P13nDialog
is clicked.
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 |
Attaches event handler fnFunction
to the reset event of this sap.m.P13nDialog
.
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.P13nDialog
itself.
Event fired if the 'reset' button in P13nDialog
is clicked.
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 |
Binds aggregation panels 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 |
Detaches event handler fnFunction
from the cancel event of this sap.m.P13nDialog
.
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 |
Detaches event handler fnFunction
from the ok event of this sap.m.P13nDialog
.
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 |
Detaches event handler fnFunction
from the reset event of this sap.m.P13nDialog
.
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 |
Creates a new subclass of class sap.m.P13nDialog 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.Dialog.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 |
Fires event cancel to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event ok to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event reset to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Gets current value of property initialVisiblePanelType.
This property determines which panel is initially shown when dialog is opened. If not defined then the first visible panel of panels
aggregation is taken. Setting value after the dialog is opened has no effect anymore. Due to extensibility reason the type should be string
. So it is feasible to add a custom panel without expanding the type.
Gets current value of property showReset.
This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the 'Reset' button will trigger the reset
event sending a notification that model data must be reset.
Default value is false
.
Gets current value of property showResetEnabled.
This property determines whether the 'Restore' button is enabled and is taken into account only if showReset
is set to true
.
Default value is false
.
Gets current value of property validationExecutor.
Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order to perform cross-model validation checks.
Checks for the provided sap.m.P13nPanel
in the aggregation panels. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPanel | sap.m.P13nPanel |
The panel whose index is looked for |
Inserts a panel into the aggregation panels.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPanel | sap.m.P13nPanel |
The panel to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation panels.
Additionally, it unregisters them from the hosting UIArea.
Removes a panel from the aggregation panels.
Param | Type | DefaultValue | Description |
---|---|---|---|
vPanel | int string sap.m.P13nPanel |
The panel to remove or its index or id |
Sets a new value for property initialVisiblePanelType.
This property determines which panel is initially shown when dialog is opened. If not defined then the first visible panel of panels
aggregation is taken. Setting value after the dialog is opened has no effect anymore. Due to extensibility reason the type 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 |
---|---|---|---|
sInitialVisiblePanelType | string |
New value for property |
Sets a new value for property showReset.
This property determines whether the 'Restore' button is shown inside the dialog. If this property is set to true, clicking the 'Reset' button will trigger the reset
event sending a notification that model data must be reset.
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 |
---|---|---|---|
bShowReset | boolean | false |
New value for property |
Sets a new value for property showResetEnabled.
This property determines whether the 'Restore' button is enabled and is taken into account only if showReset
is set to true
.
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 |
---|---|---|---|
bShowResetEnabled | boolean | false |
New value for property |
Sets a new value for property validationExecutor.
Calls the validation listener once all panel-relevant validation checks have been done. This callback function is called in order to perform cross-model validation checks.
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 |