The EditableVariantItem class describes an editable variant list item for the Manage Variants popup.
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 |
Name | Type | Default Value | Description |
---|---|---|---|
_contexts | object | empty object | Assigned contexts. |
accessOptions | string | Flags for a variant to indicate why it might be read-only |
|
author | string | Author of the variant |
|
favorite | boolean | false | Indicates if favorites can be created. |
global | boolean | Indicator if a variant is visible for all users. |
|
key | string | Key of the List Item |
|
labelReadOnly | boolean | false | Indicates if the variant label can be changed |
lifecyclePackage | string | ABAP Package the variant is assigned. Used for transport functionality |
|
lifecycleTransportId | string | Identifier of the transport object the variant is assigned to. |
|
namespace | string | Variant namespace |
|
readOnly | boolean | false | Indication if variant can be changed |
Method | Description |
---|---|
sap.ui.comp.variants.EditableVariantItem.extend |
Creates a new subclass of class sap.ui.comp.variants.EditableVariantItem with name
|
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 |
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 |
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 |
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
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 |
setFavorite |
Sets a new value for property favorite. Indicates if favorites can be created. When called with a value of Default value is |
setGlobal |
Sets a new value for property global. Indicator if a variant is visible for all users. When called with a value of |
setKey |
Sets a new value for property key. Key of the List Item When called with a value of |
setLabelReadOnly |
Sets a new value for property labelReadOnly. Indicates if the variant label can be changed When called with a value of Default value is |
setLifecyclePackage |
Sets a new value for property lifecyclePackage. ABAP Package the variant is assigned. Used for transport functionality When called with a value of |
setLifecycleTransportId |
Sets a new value for property lifecycleTransportId. Identifier of the transport object the variant is assigned to. When called with a value of |
setNamespace |
Sets a new value for property namespace. Variant namespace When called with a value of |
setReadOnly |
Sets a new value for property readOnly. Indication if variant can be changed When called with a value of Default value is |
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 |
Gets current value of property accessOptions.
Flags for a variant to indicate why it might be read-only
Gets current value of property favorite.
Indicates if favorites can be created.
Default value is false
.
Gets current value of property labelReadOnly.
Indicates if the variant label can be changed
Default value is false
.
Gets current value of property lifecyclePackage.
ABAP Package the variant is assigned. Used for transport functionality
Gets current value of property lifecycleTransportId.
Identifier of the transport object the variant is assigned to.
Returns a metadata object for class sap.ui.comp.variants.EditableVariantItem.
Gets current value of property readOnly.
Indication if variant can be changed
Default value is false
.
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sAccessOptions | string |
New value for property |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |