class sap.ui.comp.smartfield.ControlProposal

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

Proposes a control to be rendered. The smart field may ignore the proposal.


Constructor

Constructor for a new smartfield/ControlProposal.

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.smartfield.ControlProposal(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
controlType sap.ui.comp.smartfield.ControlProposalType None

By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property allows to overwrite the default behavior to some extent; for example this property allows to define that an OData property of type Edm.Boolean is displayed as combo box.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
objectStatus 0..1 sap.ui.comp.smartfield.ObjectStatus

Optional definition to further qualify how an object status control should be rendered.

Since: 1.34.0.


Methods Overview

Method Description
destroyObjectStatus

Destroys the objectStatus in the aggregation objectStatus.

sap.ui.comp.smartfield.ControlProposal.extend

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

getControlType

Gets current value of property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property allows to overwrite the default behavior to some extent; for example this property allows to define that an OData property of type Edm.Boolean is displayed as combo box.

Default value is None.

sap.ui.comp.smartfield.ControlProposal.getMetadata

Returns a metadata object for class sap.ui.comp.smartfield.ControlProposal.

getObjectStatus

Gets content of aggregation objectStatus.

Optional definition to further qualify how an object status control should be rendered.

setControlType

Sets a new value for property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property allows to overwrite the default behavior to some extent; for example this property allows to define that an OData property of type Edm.Boolean is displayed as combo box.

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

Default value is None.

setObjectStatus

Sets the aggregated objectStatus.

destroyObjectStatus

Destroys the objectStatus in the aggregation objectStatus.

sap.ui.comp.smartfield.ControlProposal.extend

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

getControlType

Gets current value of property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property allows to overwrite the default behavior to some extent; for example this property allows to define that an OData property of type Edm.Boolean is displayed as combo box.

Default value is None.

sap.ui.comp.smartfield.ControlProposal.getMetadata

Returns a metadata object for class sap.ui.comp.smartfield.ControlProposal.

getObjectStatus

Gets content of aggregation objectStatus.

Optional definition to further qualify how an object status control should be rendered.

setControlType

Sets a new value for property controlType.

By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property allows to overwrite the default behavior to some extent; for example this property allows to define that an OData property of type Edm.Boolean is displayed as combo box.

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

Default value is None.

Param Type DefaultValue Description
sControlType sap.ui.comp.smartfield.ControlProposalType None

New value for property controlType

setObjectStatus

Sets the aggregated objectStatus.

Param Type DefaultValue Description
oObjectStatus sap.ui.comp.smartfield.ObjectStatus

The objectStatus to set