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 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 |
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. |
|
enabled | boolean | true | Can be set to true or false depending on whether you want to enable or disable the control. |
inErrorState | boolean | false | Indicates that the control is in error state. If set to |
initialSelectionKey | string | Enables the setting of the initially selected variant. |
|
lifecycleSupport | boolean | false | Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information for shared variants. |
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. |
|
showCreateTile | boolean | false | Indicates that a Create Tile is visible in the Create dialog. |
showExecuteOnSelection | boolean | false | Indicates that Execute on Selection is visible in the Save Variant and the Manage Variants dialogs. |
showSetAsDefault | boolean | true | Indicates that set as default is visible in the Save Variant and the Manage Variants dialogs. |
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. |
standardItemAuthor | string | SAP | Defines the author of the standard variant, for example, the name of the own company. |
standardItemText | string | Overwrites the default Standard variant title. |
|
useFavorites | boolean | false | Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in the variant list. |
variantCreationByUserAllowed | boolean | true | Indicates that end users are allowed to create variants. |
Name | Cardinality | Type | Description |
---|---|---|---|
items | 0..n | sap.ui.core.Item |
Items displayed by the |
variantItems | 0..n | sap.ui.comp.variants.VariantItem |
Variant items displayed by the |
Method | Description |
---|---|
sap.ui.comp.smartvariants.SmartVariantManagementBase.extend |
Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementBase with name
|
sap.ui.comp.smartvariants.SmartVariantManagementBase.getMetadata |
Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementBase. |
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 |