Class sap.ui.commons.AutoCompleteModule: sap/ui/commons/AutoComplete
extends ComboBox
implements ToolbarItem
Textfield with list based text completion.
Deprecated API:Since version 1.38.
Since: 1.10.0.
Constructor Summary
Event Summary
suggest(oControlEvent)Fired when the user has changed the value and a suggestion list update should occur.
Events borrowed from class sap.ui.commons.ComboBox
Events borrowed from class sap.ui.commons.TextField
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ui.commons.AutoComplete.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.AutoComplete with name
sClassName and enriches it with the information contained in oClassInfo.sap.ui.commons.AutoComplete.getMetadata()Returns a metadata object for class sap.ui.commons.AutoComplete.
attachSuggest(oData?, fnFunction, oListener?)Attaches event handler
fnFunction to the suggest event of this sap.ui.commons.AutoComplete.detachSuggest(fnFunction, oListener)Detaches event handler
fnFunction from the suggest event of this sap.ui.commons.AutoComplete.Methods borrowed from class sap.ui.commons.ComboBox
_checkChange, addItem, bindItems, destroyItems, fireChange, getAccessibilityInfo, getDisplaySecondaryValues, getF4ButtonDomRef, getItems, getMaxPopupItems, indexOfItem, insertItem, onsapenter, onsapescape, onsaphide, onsapnextmodifiers, onsapshow, removeAllItems, removeItem, setDisplaySecondaryValues, setMaxPopupItems, unbindItems
Methods borrowed from class sap.ui.commons.TextField
addAriaDescribedBy, addAriaLabelledBy, attachChange, attachLiveChange, bindValue, detachChange, detachLiveChange, fireLiveChange, getAccessibleRole, getAriaDescribedBy, getAriaLabelledBy, getDesign, getEditable, getEnabled, getFocusInfo, getHelpId, getImeMode, getInputDomRef, getLiveValue, getMaxLength, getName, getPlaceholder, getRequired, getTextAlign, getTextDirection, getValue, getValueState, getWidth, onfocusin, onkeyup, onsapfocusleave, onselectstart, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setAccessibleRole, setDesign, setEditable, setEnabled, setHelpId, setImeMode, setMaxLength, setName, setPlaceholder, setRequired, setTextAlign, setTextDirection, setValue, setValueState, setWidth, unbindValue
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, 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, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, 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
Constructor Detail
new sap.ui.commons.AutoComplete(sId?, mSettings?)
Constructor for a new AutoComplete.
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
- enableScrolling : boolean (default: true)
- Events
- suggest : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.commons.ComboBox 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 |
- Deprecated:
- Since version 1.38.
Event Detail
suggest(oControlEvent)
Fired when the user has changed the value and a suggestion list update should occur.
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters | |
| {string} | oControlEvent.getParameters.suggestValue | The current value which was typed in. |
Method Detail
sap.ui.commons.AutoComplete.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.AutoComplete 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.commons.ComboBox.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.commons.AutoComplete.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.AutoComplete.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
attachSuggest(oData?, fnFunction, oListener?): sap.ui.commons.AutoComplete
Attaches event handler
fnFunction to the suggest event of this sap.ui.commons.AutoComplete. 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.commons.AutoComplete itself.
Fired when the user has changed the value and a suggestion list update should occur.
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.commons.AutoComplete itself |
Returns:
| {sap.ui.commons.AutoComplete} | Reference to this in order to allow method chaining |
detachSuggest(fnFunction, oListener): sap.ui.commons.AutoComplete
Detaches event handler
fnFunction from the suggest event of this sap.ui.commons.AutoComplete. 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 |
Returns:
| {sap.ui.commons.AutoComplete} | Reference to this in order to allow method chaining |
fireSuggest(mArguments?): sap.ui.commons.AutoComplete
Fires event
suggest to attached listeners. Expects the following event parameters:
suggestValueof typestringThe current value which was typed in.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
| {sap.ui.commons.AutoComplete} | Reference to this in order to allow method chaining |
getEnableScrolling(): boolean
Gets current value of property
enableScrolling. Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems. If set to false only the first n items (n=maxPopupItems) are shown.
Default value is true.
Returns:
| {boolean} | Value of property enableScrolling |
setEnableScrolling(bEnableScrolling): sap.ui.commons.AutoComplete
Sets a new value for property
enableScrolling. Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems. If set to false only the first n items (n=maxPopupItems) are shown.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bEnableScrolling | New value for property enableScrolling |
Returns:
| {sap.ui.commons.AutoComplete} | Reference to this in order to allow method chaining |
setFilterFunction(fFilter?)
Sets a custom filter function for items. Default is to check whether the item text begins with the typed value.
Example: function(sValue, oItem){ return jQuery.sap.startsWithIgnoreCase(oItem.getText(), sValue); }
Parameters:
| {function} | fFilter? | The filter function. If not set the default filter function will be used. |