The public facade of the sap.m.SelectionDetails control.
Describes the public facade of the sap.m.SelectionDetails control.
new sap.m.SelectionDetailsFacade()
Method | Description |
---|---|
addAction |
Adds some action to the aggregation actions. |
addActionGroup |
Adds some actionGroup to the aggregation actionGroups. |
attachActionPress |
Attaches event handler When called, the context of the event handler (its Event is triggered when a custom action is pressed. |
attachBeforeClose |
Attaches event handler When called, the context of the event handler (its Event is triggered before the popover is closed. |
attachBeforeOpen |
Attaches event handler When called, the context of the event handler (its Event is triggered before the popover is open. |
attachNavigate |
Attaches event handler When called, the context of the event handler (its Event is triggered after a list item of sap.m.SelectionDetailsItem is pressed. |
close |
Closes SelectionDetails if open. |
detachActionPress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachBeforeClose |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachBeforeOpen |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachNavigate |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
getWrapLabels |
Returns |
isEnabled |
Returns true if the SelectionDetails is enabled, otherwise false. |
isOpen |
Returns true if the SelectionDetails is open, otherwise false. |
navTo |
Wraps the given content in page, adds it to existing NavContainer and navigates to this newly created page. Has no effect if the SelectionDetails is closed. Lazily processes dependencies for the navigation event. |
removeAction |
Removes a action from the aggregation actions. |
removeActionGroup |
Removes a actionGroup from the aggregation actionGroups. |
removeAllActionGroups |
Removes all the controls from the aggregation actionGroups. Additionally, it unregisters them from the hosting UIArea. |
removeAllActions |
Removes all the controls from the aggregation actions. Additionally, it unregisters them from the hosting UIArea. |
setWrapLabels |
Enables line wrapping for the labels of the of the sap.m.SelectionDetailsItemLine elements. |
Adds some action to the aggregation actions.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAction | sap.ui.core.Item |
The action to add; if empty, nothing is inserted |
Adds some actionGroup to the aggregation actionGroups.
Param | Type | DefaultValue | Description |
---|---|---|---|
oActionGroup | sap.ui.core.Item |
The actionGroup to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the actionPress event of this sap.m.SelectionDetails
.
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.SelectionDetails
itself.
Event is triggered when a custom action is pressed.
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 beforeClose event of this sap.m.SelectionDetails
.
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.SelectionDetails
itself.
Event is triggered before the popover is closed.
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 beforeOpen event of this sap.m.SelectionDetails
.
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.SelectionDetails
itself.
Event is triggered before the popover is open.
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 |
Detaches event handler fnFunction
from the actionPress event of this sap.m.SelectionDetails
.
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 beforeClose event of this sap.m.SelectionDetails
.
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 beforeOpen event of this sap.m.SelectionDetails
.
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 |
Returns true
if the labels of the sap.m.SelectionDetailsItemLine elements are wrapped, false
otherwise.
Removes a action from the aggregation actions.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAction | int string sap.ui.core.Item |
The action to remove or its index or id |
Removes a actionGroup from the aggregation actionGroups.
Param | Type | DefaultValue | Description |
---|---|---|---|
vActionGroup | int string sap.ui.core.Item |
The actionGroup to remove or its index or id |
Removes all the controls from the aggregation actionGroups.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation actions.
Additionally, it unregisters them from the hosting UIArea.
Enables line wrapping for the labels of the of the sap.m.SelectionDetailsItemLine elements.
Param | Type | DefaultValue | Description |
---|---|---|---|
bWrap | boolean |
True to apply wrapping to the labels of the sap.m.SelectionDetailsItemLine elements. |