class sap.ui.comp.variants.EditableVariantItem

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

The EditableVariantItem class describes an editable variant list item for the Manage Variants popup.


Constructor

Constructor for a new variants/EditableVariantItem.

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.variants.EditableVariantItem(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
_contexts object empty object

Assigned contexts.

Since: 1.88.

Visibility: hidden
accessOptions string

Flags for a variant to indicate why it might be read-only

Since: 1.26.0.

Visibility: public
author string

Author of the variant

Since: 1.38.0.

Visibility: public
favorite boolean false

Indicates if favorites can be created.

Since: 1.50.0.

Visibility: public
global boolean

Indicator if a variant is visible for all users.

Since: 1.26.0.

Visibility: public
key string

Key of the List Item

Since: 1.22.0.

Visibility: public
labelReadOnly boolean false

Indicates if the variant label can be changed

Since: 1.28.0.

Visibility: public
lifecyclePackage string

ABAP Package the variant is assigned. Used for transport functionality

Since: 1.26.0.

Visibility: public
lifecycleTransportId string

Identifier of the transport object the variant is assigned to.

Since: 1.26.0.

Visibility: public
namespace string

Variant namespace

Since: 1.26.0.

Visibility: public
readOnly boolean false

Indication if variant can be changed

Since: 1.26.0.

Visibility: public

Methods Overview

Method Description
sap.ui.comp.variants.EditableVariantItem.extend

Creates a new subclass of class sap.ui.comp.variants.EditableVariantItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ColumnListItem.extend.

getAccessOptions

Gets current value of property accessOptions.

Flags for a variant to indicate why it might be read-only

Since 1.28.0 Replaced by property <code>labelReadOnly</code>
getAuthor

Gets current value of property author.

Author of the variant

getFavorite

Gets current value of property favorite.

Indicates if favorites can be created.

Default value is false.

getGlobal

Gets current value of property global.

Indicator if a variant is visible for all users.

getKey

Gets current value of property key.

Key of the List Item

getLabelReadOnly

Gets current value of property labelReadOnly.

Indicates if the variant label can be changed

Default value is false.

getLifecyclePackage

Gets current value of property lifecyclePackage.

ABAP Package the variant is assigned. Used for transport functionality

getLifecycleTransportId

Gets current value of property lifecycleTransportId.

Identifier of the transport object the variant is assigned to.

sap.ui.comp.variants.EditableVariantItem.getMetadata

Returns a metadata object for class sap.ui.comp.variants.EditableVariantItem.

getNamespace

Gets current value of property namespace.

Variant namespace

getReadOnly

Gets current value of property readOnly.

Indication if variant can be changed

Default value is false.

setAccessOptions

Sets a new value for property accessOptions.

Flags for a variant to indicate why it might be read-only

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

Since 1.28.0 Replaced by property <code>labelReadOnly</code>
setAuthor

Sets a new value for property author.

Author of the variant

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

setFavorite

Sets a new value for property favorite.

Indicates if favorites can be created.

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

Default value is false.

setGlobal

Sets a new value for property global.

Indicator if a variant is visible for all users.

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

setKey

Sets a new value for property key.

Key of the List Item

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

setLabelReadOnly

Sets a new value for property labelReadOnly.

Indicates if the variant label can be changed

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

Default value is false.

setLifecyclePackage

Sets a new value for property lifecyclePackage.

ABAP Package the variant is assigned. Used for transport functionality

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

setLifecycleTransportId

Sets a new value for property lifecycleTransportId.

Identifier of the transport object the variant is assigned to.

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

setNamespace

Sets a new value for property namespace.

Variant namespace

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

setReadOnly

Sets a new value for property readOnly.

Indication if variant can be changed

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.variants.EditableVariantItem.extend

Creates a new subclass of class sap.ui.comp.variants.EditableVariantItem with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.ColumnListItem.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

getAccessOptions

Gets current value of property accessOptions.

Flags for a variant to indicate why it might be read-only

Since 1.28.0 Replaced by property <code>labelReadOnly</code>

getAuthor

Gets current value of property author.

Author of the variant

getFavorite

Gets current value of property favorite.

Indicates if favorites can be created.

Default value is false.

getGlobal

Gets current value of property global.

Indicator if a variant is visible for all users.

getKey

Gets current value of property key.

Key of the List Item

getLabelReadOnly

Gets current value of property labelReadOnly.

Indicates if the variant label can be changed

Default value is false.

getLifecyclePackage

Gets current value of property lifecyclePackage.

ABAP Package the variant is assigned. Used for transport functionality

getLifecycleTransportId

Gets current value of property lifecycleTransportId.

Identifier of the transport object the variant is assigned to.

sap.ui.comp.variants.EditableVariantItem.getMetadata

Returns a metadata object for class sap.ui.comp.variants.EditableVariantItem.

getNamespace

Gets current value of property namespace.

Variant namespace

getReadOnly

Gets current value of property readOnly.

Indication if variant can be changed

Default value is false.

setAccessOptions

Sets a new value for property accessOptions.

Flags for a variant to indicate why it might be read-only

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

Since 1.28.0 Replaced by property <code>labelReadOnly</code>
Param Type DefaultValue Description
sAccessOptions string

New value for property accessOptions

setAuthor

Sets a new value for property author.

Author of the variant

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

Param Type DefaultValue Description
sAuthor string

New value for property author

setFavorite

Sets a new value for property favorite.

Indicates if favorites can be created.

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
bFavorite boolean false

New value for property favorite

setGlobal

Sets a new value for property global.

Indicator if a variant is visible for all users.

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

Param Type DefaultValue Description
bGlobal boolean

New value for property global

setKey

Sets a new value for property key.

Key of the List Item

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

Param Type DefaultValue Description
sKey string

New value for property key

setLabelReadOnly

Sets a new value for property labelReadOnly.

Indicates if the variant label can be changed

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
bLabelReadOnly boolean false

New value for property labelReadOnly

setLifecyclePackage

Sets a new value for property lifecyclePackage.

ABAP Package the variant is assigned. Used for transport functionality

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

Param Type DefaultValue Description
sLifecyclePackage string

New value for property lifecyclePackage

setLifecycleTransportId

Sets a new value for property lifecycleTransportId.

Identifier of the transport object the variant is assigned to.

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

Param Type DefaultValue Description
sLifecycleTransportId string

New value for property lifecycleTransportId

setNamespace

Sets a new value for property namespace.

Variant namespace

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

Param Type DefaultValue Description
sNamespace string

New value for property namespace

setReadOnly

Sets a new value for property readOnly.

Indication if variant can be changed

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
bReadOnly boolean false

New value for property readOnly