Class sap.ui.comp.smartfield.ControlProposalModule: sap/ui/comp/smartfield/ControlProposal

extends Element

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

Constructor Summary
new sap.ui.comp.smartfield.ControlProposal(sId?, mSettings?)Constructor for a new smartfield/ControlProposal.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.smartfield.ControlProposal.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.smartfield.ControlProposal with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.smartfield.ControlProposal.getMetadata()Returns a metadata object for class sap.ui.comp.smartfield.ControlProposal.
destroyObjectStatus()Destroys the objectStatus in the aggregation objectStatus.
getControlType()Gets current value of property controlType.
getObjectStatus()Gets content of aggregation objectStatus.
setControlType(sControlType)Sets a new value for property controlType.
setObjectStatus(oObjectStatus)Sets the aggregated objectStatus.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.comp.smartfield.ControlProposal(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • controlType : sap.ui.comp.smartfield.ControlProposalType (default: None)
  • Aggregations

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.comp.smartfield.ControlProposal.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.comp.smartfield.ControlProposal.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.smartfield.ControlProposal.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyObjectStatus(): sap.ui.comp.smartfield.ControlProposal
Destroys the objectStatus in the aggregation objectStatus.
Since:
1.34.0
Returns:
{sap.ui.comp.smartfield.ControlProposal} Reference to this in order to allow method chaining
getControlType(): sap.ui.comp.smartfield.ControlProposalType
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.

Returns:
{sap.ui.comp.smartfield.ControlProposalType} Value of property controlType
getObjectStatus(): sap.ui.comp.smartfield.ObjectStatus
Gets content of aggregation objectStatus.

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

Since:
1.34.0
Returns:
{sap.ui.comp.smartfield.ObjectStatus}
setControlType(sControlType): sap.ui.comp.smartfield.ControlProposal
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.

Parameters:
{sap.ui.comp.smartfield.ControlProposalType}sControlType New value for property controlType
Returns:
{sap.ui.comp.smartfield.ControlProposal} Reference to this in order to allow method chaining
setObjectStatus(oObjectStatus): sap.ui.comp.smartfield.ControlProposal
Sets the aggregated objectStatus.
Parameters:
{sap.ui.comp.smartfield.ObjectStatus}oObjectStatus The objectStatus to set
Since:
1.34.0
Returns:
{sap.ui.comp.smartfield.ControlProposal} Reference to this in order to allow method chaining