The InParameter
element is used in the FieldValueHelp element.
Constructor for a new InParameter
.
The FieldValueHelp element supports in parameters. The binding to the data is defined in this element.
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.mdc.field.InParameter(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 |
---|---|---|---|
helpPath | string | Name of the field in the This is needed to define the filter for the corresponding field in the help. Visibility: public |
|
initialValueFilterEmpty | boolean | false | If set, an initial value of Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions. Note: This property must only be set if the data type used supports a filtering for the empty operator. Note: Do not set this property if an empty string is a valid key for the |
value | any | The value of the in parameter. Here the data of the model can be bound. In the FilterField case this is the ConditionModel. Note: Here we recommend one-way-binding. Visibility: public |
Method | Description |
---|---|
sap.ui.mdc.field.InParameter.extend |
Creates a new subclass of class sap.ui.mdc.field.InParameter with name
|
getDataType |
Returns the used data type. |
getFieldPath |
Returns the path of the If the |
getHelpPath |
Gets current value of property helpPath. Name of the field in the This is needed to define the filter for the corresponding field in the help. |
getInitialValueFilterEmpty |
Gets current value of property initialValueFilterEmpty. If set, an initial value of Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions. Note: This property must only be set if the data type used supports a filtering for the empty operator. Note: Do not set this property if an empty string is a valid key for the Default value is |
sap.ui.mdc.field.InParameter.getMetadata |
Returns a metadata object for class sap.ui.mdc.field.InParameter. |
getUseConditions |
Returns an indicator if conditions are used as values. If the |
getValue |
Gets current value of property value. The value of the in parameter. Here the data of the model can be bound. In the FilterField case this is the ConditionModel. Note: Here we recommend one-way-binding. |
setHelpPath |
Sets a new value for property helpPath. Name of the field in the This is needed to define the filter for the corresponding field in the help. When called with a value of |
setInitialValueFilterEmpty |
Sets a new value for property initialValueFilterEmpty. If set, an initial value of Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions. Note: This property must only be set if the data type used supports a filtering for the empty operator. Note: Do not set this property if an empty string is a valid key for the When called with a value of Default value is |
setValue |
Sets a new value for property value. The value of the in parameter. Here the data of the model can be bound. In the FilterField case this is the ConditionModel. Note: Here we recommend one-way-binding. When called with a value of |
Creates a new subclass of class sap.ui.mdc.field.InParameter 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 |
Returns the path of the InParameter
element.
If the value
property is bound to a model, the binding path is used. If no binding path is found, the value of the helpPath
property is used.
Gets current value of property helpPath.
Name of the field in the ListBinding
used in the value help.
This is needed to define the filter for the corresponding field in the help.
Gets current value of property initialValueFilterEmpty.
If set, an initial value of InParameter
starts a filtering for the empty
operator.
Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions.
Note: This property must only be set if the data type used supports a filtering for the empty operator.
Note: Do not set this property if an empty string is a valid key for the InParameter
used.
Default value is false
.
Returns a metadata object for class sap.ui.mdc.field.InParameter.
Returns an indicator if conditions are used as values.
If the value
property is bound to a ConditionModel model it must handle conditions. Only in this case multiple values are supported. Otherwise the value is just updated.
Gets current value of property value.
The value of the in parameter.
Here the data of the model can be bound. In the FilterField case this is the ConditionModel.
Note: Here we recommend one-way-binding.
Sets a new value for property helpPath.
Name of the field in the ListBinding
used in the value help.
This is needed to define the filter for the corresponding field in the help.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHelpPath | string |
New value for property |
Sets a new value for property initialValueFilterEmpty.
If set, an initial value of InParameter
starts a filtering for the empty
operator.
Note: This property must not be used for FilterField and if bound to ConditionModel. In this case, a filtering for the empty operator must be defined by the assigned conditions.
Note: This property must only be set if the data type used supports a filtering for the empty operator.
Note: Do not set this property if an empty string is a valid key for the InParameter
used.
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 |
---|---|---|---|
bInitialValueFilterEmpty | boolean | false |
New value for property |
Sets a new value for property value.
The value of the in parameter.
Here the data of the model can be bound. In the FilterField case this is the ConditionModel.
Note: Here we recommend one-way-binding.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oValue | any |
New value for property |