class sap.ui.comp.smartvariants.SmartVariantManagementAdapter

UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/comp/smartvariants/SmartVariantManagementAdapter
Application Component: CA-UI5-CMP

Handles the odata metadata based information. An instance of this class will be created and used by the SmartVariantManagement control. The adapter transforms odata metadata based SelectionPresentationVariant information to UIState object. For each SelectionPresentationVariant annotation an entry will be added to the VariantManagement control. It will be called by the SmartVariantManagement whenever the user selects the corresponding entry and will provide a valid UIState object.


Constructor

Constructor for new instance of a SmartVariantManagementAdapter control.

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.ui.comp.smartvariants.SmartVariantManagementAdapter(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


Properties

Name Type Default Value Description
selectionPresentationVariants object false

assign an array of selectionPresentationVariants annotations.

Visibility: public

Methods Overview

Method Description
sap.ui.comp.smartvariants.SmartVariantManagementAdapter.extend

Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementAdapter 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.Element.extend.

sap.ui.comp.smartvariants.SmartVariantManagementAdapter.getMetadata

Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementAdapter.

getSelectionPresentationVariants

Gets current value of property selectionPresentationVariants.

assign an array of selectionPresentationVariants annotations.

Default value is false.

setSelectionPresentationVariants

Sets a new value for property selectionPresentationVariants.

assign an array of selectionPresentationVariants annotations.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

sap.ui.comp.smartvariants.SmartVariantManagementAdapter.extend

Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementAdapter 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.Element.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

sap.ui.comp.smartvariants.SmartVariantManagementAdapter.getMetadata

Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementAdapter.

getSelectionPresentationVariants

Gets current value of property selectionPresentationVariants.

assign an array of selectionPresentationVariants annotations.

Default value is false.

setSelectionPresentationVariants

Sets a new value for property selectionPresentationVariants.

assign an array of selectionPresentationVariants annotations.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Param Type DefaultValue Description
oSelectionPresentationVariants object false

New value for property selectionPresentationVariants