class sap.ui.comp.smartvariants.PersonalizableInfo

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

The PersonalizableInfo class describes the personalizable control associated with the SmartVariantManagement control.


Constructor

Constructor for a new smartvariants/PersonalizableInfo.

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.PersonalizableInfo(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
dataSource string

Name of the data service

Visibility: public
keyName string

Defines the property name of the personalization key.

Visibility: public
type string

Describes the type of variant management.

Visibility: public

Associations

Name Cardinality Type Description
control 0..1 sap.ui.core.Control

Contains the control that can be personalized.


Methods Overview

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

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

getControl

ID of the element which is the current target of the association control, or null.

getDataSource

Gets current value of property dataSource.

Name of the data service

getKeyName

Gets current value of property keyName.

Defines the property name of the personalization key.

sap.ui.comp.smartvariants.PersonalizableInfo.getMetadata

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

getType

Gets current value of property type.

Describes the type of variant management.

setControl

Sets the associated control.

setDataSource

Sets a new value for property dataSource.

Name of the data service

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

setKeyName

Sets a new value for property keyName.

Defines the property name of the personalization key.

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

setType

Sets a new value for property type.

Describes the type of variant management.

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

sap.ui.comp.smartvariants.PersonalizableInfo.extend

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

getControl

ID of the element which is the current target of the association control, or null.

getDataSource

Gets current value of property dataSource.

Name of the data service

getKeyName

Gets current value of property keyName.

Defines the property name of the personalization key.

sap.ui.comp.smartvariants.PersonalizableInfo.getMetadata

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

getType

Gets current value of property type.

Describes the type of variant management.

setControl

Sets the associated control.

Param Type DefaultValue Description
oControl sap.ui.core.ID sap.ui.core.Control

ID of an element which becomes the new target of this control association; alternatively, an element instance may be given

setDataSource

Sets a new value for property dataSource.

Name of the data service

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

Param Type DefaultValue Description
sDataSource string

New value for property dataSource

setKeyName

Sets a new value for property keyName.

Defines the property name of the personalization key.

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

Param Type DefaultValue Description
sKeyName string

New value for property keyName

setType

Sets a new value for property type.

Describes the type of variant management.

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

Param Type DefaultValue Description
sType string

New value for property type