class sap.ui.comp.valuehelpdialog.ValueHelpDialog

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Extends: sap.m.Dialog
Module: sap/ui/comp/valuehelpdialog/ValueHelpDialog
Application Component: CA-UI5-CMP

The ValueHelpDialog control can be used to implement a value help for an input field.


Constructor

Constructor for a new valuehelpdialog/ValueHelpDialog.

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.valuehelpdialog.ValueHelpDialog(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
_enhancedExcludeOperations boolean false

Used by the ValueHelpProvider to enable enhanced exclude operations

Since: 1.74.

Visibility: hidden
basicSearchText string empty string

Defines the value for the basic search field. The value is set into the basic search field of the filter bar used.

Since: 1.24.

Visibility: public
descriptionKey string empty string

Defines the key of the column used for the token text.

Since: 1.24.

Visibility: public
displayFormat string empty string

Represents the display format of the range values. With the displayFormat value UpperCase, the entered value of the range (condition) is converted to uppercase letters.

Since: 1.24.

Visibility: public
filterMode boolean false

Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.

Since: 1.24.

Visibility: public
key string empty string

Defines the key of the column used for the internal key handling. The value of the column is used for the token key and also to identify the row in the table.

Since: 1.24.

Visibility: public
keys string[]

Defines the list of additional keys of the column used for the internal key handling.

Since: 1.24.

Visibility: public
maxExcludeRanges string -1

Defines the maximum number of exclude ranges.

Since: 1.24.

Visibility: public
maxIncludeRanges string -1

Defines the maximum number of include ranges.

Since: 1.24.

Visibility: public
supportMultiselect boolean true

Enables multi-selection in the table used.

Since: 1.24.

Visibility: public
supportRanges boolean false

Enables the ranges (conditions) feature in the dialog.

Since: 1.24.

Visibility: public
supportRangesOnly boolean false

If this property is set to true, the value help dialog only supports the ranges (conditions) feature.

Since: 1.24.

Visibility: public
tokenDisplayBehaviour string empty string

Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid sap.ui.comp.smartfilterbar.DisplayBehaviour values.

Since: 1.24.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
filterBar 0..1 sap.ui.comp.filterbar.FilterBar

Allows you to add a FilterBar or SmartFilterBar control to the value help dialog.


Events Overview

Event Description
cancel

This event is fired when the Cancel button is pressed.

Since: 1.24.

ok

This event is fired when the OK button is pressed.

Since: 1.24.

selectionChange

This event is fired when the user selects an item in the items table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

tokenRemove

This event is fired when the user removes one or multiple existing token(s) from the dialog.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

updateSelection

This event is fired when the table gets an update and all existing tokens must be selected in the table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

cancel

This event is fired when the Cancel button is pressed.

Since: 1.24.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

ok

This event is fired when the OK button is pressed.

Since: 1.24.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
tokens sap.m.Token[]

The array of tokens created or modified on the ValueHelpDialog.

selectionChange

This event is fired when the user selects an item in the items table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
tableSelectionParams object

The RowSelectionChange event parameter from the hosted table that contains the selected items.

updateTokens object[]

Returns an array of objects which represents all selected row tokens. The object contains the token key, the row object data from the model, and the information if the token is selected. [{sKey, oRow, bSelect}, ...]

useDefault boolean

Can be set to true to execute the default behaviour of the ValueHelpDialog.

table object

The table instance used

Since: 1.58.

tokenRemove

This event is fired when the user removes one or multiple existing token(s) from the dialog.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
tokenKeys string[]

The array of token keys that has been removed.

useDefault boolean

Can be set to true to execute the default behaviour of ValueHelpDialog.

updateSelection

This event is fired when the table gets an update and all existing tokens must be selected in the table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Since: 1.32.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
tokenKeys string[]

The array of existing token keys for which the selection in the table has to be updated.

useDefault boolean

Can be set to true to execute the default behavior of ValueHelpDialog.


Methods Overview

Method Description
attachCancel

Attaches event handler fnFunction to the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the Cancel button is pressed.

attachOk

Attaches event handler fnFunction to the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the OK button is pressed.

attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the user selects an item in the items table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

attachTokenRemove

Attaches event handler fnFunction to the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the user removes one or multiple existing token(s) from the dialog.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

attachUpdateSelection

Attaches event handler fnFunction to the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the table gets an update and all existing tokens must be selected in the table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

destroyFilterBar

Destroys the filterBar in the aggregation filterBar.

detachCancel

Detaches event handler fnFunction from the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

detachOk

Detaches event handler fnFunction from the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

detachTokenRemove

Detaches event handler fnFunction from the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

detachUpdateSelection

Detaches event handler fnFunction from the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

sap.ui.comp.valuehelpdialog.ValueHelpDialog.extend

Creates a new subclass of class sap.ui.comp.valuehelpdialog.ValueHelpDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Dialog.extend.

fireCancel

Fires event cancel to attached listeners.

fireOk

Fires event ok to attached listeners.

fireSelectionChange

Fires event selectionChange to attached listeners.

fireTokenRemove

Fires event tokenRemove to attached listeners.

fireUpdateSelection

Fires event updateSelection to attached listeners.

getBasicSearchText

Gets current value of property basicSearchText.

Defines the value for the basic search field. The value is set into the basic search field of the filter bar used.

Default value is empty string.

getDescriptionKey

Gets current value of property descriptionKey.

Defines the key of the column used for the token text.

Default value is empty string.

getDisplayFormat

Gets current value of property displayFormat.

Represents the display format of the range values. With the displayFormat value UpperCase, the entered value of the range (condition) is converted to uppercase letters.

Default value is empty string.

getFilterBar

Gets content of aggregation filterBar.

Allows you to add a FilterBar or SmartFilterBar control to the value help dialog.

getFilterMode

Gets current value of property filterMode.

Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.

Default value is false.

getKey

Gets current value of property key.

Defines the key of the column used for the internal key handling. The value of the column is used for the token key and also to identify the row in the table.

Default value is empty string.

getKeys

Gets current value of property keys.

Defines the list of additional keys of the column used for the internal key handling.

getMaxExcludeRanges

Gets current value of property maxExcludeRanges.

Defines the maximum number of exclude ranges.

Default value is '-1'.

getMaxIncludeRanges

Gets current value of property maxIncludeRanges.

Defines the maximum number of include ranges.

Default value is '-1'.

sap.ui.comp.valuehelpdialog.ValueHelpDialog.getMetadata

Returns a metadata object for class sap.ui.comp.valuehelpdialog.ValueHelpDialog.

getSupportMultiselect

Gets current value of property supportMultiselect.

Enables multi-selection in the table used.

Default value is true.

getSupportRanges

Gets current value of property supportRanges.

Enables the ranges (conditions) feature in the dialog.

Default value is false.

getSupportRangesOnly

Gets current value of property supportRangesOnly.

If this property is set to true, the value help dialog only supports the ranges (conditions) feature.

Default value is false.

getTable

Gives access to the internal table instance.

Since 1.60.0 replaced by {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog#getTableAsync} to prevent synchronous calls.
getTableAsync

Gives access to the internal table instance.

getTokenDisplayBehaviour

Gets current value of property tokenDisplayBehaviour.

Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid sap.ui.comp.smartfilterbar.DisplayBehaviour values.

Default value is empty string.

setBasicSearchText

Sets a new value for property basicSearchText.

Defines the value for the basic search field. The value is set into the basic search field of the filter bar used.

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

Default value is empty string.

setDescriptionKey

Sets a new value for property descriptionKey.

Defines the key of the column used for the token text.

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

Default value is empty string.

setDisplayFormat

Sets a new value for property displayFormat.

Represents the display format of the range values. With the displayFormat value UpperCase, the entered value of the range (condition) is converted to uppercase letters.

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

Default value is empty string.

setExcludeRangeOperations

Sets the array for the supported exclude range operations.

setFilterBar

Sets the aggregated filterBar.

setFilterMode

Sets a new value for property filterMode.

Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.

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

Default value is false.

setIncludeRangeOperations

Sets the array for the supported include range operations.

setKey

Sets a new value for property key.

Defines the key of the column used for the internal key handling. The value of the column is used for the token key and also to identify the row in the table.

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

Default value is empty string.

setKeys

Sets a new value for property keys.

Defines the list of additional keys of the column used for the internal key handling.

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

setMaxExcludeRanges

Sets a new value for property maxExcludeRanges.

Defines the maximum number of exclude ranges.

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

Default value is '-1'.

setMaxIncludeRanges

Sets a new value for property maxIncludeRanges.

Defines the maximum number of include ranges.

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

Default value is '-1'.

setRangeKeyFields

Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the ranges. You can set an array of objects with Key and Label properties to define the key fields.

setSupportMultiselect

Sets a new value for property supportMultiselect.

Enables multi-selection in the table used.

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

Default value is true.

setSupportRanges

Sets a new value for property supportRanges.

Enables the ranges (conditions) feature in the dialog.

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

Default value is false.

setSupportRangesOnly

Sets a new value for property supportRangesOnly.

If this property is set to true, the value help dialog only supports the ranges (conditions) feature.

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

Default value is false.

setTable

Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table or sap.m.Table instance internally.

setTokenDisplayBehaviour

Sets a new value for property tokenDisplayBehaviour.

Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid sap.ui.comp.smartfilterbar.DisplayBehaviour values.

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

Default value is empty string.

setTokens

Sets the array of tokens. The sap.m.Tokens are added to the dialog tokenizer. Normal tokens are selected in the table. new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"}); Tokens with the extra data with value 'range' are handled as range tokens or exclude range tokens. new sap.m.Token({key: "i1", text: "ID: a..z"}).data("range", { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, "keyField": "CompanyCode", "value1": "a", "value2": "z"}); The selected items or range tokens are returned in the event parameters of the Ok event.

update

Updates the selection of rows in the table. This function must be called after a first binding or binding update of the table. It will set a table row as selected if a token for this row exists.

attachCancel

Attaches event handler fnFunction to the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the Cancel button is pressed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself

attachOk

Attaches event handler fnFunction to the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the OK button is pressed.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself

attachSelectionChange

Attaches event handler fnFunction to the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the user selects an item in the items table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself

attachTokenRemove

Attaches event handler fnFunction to the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the user removes one or multiple existing token(s) from the dialog.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself

attachUpdateSelection

Attaches event handler fnFunction to the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself.

This event is fired when the table gets an update and all existing tokens must be selected in the table.

Note: The event will only be raised when the dialog gets a table instance from outside via setTable.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself

destroyFilterBar

Destroys the filterBar in the aggregation filterBar.

detachCancel

Detaches event handler fnFunction from the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachOk

Detaches event handler fnFunction from the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSelectionChange

Detaches event handler fnFunction from the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachTokenRemove

Detaches event handler fnFunction from the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachUpdateSelection

Detaches event handler fnFunction from the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.comp.valuehelpdialog.ValueHelpDialog.extend

Creates a new subclass of class sap.ui.comp.valuehelpdialog.ValueHelpDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.Dialog.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

fireCancel

Fires event cancel to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireOk

Fires event ok to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

tokens sap.m.Token[]

The array of tokens created or modified on the ValueHelpDialog.

fireSelectionChange

Fires event selectionChange to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

tableSelectionParams object

The RowSelectionChange event parameter from the hosted table that contains the selected items.

updateTokens object[]

Returns an array of objects which represents all selected row tokens. The object contains the token key, the row object data from the model, and the information if the token is selected. [{sKey, oRow, bSelect}, ...]

useDefault boolean

Can be set to true to execute the default behaviour of the ValueHelpDialog.

table object

The table instance used

fireTokenRemove

Fires event tokenRemove to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

tokenKeys string[]

The array of token keys that has been removed.

useDefault boolean

Can be set to true to execute the default behaviour of ValueHelpDialog.

fireUpdateSelection

Fires event updateSelection to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

tokenKeys string[]

The array of existing token keys for which the selection in the table has to be updated.

useDefault boolean

Can be set to true to execute the default behavior of ValueHelpDialog.

getBasicSearchText

Gets current value of property basicSearchText.

Defines the value for the basic search field. The value is set into the basic search field of the filter bar used.

Default value is empty string.

getDescriptionKey

Gets current value of property descriptionKey.

Defines the key of the column used for the token text.

Default value is empty string.

getDisplayFormat

Gets current value of property displayFormat.

Represents the display format of the range values. With the displayFormat value UpperCase, the entered value of the range (condition) is converted to uppercase letters.

Default value is empty string.

getFilterBar

Gets content of aggregation filterBar.

Allows you to add a FilterBar or SmartFilterBar control to the value help dialog.

getFilterMode

Gets current value of property filterMode.

Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.

Default value is false.

getKey

Gets current value of property key.

Defines the key of the column used for the internal key handling. The value of the column is used for the token key and also to identify the row in the table.

Default value is empty string.

getKeys

Gets current value of property keys.

Defines the list of additional keys of the column used for the internal key handling.

getMaxExcludeRanges

Gets current value of property maxExcludeRanges.

Defines the maximum number of exclude ranges.

Default value is '-1'.

getMaxIncludeRanges

Gets current value of property maxIncludeRanges.

Defines the maximum number of include ranges.

Default value is '-1'.

sap.ui.comp.valuehelpdialog.ValueHelpDialog.getMetadata

Returns a metadata object for class sap.ui.comp.valuehelpdialog.ValueHelpDialog.

getSupportMultiselect

Gets current value of property supportMultiselect.

Enables multi-selection in the table used.

Default value is true.

getSupportRanges

Gets current value of property supportRanges.

Enables the ranges (conditions) feature in the dialog.

Default value is false.

getSupportRangesOnly

Gets current value of property supportRangesOnly.

If this property is set to true, the value help dialog only supports the ranges (conditions) feature.

Default value is false.

getTable

Gives access to the internal table instance.

Since 1.60.0 replaced by {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog#getTableAsync} to prevent synchronous calls.

getTableAsync

Gives access to the internal table instance.

getTokenDisplayBehaviour

Gets current value of property tokenDisplayBehaviour.

Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid sap.ui.comp.smartfilterbar.DisplayBehaviour values.

Default value is empty string.

setBasicSearchText

Sets a new value for property basicSearchText.

Defines the value for the basic search field. The value is set into the basic search field of the filter bar used.

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

Default value is empty string.

Param Type DefaultValue Description
sBasicSearchText string ""

New value for property basicSearchText

setDescriptionKey

Sets a new value for property descriptionKey.

Defines the key of the column used for the token text.

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

Default value is empty string.

Param Type DefaultValue Description
sDescriptionKey string ""

New value for property descriptionKey

setDisplayFormat

Sets a new value for property displayFormat.

Represents the display format of the range values. With the displayFormat value UpperCase, the entered value of the range (condition) is converted to uppercase letters.

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

Default value is empty string.

Param Type DefaultValue Description
sDisplayFormat string ""

New value for property displayFormat

setExcludeRangeOperations

Sets the array for the supported exclude range operations.

Param Type DefaultValue Description
aOperation sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[]

An array of range operations

sType string

the type for which the operations are defined

setFilterBar

Sets the aggregated filterBar.

Param Type DefaultValue Description
oFilterBar sap.ui.comp.filterbar.FilterBar

The filterBar to set

setFilterMode

Sets a new value for property filterMode.

Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens.

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
bFilterMode boolean false

New value for property filterMode

setIncludeRangeOperations

Sets the array for the supported include range operations.

Param Type DefaultValue Description
aOperation sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[]

An array of range operations

sType string

the type for which the operations are defined

setKey

Sets a new value for property key.

Defines the key of the column used for the internal key handling. The value of the column is used for the token key and also to identify the row in the table.

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

Default value is empty string.

Param Type DefaultValue Description
sKey string ""

New value for property key

setKeys

Sets a new value for property keys.

Defines the list of additional keys of the column used for the internal key handling.

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

Param Type DefaultValue Description
sKeys string[]

New value for property keys

setMaxExcludeRanges

Sets a new value for property maxExcludeRanges.

Defines the maximum number of exclude ranges.

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

Default value is '-1'.

Param Type DefaultValue Description
sMaxExcludeRanges string '-1'

New value for property maxExcludeRanges

setMaxIncludeRanges

Sets a new value for property maxIncludeRanges.

Defines the maximum number of include ranges.

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

Default value is '-1'.

Param Type DefaultValue Description
sMaxIncludeRanges string '-1'

New value for property maxIncludeRanges

setRangeKeyFields

Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the ranges. You can set an array of objects with Key and Label properties to define the key fields.

Param Type DefaultValue Description
aRangeKeyFields object[]

An array of range KeyFields [{key: "CompanyCode", label: "ID"}, {key:"CompanyName", label : "Name"}]

setSupportMultiselect

Sets a new value for property supportMultiselect.

Enables multi-selection in the table used.

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
bSupportMultiselect boolean true

New value for property supportMultiselect

setSupportRanges

Sets a new value for property supportRanges.

Enables the ranges (conditions) feature in the dialog.

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
bSupportRanges boolean false

New value for property supportRanges

setSupportRangesOnly

Sets a new value for property supportRangesOnly.

If this property is set to true, the value help dialog only supports the ranges (conditions) feature.

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
bSupportRangesOnly boolean false

New value for property supportRangesOnly

setTable

Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table or sap.m.Table instance internally.

Param Type DefaultValue Description
oTable object

The used table control instance

setTokenDisplayBehaviour

Sets a new value for property tokenDisplayBehaviour.

Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid sap.ui.comp.smartfilterbar.DisplayBehaviour values.

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

Default value is empty string.

Param Type DefaultValue Description
sTokenDisplayBehaviour string ""

New value for property tokenDisplayBehaviour

setTokens

Sets the array of tokens. The sap.m.Tokens are added to the dialog tokenizer. Normal tokens are selected in the table. new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"}); Tokens with the extra data with value 'range' are handled as range tokens or exclude range tokens. new sap.m.Token({key: "i1", text: "ID: a..z"}).data("range", { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, "keyField": "CompanyCode", "value1": "a", "value2": "z"}); The selected items or range tokens are returned in the event parameters of the Ok event.

Param Type DefaultValue Description
aTokens sap.m.Token[]

An array of token controls

update

Updates the selection of rows in the table. This function must be called after a first binding or binding update of the table. It will set a table row as selected if a token for this row exists.