Class sap.m.P13nPanelModule: sap/m/P13nPanel
extends Control
known direct subclasses: P13nColumnsPanel, P13nDimMeasurePanel, P13nFilterPanel, P13nGroupPanel, P13nSortPanel
Base type for panels aggregation in P13nDialog control.
Since: 1.26.0.
Constructor Summary
Event Summary
beforeNavigationTo(oControlEvent)Due to performance the data of the panel can be requested in lazy mode e.g.
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.m.P13nPanel.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.P13nPanel with name
sClassName and enriches it with the information contained in oClassInfo.attachBeforeNavigationTo(oData?, fnFunction, oListener?)Attaches event handler
fnFunction to the beforeNavigationTo event of this sap.m.P13nPanel.detachBeforeNavigationTo(fnFunction, oListener)Detaches event handler
fnFunction from the beforeNavigationTo event of this sap.m.P13nPanel.getResetPayload()This method can be overwritten by subclass in order to return a payload for Reset action
onAfterNavigationFrom()This method can be overwritten by subclass in order to cleanup after navigation, e.g.
onBeforeNavigationFrom()This method can be overwritten by subclass in order to prevent navigation to another panel.
Methods borrowed from class sap.ui.core.Control
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
Methods borrowed from class sap.ui.core.Element
$, 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
Methods borrowed from class sap.ui.base.ManagedObject
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
Methods borrowed from class sap.ui.base.EventProvider
Constructor Detail
new sap.m.P13nPanel(sId?, mSettings?)
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 for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- title : string
- titleLarge : string
- type : string
- verticalScrolling : boolean (default: true)
- validationExecutor : object
- validationListener : object
- changeNotifier : object
- Aggregations
- items : sap.m.P13nItem[] (default)
- Events
- beforeNavigationTo : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Control 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
beforeNavigationTo(oControlEvent)
Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
- Since:
- 1.28.0
Method Detail
sap.m.P13nPanel.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.
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 |
sap.m.P13nPanel.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nPanel.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
addItem(oItem): sap.m.P13nPanel
Adds some item to the aggregation
items. Parameters:
| {sap.m.P13nItem} | oItem | the item to add; if empty, nothing is inserted |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
attachBeforeNavigationTo(oData?, fnFunction, oListener?): sap.m.P13nPanel
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
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.P13nPanel itself |
- Since:
- 1.28.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
bindItems(oBindingInfo): sap.m.P13nPanel
Binds aggregation
items to model data. See ManagedObject.bindAggregation for a detailed description of the possible properties of oBindingInfo.
Parameters:
| {object} | oBindingInfo | The binding information |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
destroyItems(): sap.m.P13nPanel
Destroys all the items in the aggregation
items. - Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
detachBeforeNavigationTo(fnFunction, oListener): sap.m.P13nPanel
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.
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.28.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
fireBeforeNavigationTo(mArguments?): sap.m.P13nPanel
Fires event
beforeNavigationTo to attached listeners. Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
- Since:
- 1.28.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
getChangeNotifier(): object
Gets current value of property
changeNotifier. Callback which notifies a change on this panel.
Returns:
| {object} | Value of property changeNotifier |
getItems(): sap.m.P13nItem[]
Gets content of aggregation
items. Aggregation of items
- Since:
- 1.26.0
Returns:
| {sap.m.P13nItem[]} |
getOkPayload()
This method can be overwritten by subclass in order to return a payload for Ok action
- Since:
- 1.26.7
getResetPayload()
This method can be overwritten by subclass in order to return a payload for Reset action
- Since:
- 1.28.0
getTitle(): string
Gets current value of property
title. Title text appears in the panel.
- Since:
- 1.26.0
Returns:
| {string} | Value of property title |
getTitleLarge(): string
Gets current value of property
titleLarge. Large title text appears e.g. in dialog header in case that only one panel is shown.
- Since:
- 1.30.0
Returns:
| {string} | Value of property titleLarge |
getType(): string
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.
- Since:
- 1.26.0
Returns:
| {string} | Value of property type |
getValidationExecutor(): object
Gets current value of property
validationExecutor. Callback method which is called in order to validate end user entry.
Returns:
| {object} | Value of property validationExecutor |
getValidationListener(): object
Gets current value of property
validationListener. Callback method which is called in order to register for validation result.
Returns:
| {object} | Value of property validationListener |
getVerticalScrolling(): boolean
Gets current value of property
verticalScrolling. Enables the vertical Scrolling on the P13nDialog when the panel is shown.
Default value is true.
- Since:
- 1.26.0
Returns:
| {boolean} | Value of property verticalScrolling |
indexOfItem(oItem): int
Checks for the provided
sap.m.P13nItem in the aggregation items. and returns its index if found or -1 otherwise. Parameters:
| {sap.m.P13nItem} | oItem | The item whose index is looked for |
- Since:
- 1.26.0
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
insertItem(oItem, iIndex): sap.m.P13nPanel
Inserts a item into the aggregation
items. Parameters:
| {sap.m.P13nItem} | oItem | the item to insert; if empty, nothing is inserted |
| {int} | iIndex | 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 |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
onAfterNavigationFrom()
This method can be overwritten by subclass in order to cleanup after navigation, e.g. to remove invalid content on the panel.
- Since:
- 1.28.0
onBeforeNavigationFrom(): boolean
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'.
- Since:
- 1.28.0
Returns:
| {boolean} | true if it is allowed to navigate away from this panel, false if it is not allowed |
removeAllItems(): sap.m.P13nItem[]
Removes all the controls from the aggregation
items. Additionally, it unregisters them from the hosting UIArea.
- Since:
- 1.26.0
Returns:
| {sap.m.P13nItem[]} | An array of the removed elements (might be empty) |
removeItem(vItem): sap.m.P13nItem
Removes a item from the aggregation
items. Parameters:
| {int|string|sap.m.P13nItem} | vItem | The itemto remove or its index or id |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nItem} | The removed item or null |
setChangeNotifier(oChangeNotifier): sap.m.P13nPanel
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.
Parameters:
| {object} | oChangeNotifier | New value for property changeNotifier |
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setTitle(sTitle): sap.m.P13nPanel
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.
Parameters:
| {string} | sTitle | New value for property title |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setTitleLarge(sTitleLarge): sap.m.P13nPanel
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.
Parameters:
| {string} | sTitleLarge | New value for property titleLarge |
- Since:
- 1.30.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setType(sType): sap.m.P13nPanel
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.
Parameters:
| {string} | sType | New value for property type |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setValidationExecutor(oValidationExecutor): sap.m.P13nPanel
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.
Parameters:
| {object} | oValidationExecutor | New value for property validationExecutor |
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setValidationListener(oValidationListener): sap.m.P13nPanel
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.
Parameters:
| {object} | oValidationListener | New value for property validationListener |
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
setVerticalScrolling(bVerticalScrolling): sap.m.P13nPanel
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.
Parameters:
| {boolean} | bVerticalScrolling | New value for property verticalScrolling |
- Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |
unbindItems(): sap.m.P13nPanel
Unbinds aggregation
items from model data. - Since:
- 1.26.0
Returns:
| {sap.m.P13nPanel} | Reference to this in order to allow method chaining |