Class sap.ui.comp.valuehelpdialog.ValueHelpDialogModule: sap/ui/comp/valuehelpdialog/ValueHelpDialog

extends Dialog

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

Constructor Summary
new sap.ui.comp.valuehelpdialog.ValueHelpDialog(sId?, mSettings?)Constructor for a new valuehelpdialog/ValueHelpDialog.
Event Summary
cancel(oControlEvent)This event is fired when the Cancel button is pressed.
ok(oControlEvent)This event is fired when the OK button is pressed.
selectionChange(oControlEvent)This event is fired when the user selects an item in the items table.
tokenRemove(oControlEvent)This event is fired when the user removes one or multiple existing token(s) from the dialog.
updateSelection(oControlEvent)This event is fired when the table gets an update and all existing tokens must be selected in the table.
Events borrowed from class sap.m.Dialog
afterClose, afterOpen, beforeClose, beforeOpen
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.comp.valuehelpdialog.ValueHelpDialog.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.comp.valuehelpdialog.ValueHelpDialog with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.comp.valuehelpdialog.ValueHelpDialog.getMetadata()Returns a metadata object for class sap.ui.comp.valuehelpdialog.ValueHelpDialog.
attachCancel(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
attachOk(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
attachSelectionChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
attachTokenRemove(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
attachUpdateSelection(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
destroyFilterBar()Destroys the filterBar in the aggregation filterBar.
detachCancel(fnFunction, oListener)Detaches event handler fnFunction from the cancel event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
detachOk(fnFunction, oListener)Detaches event handler fnFunction from the ok event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
detachSelectionChange(fnFunction, oListener)Detaches event handler fnFunction from the selectionChange event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
detachTokenRemove(fnFunction, oListener)Detaches event handler fnFunction from the tokenRemove event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
detachUpdateSelection(fnFunction, oListener)Detaches event handler fnFunction from the updateSelection event of this sap.ui.comp.valuehelpdialog.ValueHelpDialog.
fireCancel(mArguments?)Fires event cancel to attached listeners.
fireOk(mArguments?)Fires event ok to attached listeners.
fireSelectionChange(mArguments?)Fires event selectionChange to attached listeners.
fireTokenRemove(mArguments?)Fires event tokenRemove to attached listeners.
fireUpdateSelection(mArguments?)Fires event updateSelection to attached listeners.
getBasicSearchText()Gets current value of property basicSearchText.
getDescriptionKey()Gets current value of property descriptionKey.
getDisplayFormat()Gets current value of property displayFormat.
getFilterBar()Gets content of aggregation filterBar.
getFilterMode()Gets current value of property filterMode.
getKey()Gets current value of property key.
getKeys()Gets current value of property keys.
getMaxExcludeRanges()Gets current value of property maxExcludeRanges.
getMaxIncludeRanges()Gets current value of property maxIncludeRanges.
getSupportMultiselect()Gets current value of property supportMultiselect.
getSupportRanges()Gets current value of property supportRanges.
getSupportRangesOnly()Gets current value of property supportRangesOnly.
getTable()Gives access to the internal table instance.
getTokenDisplayBehaviour()Gets current value of property tokenDisplayBehaviour.
setBasicSearchText(sBasicSearchText)Sets a new value for property basicSearchText.
setDescriptionKey(sDescriptionKey)Sets a new value for property descriptionKey.
setDisplayFormat(sDisplayFormat)Sets a new value for property displayFormat.
setExcludeRangeOperations(aOperation, sType)Sets the array for the supported exclude range operations.
setFilterBar(oFilterBar)Sets the aggregated filterBar.
setFilterMode(bFilterMode)Sets a new value for property filterMode.
setIncludeRangeOperations(aOperation, sType)Sets the array for the supported include range operations.
setKey(sKey)Sets a new value for property key.
setKeys(sKeys)Sets a new value for property keys.
setMaxExcludeRanges(sMaxExcludeRanges)Sets a new value for property maxExcludeRanges.
setMaxIncludeRanges(sMaxIncludeRanges)Sets a new value for property maxIncludeRanges.
setRangeKeyFields(aRangeKeyFields)Sets a RangeKeyFields array.
setSupportMultiselect(bSupportMultiselect)Sets a new value for property supportMultiselect.
setSupportRanges(bSupportRanges)Sets a new value for property supportRanges.
setSupportRangesOnly(bSupportRangesOnly)Sets a new value for property supportRangesOnly.
setTable(aTable)Sets the table used in the value help dialog.
setTokenDisplayBehaviour(sTokenDisplayBehaviour)Sets a new value for property tokenDisplayBehaviour.
setTokens(aTokens)Sets the array of tokens.
update()Updates the selection of rows in the table.
Methods borrowed from class sap.m.Dialog
_getAnyHeader, addAriaDescribedBy, addAriaLabelledBy, addButton, addContent, attachAfterClose, attachAfterOpen, attachBeforeClose, attachBeforeOpen, close, destroyBeginButton, destroyButtons, destroyContent, destroyCustomHeader, destroyEndButton, destroySubHeader, detachAfterClose, detachAfterOpen, detachBeforeClose, detachBeforeOpen, fireAfterClose, fireAfterOpen, fireBeforeClose, fireBeforeOpen, getAriaDescribedBy, getAriaLabelledBy, getBeginButton, getButtons, getContent, getContentHeight, getContentWidth, getCustomHeader, getDraggable, getEndButton, getHorizontalScrolling, getIcon, getInitialFocus, getLeftButton, getResizable, getRightButton, getShowHeader, getState, getStretch, getStretchOnPhone, getSubHeader, getTitle, getType, getVerticalScrolling, indexOfButton, indexOfContent, insertButton, insertContent, isOpen, open, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAllButtons, removeAllContent, removeAriaDescribedBy, removeAriaLabelledBy, removeButton, removeContent, setBeginButton, setContentHeight, setContentWidth, setCustomHeader, setDraggable, setEndButton, setHorizontalScrolling, setIcon, setInitialFocus, setLeftButton, setResizable, setRightButton, setShowHeader, setState, setStretch, setStretchOnPhone, setSubHeader, setTitle, setType, setVerticalScrolling
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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.valuehelpdialog.ValueHelpDialog(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.m.Dialog 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
Event Detail
cancel(oControlEvent)
This event is fired when the Cancel button is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Since:
1.24
ok(oControlEvent)
This event is fired when the OK button is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.m.Token[]}oControlEvent.getParameters.tokens The array of tokens created or modified on the ValueHelpDialog.
Since:
1.24
selectionChange(oControlEvent)
This event is fired when the user selects an item in the items table. The event will only be raised when the dialog gets a table instance from outside via setTable.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{object}oControlEvent.getParameters.tableSelectionParams The RowSelectionChange event parameter from the hosted table that contains the selected items.
{object[]}oControlEvent.getParameters.updateTokens 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}, ...]
{boolean}oControlEvent.getParameters.useDefault Can be set to true to execute the default behaviour of the ValueHelpDialog.
Since:
1.32
tokenRemove(oControlEvent)
This event is fired when the user removes one or multiple existing token(s) from the dialog. The event will only be raised when the dialog gets a table instance from outside via setTable.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string[]}oControlEvent.getParameters.tokenKeys The array of token keys that has been removed.
{boolean}oControlEvent.getParameters.useDefault Can be set to true to execute the default behaviour of ValueHelpDialog.
Since:
1.32
updateSelection(oControlEvent)
This event is fired when the table gets an update and all existing tokens must be selected in the table. The event will only be raised when the dialog gets a table instance from outside via setTable.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string[]}oControlEvent.getParameters.tokenKeys The array of existing token keys for which the selection in the table has to be updated.
{boolean}oControlEvent.getParameters.useDefault Can be set to true to execute the default behavior of ValueHelpDialog.
Since:
1.32
Method Detail
sap.ui.comp.valuehelpdialog.ValueHelpDialog.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.valuehelpdialog.ValueHelpDialog.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.comp.valuehelpdialog.ValueHelpDialog.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachCancel(oData?, fnFunction, oListener?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
attachOk(oData?, fnFunction, oListener?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
attachSelectionChange(oData?, fnFunction, oListener?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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. The event will only be raised when the dialog gets a table instance from outside via setTable.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
attachTokenRemove(oData?, fnFunction, oListener?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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. The event will only be raised when the dialog gets a table instance from outside via setTable.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
attachUpdateSelection(oData?, fnFunction, oListener?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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. The event will only be raised when the dialog gets a table instance from outside via setTable.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.comp.valuehelpdialog.ValueHelpDialog itself
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
destroyFilterBar(): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Destroys the filterBar in the aggregation filterBar.
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
detachCancel(fnFunction, oListener): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
detachOk(fnFunction, oListener): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
detachSelectionChange(fnFunction, oListener): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
detachTokenRemove(fnFunction, oListener): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
detachUpdateSelection(fnFunction, oListener): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
fireCancel(mArguments?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Fires event cancel to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
fireOk(mArguments?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Fires event ok to attached listeners.

Expects the following event parameters:

  • tokens of type sap.m.Token[]The array of tokens created or modified on the ValueHelpDialog.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
fireSelectionChange(mArguments?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Fires event selectionChange to attached listeners.

Expects the following event parameters:

  • tableSelectionParams of type objectThe RowSelectionChange event parameter from the hosted table that contains the selected items.
  • updateTokens of type 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 of type booleanCan be set to true to execute the default behaviour of the ValueHelpDialog.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
fireTokenRemove(mArguments?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Fires event tokenRemove to attached listeners.

Expects the following event parameters:

  • tokenKeys of type string[]The array of token keys that has been removed.
  • useDefault of type booleanCan be set to true to execute the default behaviour of ValueHelpDialog.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
fireUpdateSelection(mArguments?): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Fires event updateSelection to attached listeners.

Expects the following event parameters:

  • tokenKeys of type string[]The array of existing token keys for which the selection in the table has to be updated.
  • useDefault of type booleanCan be set to true to execute the default behavior of ValueHelpDialog.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Since:
1.32
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
getBasicSearchText(): string
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.

Since:
1.24
Returns:
{string} Value of property basicSearchText
getDescriptionKey(): string
Gets current value of property descriptionKey.

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

Since:
1.24
Returns:
{string} Value of property descriptionKey
getDisplayFormat(): string
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.

Since:
1.24
Returns:
{string} Value of property displayFormat
getFilterBar(): sap.ui.comp.filterbar.FilterBar
Gets content of aggregation filterBar.

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

Returns:
{sap.ui.comp.filterbar.FilterBar}
getFilterMode(): boolean
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.

Since:
1.24
Returns:
{boolean} Value of property filterMode
getKey(): string
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.

Since:
1.24
Returns:
{string} Value of property key
getKeys(): string[]
Gets current value of property keys.

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

Since:
1.24
Returns:
{string[]} Value of property keys
getMaxExcludeRanges(): string
Gets current value of property maxExcludeRanges.

Defines the maximum number of exclude ranges.

Default value is -1.

Since:
1.24
Returns:
{string} Value of property maxExcludeRanges
getMaxIncludeRanges(): string
Gets current value of property maxIncludeRanges.

Defines the maximum number of include ranges.

Default value is -1.

Since:
1.24
Returns:
{string} Value of property maxIncludeRanges
getSupportMultiselect(): boolean
Gets current value of property supportMultiselect.

Enables multi-selection in the table used.

Default value is true.

Since:
1.24
Returns:
{boolean} Value of property supportMultiselect
getSupportRanges(): boolean
Gets current value of property supportRanges.

Enables the ranges (conditions) feature in the dialog.

Default value is false.

Since:
1.24
Returns:
{boolean} Value of property supportRanges
getSupportRangesOnly(): boolean
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.

Since:
1.24
Returns:
{boolean} Value of property supportRangesOnly
getTable(): object
Gives access to the internal table instance.
Since:
1.28
Returns:
{object} the used table instance
getTokenDisplayBehaviour(): string
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.ControlConfiguration.DISPLAYBEHAVIOUR values.

Since:
1.24
Returns:
{string} Value of property tokenDisplayBehaviour
setBasicSearchText(sBasicSearchText): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sBasicSearchText New value for property basicSearchText
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setDescriptionKey(sDescriptionKey): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sDescriptionKey New value for property descriptionKey
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setDisplayFormat(sDisplayFormat): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sDisplayFormat New value for property displayFormat
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setExcludeRangeOperations(aOperation, sType)
Sets the array for the supported exclude range operations.
Parameters:
{sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[]}aOperation An array of range operations
{string}sType the type for which the operations are defined
Since:
1.24
setFilterBar(oFilterBar): sap.ui.comp.valuehelpdialog.ValueHelpDialog
Sets the aggregated filterBar.
Parameters:
{sap.ui.comp.filterbar.FilterBar}oFilterBar The filterBar to set
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setFilterMode(bFilterMode): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{boolean}bFilterMode New value for property filterMode
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setIncludeRangeOperations(aOperation, sType)
Sets the array for the supported include range operations.
Parameters:
{sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[]}aOperation An array of range operations
{string}sType the type for which the operations are defined
Since:
1.24
setKey(sKey): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sKey New value for property key
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setKeys(sKeys): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string[]}sKeys New value for property keys
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setMaxExcludeRanges(sMaxExcludeRanges): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sMaxExcludeRanges New value for property maxExcludeRanges
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setMaxIncludeRanges(sMaxIncludeRanges): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{string}sMaxIncludeRanges New value for property maxIncludeRanges
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setRangeKeyFields(aRangeKeyFields)
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.
Parameters:
{object[]}aRangeKeyFields An array of range KeyFields [{key: "CompanyCode", label: "ID"}, {key:"CompanyName", label : "Name"}]
Since:
1.24
setSupportMultiselect(bSupportMultiselect): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{boolean}bSupportMultiselect New value for property supportMultiselect
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setSupportRanges(bSupportRanges): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{boolean}bSupportRanges New value for property supportRanges
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setSupportRangesOnly(bSupportRangesOnly): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.

Parameters:
{boolean}bSupportRangesOnly New value for property supportRangesOnly
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setTable(aTable)
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.
Parameters:
{object}aTable The used table control instance
Since:
1.32
setTokenDisplayBehaviour(sTokenDisplayBehaviour): sap.ui.comp.valuehelpdialog.ValueHelpDialog
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.ControlConfiguration.DISPLAYBEHAVIOUR values.

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

Parameters:
{string}sTokenDisplayBehaviour New value for property tokenDisplayBehaviour
Since:
1.24
Returns:
{sap.ui.comp.valuehelpdialog.ValueHelpDialog} Reference to this in order to allow method chaining
setTokens(aTokens)
Sets the array of tokens. The sap.m.Tokens are added to the dialog tokenizer Selected Items or Excluded Items. Normal tokens are added to the Selected Items tokenizer only and 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.

Parameters:
{sap.m.Token[]}aTokens An array of token controls
Since:
1.24
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.
Since:
1.24