A layout control that provides specific configuration about how the items should be displayed.
Constructor for a new ProductSwitch
.
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.f.ProductSwitch(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 |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
_gridContainer | 0..1 | sap.f.GridContainer |
Holds the internally created GridContainer. |
items | 0..n | sap.f.ProductSwitchItem |
|
Name | Cardinality | Type | Description |
---|---|---|---|
selectedItem | 0..1 | sap.f.ProductSwitchItem |
Sets or retrieves the selected item from the |
Method | Description |
---|---|
addItem |
Adds some item to the aggregation items. |
attachChange |
Attaches event handler When called, the context of the event handler (its Fires when an unselected item is pressed. |
destroyItems |
Destroys all the items in the aggregation items. |
detachChange |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.f.ProductSwitch.extend |
Creates a new subclass of class sap.f.ProductSwitch with name
|
fireChange |
Fires event change to attached listeners. |
getItems |
Gets content of aggregation items.
|
sap.f.ProductSwitch.getMetadata |
Returns a metadata object for class sap.f.ProductSwitch. |
getSelectedItem |
ID of the element which is the current target of the association selectedItem, or |
indexOfItem |
Checks for the provided |
insertItem |
Inserts a item into the aggregation items. |
removeAllItems |
Removes all the controls from the aggregation items. Additionally, it unregisters them from the hosting UIArea. |
removeItem |
Removes a item from the aggregation items. |
setSelectedItem |
Sets the |
Adds some item to the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.f.ProductSwitchItem |
The item to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the change event of this sap.f.ProductSwitch
.
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.f.ProductSwitch
itself.
Fires when an unselected item 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 |
Detaches event handler fnFunction
from the change event of this sap.f.ProductSwitch
.
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.f.ProductSwitch 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.
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 change to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
itemPressed | sap.f.ProductSwitchItem |
Reference to the new item that has been selected. |
ID of the element which is the current target of the association selectedItem, or null
.
Checks for the provided sap.f.ProductSwitchItem
in the aggregation items. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.f.ProductSwitchItem |
The item whose index is looked for |
Inserts a item into the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
oItem | sap.f.ProductSwitchItem |
The item to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation items.
Additionally, it unregisters them from the hosting UIArea.
Removes a item from the aggregation items.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | int string sap.f.ProductSwitchItem |
The item to remove or its index or id |
Sets the selectedItem
association.
Param | Type | DefaultValue | Description |
---|---|---|---|
vItem | string sap.f.ProductSwitchItem null |
New value for the |