Class sap.m.P13nPanelModule: sap/m/P13nPanel

extends Control

Base type for panels aggregation in P13nDialog control.
Since: 1.26.0.
Constructor Summary
new sap.m.P13nPanel(sId?, mSettings?)Constructor for a new P13nPanel.
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
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.
sap.m.P13nPanel.getMetadata()Returns a metadata object for class sap.m.P13nPanel.
addItem(oItem)Adds some item to the aggregation items.
attachBeforeNavigationTo(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeNavigationTo event of this sap.m.P13nPanel.
beforeNavigationTo()This method defines the point in time before the panel becomes active.
bindItems(oBindingInfo)Binds aggregation items to model data.
destroyItems()Destroys all the items in the aggregation items.
detachBeforeNavigationTo(fnFunction, oListener)Detaches event handler fnFunction from the beforeNavigationTo event of this sap.m.P13nPanel.
fireBeforeNavigationTo(mParameters?)Fires event beforeNavigationTo to attached listeners.
getChangeNotifier()Gets current value of property changeNotifier.
getItems()Gets content of aggregation items.
getOkPayload()This method can be overwritten by subclass in order to return a payload for Ok action
getResetPayload()This method can be overwritten by subclass in order to return a payload for Reset action
getTitle()Gets current value of property title.
getTitleLarge()Gets current value of property titleLarge.
getType()Gets current value of property type.
getValidationExecutor()Gets current value of property validationExecutor.
getValidationListener()Gets current value of property validationListener.
getVerticalScrolling()Gets current value of property verticalScrolling.
indexOfItem(oItem)Checks for the provided sap.m.P13nItem in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
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.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setChangeNotifier(oChangeNotifier)Sets a new value for property changeNotifier.
setTitle(sTitle)Sets a new value for property title.
setTitleLarge(sTitleLarge)Sets a new value for property titleLarge.
setType(sType)Sets a new value for property type.
setValidationExecutor(oValidationExecutor)Sets a new value for property validationExecutor.
setValidationListener(oValidationListener)Sets a new value for property validationListener.
setVerticalScrolling(bVerticalScrolling)Sets a new value for property verticalScrolling.
unbindItems()Unbinds aggregation items from model data.
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:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?ID for the new control, generated automatically if no ID is given
objectmSettings?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.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.P13nPanel.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.P13nPanel.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addItem(oItem): sap.m.P13nPanel
Adds some item to the aggregation items.
Parameters:
sap.m.P13nItemoItemthe item to add; if empty, nothing is inserted
Returns:
sap.m.P13nPanelReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.m.P13nPanel itself
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
Since:
1.28.0
beforeNavigationTo()
This method defines the point in time before the panel becomes active.
Since:
1.28.0
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:
objectoBindingInfoThe binding information
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
destroyItems(): sap.m.P13nPanel
Destroys all the items in the aggregation items.
Returns:
sap.m.P13nPanelReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
Since:
1.28.0
fireBeforeNavigationTo(mParameters?): sap.m.P13nPanel
Fires event beforeNavigationTo to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
Since:
1.28.0
getChangeNotifier(): object

Gets current value of property changeNotifier.

Callback which notifies a change on this panel.

Returns:
objectValue of property changeNotifier
getItems(): sap.m.P13nItem[]

Gets content of aggregation items.

Defines personalization items (e.g. columns in the P13nColumnsPanel).

Returns:
sap.m.P13nItem[]
getOkPayload(): object
This method can be overwritten by subclass in order to return a payload for Ok action
Returns:
objectObject which describes the state after Ok has been pressed
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.

Returns:
stringValue 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.

Returns:
stringValue of property titleLarge
Since:
1.30.0
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.

Returns:
stringValue of property type
getValidationExecutor(): object

Gets current value of property validationExecutor.

Callback method which is called in order to validate end user entry.

Returns:
objectValue of property validationExecutor
getValidationListener(): object

Gets current value of property validationListener.

Callback method which is called in order to register for validation result.

Returns:
objectValue 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.

Returns:
booleanValue 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.P13nItemoItemThe item whose index is looked for
Returns:
intThe 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.P13nItemoItemthe item to insert; if empty, nothing is inserted
intiIndexthe 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
Returns:
sap.m.P13nPanelReference 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'.
Returns:
booleantrue if it is allowed to navigate away from this panel, false if it is not allowed
Since:
1.28.0
removeAllItems(): sap.m.P13nItem[]

Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

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.P13nItemvItemThe item to remove or its index or id
Returns:
sap.m.P13nItemThe 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:
objectoChangeNotifierNew value for property changeNotifier
Returns:
sap.m.P13nPanelReference 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:
stringsTitleNew value for property title
Returns:
sap.m.P13nPanelReference 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:
stringsTitleLargeNew value for property titleLarge
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
Since:
1.30.0
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:
stringsTypeNew value for property type
Returns:
sap.m.P13nPanelReference 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:
objectoValidationExecutorNew value for property validationExecutor
Returns:
sap.m.P13nPanelReference 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:
objectoValidationListenerNew value for property validationListener
Returns:
sap.m.P13nPanelReference 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:
booleanbVerticalScrollingNew value for property verticalScrolling
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining
unbindItems(): sap.m.P13nPanel
Unbinds aggregation items from model data.
Returns:
sap.m.P13nPanelReference to this in order to allow method chaining