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.
Since: 1.26.0.
Event Summary
cancel(oControlEvent)Event fired if the 'cancel' button in P13nDialog is clicked. ok(oControlEvent)Event fired if the 'ok' button in P13nDialog is clicked. reset(oControlEvent)Event fired if the 'reset' button in P13nDialog is clicked. Method Summary
sap.m.P13nDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nDialog with name sClassName and enriches it with the information contained in oClassInfo. addPanel(oPanel)Adds some panel to the aggregation panels. attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.m.P13nDialog. attachOk(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ok event of this sap.m.P13nDialog. attachReset(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the reset event of this sap.m.P13nDialog. bindPanels(oBindingInfo)Binds aggregation panels to model data. destroyPanels()Destroys all the panels in the aggregation panels. detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.m.P13nDialog. detachOk(fnFunction, oListener)Detaches event handler fnFunction from the ok event of this sap.m.P13nDialog. detachReset(fnFunction, oListener)Detaches event handler fnFunction from the reset event of this sap.m.P13nDialog. fireCancel(mArguments?)Fires event cancel to attached listeners. fireOk(mArguments?)Fires event ok to attached listeners. fireReset(mArguments?)Fires event reset to attached listeners. getPanels()Gets content of aggregation panels. indexOfPanel(oPanel)Checks for the provided sap.m.P13nPanel in the aggregation panels. insertPanel(oPanel, iIndex)Inserts a panel into the aggregation panels. removePanel(vPanel)Removes a panel from the aggregation panels. setShowReset(bShowReset)Sets a new value for property showReset. _getAnyHeader,
addAriaDescribedBy,
addAriaLabelledBy,
addButton,
addContent,
attachAfterClose,
attachAfterOpen,
attachBeforeClose,
attachBeforeOpen,
close,
destroyBeginButton,
destroyButtons,
destroyContent,
destroyCustomHeader,
destroyEndButton,
destroySubHeader,
detachAfterClose,
detachAfterOpen,
detachBeforeClose,
detachBeforeOpen,
fireAfterClose,
fireAfterOpen,
fireBeforeClose,
fireBeforeOpen,
getAriaDescribedBy,
getAriaLabelledBy,
getBeginButton,
getButtons,
getContent,
getContentHeight,
getContentWidth,
getCustomHeader,
getDraggable,
getEndButton,
getHorizontalScrolling,
getIcon,
getInitialFocus,
getLeftButton,
getResizable,
getRightButton,
getShowHeader,
getState,
getStretch,
getStretchOnPhone,
getSubHeader,
getTitle,
getType,
getVerticalScrolling,
indexOfButton,
indexOfContent,
insertButton,
insertContent,
isOpen,
open,
removeAllAriaDescribedBy,
removeAllAriaLabelledBy,
removeAllButtons,
removeAllContent,
removeAriaDescribedBy,
removeAriaLabelledBy,
removeButton,
removeContent,
setBeginButton,
setContentHeight,
setContentWidth,
setCustomHeader,
setDraggable,
setEndButton,
setHorizontalScrolling,
setIcon,
setInitialFocus,
setLeftButton,
setResizable,
setRightButton,
setShowHeader,
setState,
setStretch,
setStretchOnPhone,
setSubHeader,
setTitle,
setType,
setVerticalScrolling addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.m.P13nDialog(sId?, mSettings?)
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 for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- Aggregations
- Events
- ok : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- cancel : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- reset : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.m.Dialog can be used as well.
Parameters:
| {string} | sId? | ID for the new control, generated automatically if no ID is given |
| {object} | mSettings? | initial settings for the new control |
Event Detail
cancel(oControlEvent)
Event fired if the 'cancel' button in P13nDialog is clicked.
Parameters:
- Since:
- 1.26.0
ok(oControlEvent)
Event fired if the 'ok' button in P13nDialog is clicked.
Parameters:
- Since:
- 1.26.0
reset(oControlEvent)
Event fired if the 'reset' button in P13nDialog is clicked.
Parameters:
- Since:
- 1.26.0
Method Detail
sap.m.P13nDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.
Parameters:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
Returns a metadata object for class sap.m.P13nDialog.
Returns:
Adds some panel to the aggregation panels.
Parameters:
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.P13nDialog itself |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.P13nDialog itself |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.m.P13nDialog itself |
- Since:
- 1.26.0
Returns:
Parameters:
| {object} | oBindingInfo | The binding information |
- Since:
- 1.26.0
Returns:
Destroys all the panels in the aggregation panels.
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
- Since:
- 1.26.0
Returns:
Fires event cancel to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.26.0
Returns:
Fires event ok to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.26.0
Returns:
Fires event reset to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.26.0
Returns:
getInitialVisiblePanelType(): string
Gets current value of property
initialVisiblePanelType.
This property determines which panel is initially shown when dialog is opened. Due to extensibility reason the type should be string. So it is feasible to add a custom panel without expanding the type.
- Since:
- 1.26.0
Returns:
| {string} | Value of property initialVisiblePanelType |
Gets content of aggregation
panels.
The dialog panels displayed in the dialog.
- Since:
- 1.26.0
Returns:
getShowReset(): boolean
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.
- Since:
- 1.26.0
Returns:
| {boolean} | Value of property showReset |
getShowResetEnabled(): boolean
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.
- Since:
- 1.36.0
Returns:
| {boolean} | Value of property showResetEnabled |
getValidationExecutor(): object
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.
Returns:
| {object} | Value of property validationExecutor |
Returns visible panel.
- Since:
- 1.26.0
Returns:
indexOfPanel(oPanel): int
Checks for the provided sap.m.P13nPanel in the aggregation panels. and returns its index if found or -1 otherwise.
Parameters:
- Since:
- 1.26.0
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a panel into the aggregation panels.
Parameters:
| {sap.m.P13nPanel} | oPanel | the panel to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the panel should be inserted at; for a negative value of iIndex, the panel is inserted at position 0; for a value greater than the current size of the aggregation, the panel is inserted at the last position |
- Since:
- 1.26.0
Returns:
Removes all the controls from the aggregation
panels.
Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.26.0
Returns:
Removes a panel from the aggregation panels.
Parameters:
- Since:
- 1.26.0
Returns:
Sets a new value for property
initialVisiblePanelType.
This property determines which panel is initially shown when dialog is opened. 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.
Parameters:
| {string} | sInitialVisiblePanelType | New value for property initialVisiblePanelType |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {boolean} | bShowReset | New value for property showReset |
- Since:
- 1.26.0
Returns:
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.
Parameters:
| {boolean} | bShowResetEnabled | New value for property showResetEnabled |
- Since:
- 1.36.0
Returns:
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.
Parameters:
| {object} | oValidationExecutor | New value for property validationExecutor |
Returns:
Unbinds aggregation panels from model data.
- Since:
- 1.26.0
Returns: