class sap.ui.comp.smartvariants.SmartVariantManagementBase

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

Overview

The SmartVariantManagementBase control is a specialization of the VariantManagement control and communicates with the flexibility library that offers SAPUI5 flexibility to manage the variants for the UI Adaptation scenarios.


Constructor

Constructor for a new SmartVariantManagementBase.
This class handles the UI Adaptation for the SmartVariantManagement control. It provides RTA enabled dialogs and the corresponding functionality for beeing able to create changes as key user.

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.

This class does not have its own settings, but all settings applicable to the base type sap.ui.comp.variants.VariantManagement can be used.

new sap.ui.comp.smartvariants.SmartVariantManagementBase(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

Borrowed Properties

Name Type Default Value Description
defaultVariantKey string

Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected variant.

Since: 1.22.0.

Visibility: public
enabled boolean true

Can be set to true or false depending on whether you want to enable or disable the control.

Since: 1.22.0.

Visibility: public
inErrorState boolean false

Indicates that the control is in error state. If set to true error message will be displayed whenever the variant is opened.

Since: 1.52.0.

Visibility: public
initialSelectionKey string

Enables the setting of the initially selected variant.

Since: 1.22.0.

Visibility: public
lifecycleSupport boolean false

Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information for shared variants.

Since: 1.26.0.

Visibility: public
selectionKey string

The key of the currently selected item. Returns null if the default item list is selected. This property is calculated when accessing it via the getSelectionKey method. The corresponding setSelectionKey method is not supported. The access via the standard set/getProperty is also not supported.

Since: 1.24.0.

Visibility: public
showCreateTile boolean false

Indicates that a Create Tile is visible in the Create dialog.

Since: 1.26.0.

Visibility: public
showExecuteOnSelection boolean false

Indicates that Execute on Selection is visible in the Save Variant and the Manage Variants dialogs.

Since: 1.26.0.

Visibility: public
showSetAsDefault boolean true

Indicates that set as default is visible in the Save Variant and the Manage Variants dialogs.

Since: 1.44.0.

Visibility: public
showShare boolean false

Indicates that the Public checkbox is visible in the Save View and the Manage Views dialogs. Selecting this checkbox allows you to share variants with other users.

Since: 1.26.0.

Visibility: public
standardItemAuthor string SAP

Defines the author of the standard variant, for example, the name of the own company.

Since: 1.86.

Visibility: public
standardItemText string

Overwrites the default Standard variant title.

Since: 1.28.0.

Visibility: public
useFavorites boolean false

Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in the variant list.

Since: 1.50.0.

Visibility: public
variantCreationByUserAllowed boolean true

Indicates that end users are allowed to create variants.

Since: 1.85.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
items 0..n sap.ui.core.Item

Items displayed by the VariantManagement control.
Deprecated as of version 1.26.0. Replaced by association variantItems

variantItems 0..n sap.ui.comp.variants.VariantItem

Variant items displayed by the VariantManagement control.

Since: 1.26.0.


Methods Overview

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

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

sap.ui.comp.smartvariants.SmartVariantManagementBase.getMetadata

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

sap.ui.comp.smartvariants.SmartVariantManagementBase.extend

Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementBase 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.comp.variants.VariantManagement.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.SmartVariantManagementBase.getMetadata

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