A ValueHelpPanel
control is used inside the FieldValueHelp
element to show a complex dialog for entering multiple kinds of conditions.
Constructor for a new ValueHelpPanel
.
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.ValueHelpPanel(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 |
---|---|---|---|
_filterBarVisible | boolean | false | Internal property to bind corresponding controls to the visibility of the |
conditions | object[] | Sets the conditions that represent the selected values of the help. |
|
formatOptions | object | empty object | The |
inputOK | boolean | true | If set, there has been no invalid user input. Note: This property must not be set from outside. It is a property because that way it can be bound to the |
showFilterbar | boolean | true | If set to |
showTokenizer | boolean | true | If set to |
Method | Description |
---|---|
sap.ui.mdc.field.ValueHelpPanel.extend |
Creates a new subclass of class sap.ui.mdc.field.ValueHelpPanel with name
|
getConditions |
Gets current value of property conditions. Sets the conditions that represent the selected values of the help. Default value is |
getFormatOptions |
Gets current value of property formatOptions. The Default value is |
getInputOK |
Gets current value of property inputOK. If set, there has been no invalid user input. Note: This property must not be set from outside. It is a property because that way it can be bound to the Default value is |
sap.ui.mdc.field.ValueHelpPanel.getMetadata |
Returns a metadata object for class sap.ui.mdc.field.ValueHelpPanel. |
getShowFilterbar |
Gets current value of property showFilterbar. If set to Default value is |
getShowTokenizer |
Gets current value of property showTokenizer. If set to Default value is |
setConditions |
Sets a new value for property conditions. Sets the conditions that represent the selected values of the help. When called with a value of Default value is |
setFormatOptions |
Sets a new value for property formatOptions. The When called with a value of Default value is |
setInputOK |
Sets a new value for property inputOK. If set, there has been no invalid user input. Note: This property must not be set from outside. It is a property because that way it can be bound to the When called with a value of Default value is |
setShowFilterbar |
Sets a new value for property showFilterbar. If set to When called with a value of Default value is |
setShowTokenizer |
Sets a new value for property showTokenizer. If set to When called with a value of Default value is |
Creates a new subclass of class sap.ui.mdc.field.ValueHelpPanel 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.XMLComposite.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 conditions.
Sets the conditions that represent the selected values of the help.
Default value is []
.
Gets current value of property formatOptions.
The formatOptions
for the ConditionType
used to format tokens.
Default value is {}
.
Gets current value of property inputOK.
If set, there has been no invalid user input.
Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel
of the calling field help and automatically update it.
Default value is true
.
Returns a metadata object for class sap.ui.mdc.field.ValueHelpPanel.
Gets current value of property showFilterbar.
If set to true
, the FilterBar
area is shown. The FilterBar
must be assigned using setFilterBar
.
Default value is true
.
Gets current value of property showTokenizer.
If set to true
, a tokenizer is shown.
Default value is true
.
Sets a new value for property conditions.
Sets the conditions that represent the selected values of the help.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sConditions | object[] | [] |
New value for property |
Sets a new value for property formatOptions.
The formatOptions
for the ConditionType
used to format tokens.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is {}
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFormatOptions | object | {} |
New value for property |
Sets a new value for property inputOK.
If set, there has been no invalid user input.
Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel
of the calling field help and automatically update it.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bInputOK | boolean | true |
New value for property |
Sets a new value for property showFilterbar.
If set to true
, the FilterBar
area is shown. The FilterBar
must be assigned using setFilterBar
.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowFilterbar | boolean | true |
New value for property |
Sets a new value for property showTokenizer.
If set to true
, a tokenizer is shown.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bShowTokenizer | boolean | true |
New value for property |