Alloy UI

aui-autocomplete  1.0.1

 
Filters
Classes

Class AutoComplete - extends Component

Known Subclasses:
Textboxlist

A base class for AutoComplete, providing:
  • Widget Lifecycle (initializer, renderUI, bindUI, syncUI, destructor)
  • Presenting users choices based on their input
  • Separating selected items
  • Keyboard interaction for selecting items
Quick Example:
var instance = new A.AutoComplete({
dataSource: [['AL', 'Alabama', 'The Heart of Dixie'],
['AK', 'Alaska', 'The Land of the Midnight Sun'],
['AZ', 'Arizona', 'The Grand Canyon State']],
schema: {
resultFields: ['key', 'name', 'description']
},
matchKey: 'name',
delimChar: ',',
typeAhead: true,
contentBox: '#myAutoComplete'
}).render();
Check the list of Configuration Attributes available for AutoComplete.

Constructor

AutoComplete ( config )
Parameters:
config <Object> Object literal specifying widget configuration properties.

Properties

AutoComplete.ATTRS - static Object

Static property used to define the default attribute configuration for the AutoComplete.

AutoComplete.NAME - static String

Static property provides a string to identify the class.

Properties inherited from Attribute:

Properties inherited from Base:

Properties inherited from Component:

Configuration Attributes

alwaysShowContainer - Boolean

Always show the results container, instead of only showing when the user is requesting them.
Default Value: false

applyLocalFilter - Boolean

If set to true, the filterResults method will be run on the response from the data source.
Default Value: true

autoHighlight - Boolean

Automatically highlight the first item in the list when the results are made visible.
Default Value: true

button - Boolean

To use a button
Deprecated  
Default Value: true

dataSource - Object | String | Function | Array

The data source that results will be read from. This can either be an existing DataSource object, or it can be a value that would be passed to DataSource.
Default Value: null

dataSourceType - String

The type of the data source passed into dataSource. This can be used to explicitly declare what kind of DataSource object will be created.
Default Value: null

delimChar - String

The character used to indicate the beginning or ending of a new value. Most commonly used is a ",".
Default Value: null

forceSelection - Boolean

If typeAhead is true, this will clear a selection when the overlay closes unless a user explicitly selects an item.
Default Value: false

input - String | Node

The input field which will recieve the users input.
Default Value: null

matchKey - String | Number

The key or numeric index in the schema to match the result against.
Default Value: 0

maxResultsDisplayed - Number

The maximum number of results to display.
Default Value: 10

minQueryLength - Number

The minimum number of characters required to query the data source.
Default Value: 1

queryDelay - Number

The amount of time in seconds to delay before submitting the query.
Default Value: 0.2

queryInterval - Number

When IME usage is detected or interval detection is explicitly enabled, AutoComplete will detect the input value at the given interval and send a query if the value has changed.
Default Value: 0.5

queryMatchCase - Boolean

When applyLocalFilter is true, setting this to true will match only results with the same case.
Default Value: false

queryMatchContains - Boolean

When applyLocalFilter is true, setting this to true will match results which contain the query anywhere in the text, instead of just matching just items that start with the query.
Default Value: false

queryQuestionMark - Boolean

For IO DataSources, AutoComplete will automatically insert a "?" between the server URI and the encoded query string. To prevent this behavior, you can set this value to false. If you need to customize this even further, you can override the generateRequest method.
Default Value: true

schema - Object

A valid configuration object for any of DataSource schema plugins.
Default Value: null

schemaType - String

A valid type of DataSource schema plugin, such as array, json, xml, etc.
Default Value: array

suppressInputUpdate - Boolean

Whether or not the input field should be updated with selections.
Default Value: false

typeAhead - Boolean

If autoHighlight is enabled, whether or not the input field should be automatically updated with the first result as the user types, automatically selecting the portion of the text the user has not typed yet.
Default Value: false

typeAheadDelay - Number

If typeAhead is true, number of seconds to delay before updating the input. In order to prevent certain race conditions, this value must always be greater than the queryDelay.
Default Value: 0.2

uniqueName - String

The unique ID of the input element.
Default Value: null

Configuration attributes inherited from Widget:

Configuration attributes inherited from Base:

Configuration attributes inherited from Component:

Methods

_clearSelection

protected void _clearSelection ( )
When forceSelection is true and the user tries to leave the input element without selecting an item from the results, the user selection is cleared.

_createDataSource

protected String _createDataSource ( )
Creates the data source object using the passed in dataSource, and if it is a string, will use the dataSourceType to create a new DataSource object.

_enableIntervalDetection

protected void _enableIntervalDetection ( )
Enables query interval detection for IME support.

_extractQuery

protected String _extractQuery ( query )
Extracts the right most query from the delimited string in the input.
Parameters:
query <String> String to parse

_focus

protected void _focus ( )
Focuses the input element.

_isIgnoreKey

protected String _isIgnoreKey ( Number )
Whether or not the pressed key triggers some functionality or if it should be ignored.
Parameters:
Number <keyCode> The numeric code of the key pressed

_jumpSelection

protected void _jumpSelection ( )
If there is a currently selected item, the right arrow key will select that item and jump to the end of the input element, otherwise the container is closed.

_moveSelection

protected void _moveSelection ( keyCode )
Triggered by the up and down arrow keys, changes the currently selected list element item, and scrolls the container if necessary.
Parameters:
keyCode <Number> The numeric code of the key pressed

_onButtonMouseDown

protected void _onButtonMouseDown ( event )
Called when the user mouses down on the button element in the combobox.
Parameters:
event <EventFacade>

_onContainerClick

protected void _onContainerClick ( event )
Handles when a user clicks on the container.
Parameters:
event <EventFacade>

_onContainerMouseout

protected void _onContainerMouseout ( event )
Handles when a user mouses out of the container.
Parameters:
event <EventFacade>

_onContainerMouseover

protected void _onContainerMouseover ( event )
Handles when a user mouses over the container.
Parameters:
event <EventFacade>

_onContainerScroll

protected void _onContainerScroll ( event )
Handles the container scroll events.
Parameters:
event <EventFacade>

_onInterval

protected void _onInterval ( )
Enables the query to be triggered based on detecting text input via intervals instead of via key events.

_onTextboxBlur

protected void _onTextboxBlur ( event )
Handles the input element losing focus.
Parameters:
event <EventFacade>

_onTextboxFocus

protected void _onTextboxFocus ( event )
Handles the input element gaining focus.
Parameters:
event <EventFacade>

_onTextboxKeyDown

protected void _onTextboxKeyDown ( event )
Handles the keydown events on the input element for functional keys.
Parameters:
event <EventFacade>

_onTextboxKeyPress

protected void _onTextboxKeyPress ( event )
Handles the key press events of the input element.
Parameters:
event <EventFacade>

_onTextboxKeyUp

protected void _onTextboxKeyUp ( event )
Handles the keyup events of the input element.
Parameters:
event <EventFacade>

_populateList

protected void _populateList ( event )
Populates the container with list items of the query results.
Parameters:
event <EventFacade>

_realignContainer

protected void _realignContainer ( event )
Realigns the container to the input element.
Parameters:
event <EventFacade>

_renderInput

protected void _renderInput ( )
Handles the rendering of the input element.

_renderListElements

protected void _renderListElements ( )
Pre-populates the container with the maxResultsDisplayed number of list items.

_renderOverlay

protected void _renderOverlay ( )
Handles the creation of the overlay where the result list will be displayed.

_selectItem

protected void _selectItem ( elListItem )
Selects a list item from the query results.
Parameters:
elListItem <Node> The list item to select

_sendQuery

protected void _sendQuery ( query )
Makes a query request to the data source.
Parameters:
query <String> The query string

_textMatchesOption

protected void _textMatchesOption ( )
Checks to see if the value typed by the user matches any of the query results.

_toggleContainer

protected void _toggleContainer ( show )
Toggles the display of the results container.
Parameters:
show <Boolean> Flag to force the showing or hiding of the container

_toggleHighlight

protected void _toggleHighlight ( elNewListItem , action )
Toggles the highlighting of a list item, and removes the highlighting from the previous item
Parameters:
elNewListItem <Node> The item to be highlighted
action <String> Whether we are moving to or from an item. Valid values are "to" or "from".

_typeAhead

protected void _typeAhead ( elListItem , query )
Updates in the input element with the first result as the user types, selecting the text the user has not typed yet.
Parameters:
elListItem <Node> The selected list item
query <String> The query string

_updateValue

protected void _updateValue ( elListItem )
Updates the input element with the selected query result. If delimChar has been set, then the value gets appended with the delimiter.
Parameters:
elListItem <Node> The selected list item

bindUI

protected void bindUI ( )
Bind the events on the AutoComplete UI. Lifecycle.

doBeforeExpandContainer

Boolean doBeforeExpandContainer ( query , allResults )
An overridable method that is executed before the result container is shown. The method can return false to prevent the container from being shown.
Parameters:
query <String> The query that was submitted to the data source
allResults <Object> The parsed results

doBeforeLoadData

Boolean doBeforeLoadData ( event )
An overridable method that is executed before the result overlay is loaded with results.
Parameters:
event <EventFacade>

filterResults

Object filterResults ( event )
Executed by the data source as a mechanism to do simple client-side filtering of the results.
Parameters:
event <EventFacade>
Returns: Object
Filtered response object

formatResult

String formatResult ( result , request , resultMatch )
An overridable method for formatting the result of the query before it's displayed in the overlay.
Parameters:
result <Object> The result data object
request <String> The current query string
resultMatch <String> The string from the results that matches the query

generateRequest

Object generateRequest ( query )
An overridable method that creates an object to be passed to the sendRequest method of the data source object. Useful to overwrite if you wish to create a custom request object before it's sent.
Parameters:
query <String> The string currently being entered

handleResponse

void handleResponse ( event )
Handles the response for the display of the results. This is a callback method that is fired by the sendRequest method so that results are ready to be accessed.
Parameters:
event <EventFacade>

initializer

protected void initializer ( )
Construction logic executed during AutoComplete instantiation. Lifecycle.

renderUI

protected void renderUI ( )
Create the DOM structure for the AutoComplete. Lifecycle.

sendQuery

void sendQuery ( query )
Sends a query request to the data source object.
Parameters:
query <String> Query string

syncUI

protected void syncUI ( )
Sync the AutoComplete UI. Lifecycle.

Methods inherited from Plugin.Host:

Events

alwaysShowContainerChange

alwaysShowContainerChange ( event )
Fires when the value for the configuration attribute 'alwaysShowContainer' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

applyLocalFilterChange

applyLocalFilterChange ( event )
Fires when the value for the configuration attribute 'applyLocalFilter' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

autoHighlightChange

autoHighlightChange ( event )
Fires when the value for the configuration attribute 'autoHighlight' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

buttonChange

buttonChange ( event )
Fires when the value for the configuration attribute 'button' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

containerCollapse

containerCollapse ( event )
Handles the containerCollapse event. Fired when the container is hidden.
Parameters:
event<Event.Facade> The containerCollapse event.

containerExpand

containerExpand ( event )
Handles the containerExpand event. Fired when the container is shown.
Parameters:
event<Event.Facade> The containerExpand event.

containerPopulate

containerPopulate ( event )
Handles the containerPopulate event. Fired when the container is populated.
Parameters:
event<Event.Facade> The containerPopulate event.

dataError

dataError ( event )
Handles the dataError event. Fired when there is an error accessing the data.
Parameters:
event<Event.Facade> The dataError event.

dataRequest

dataRequest ( event )
Handles the dataRequest event. Fired when ever a query is sent to the data source.
Parameters:
event<Event.Facade> The dataRequest event.

dataReturn

dataReturn ( event )
Handles the dataReturn event. Fired when data successfully comes back from the data request.
Parameters:
event<Event.Facade> The dataReturn event.

dataSourceChange

dataSourceChange ( event )
Fires when the value for the configuration attribute 'dataSource' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

dataSourceTypeChange

dataSourceTypeChange ( event )
Fires when the value for the configuration attribute 'dataSourceType' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

delimCharChange

delimCharChange ( event )
Fires when the value for the configuration attribute 'delimChar' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

forceSelectionChange

forceSelectionChange ( event )
Fires when the value for the configuration attribute 'forceSelection' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

inputChange

inputChange ( event )
Fires when the value for the configuration attribute 'input' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

itemArrowFrom

itemArrowFrom ( event )
Handles the itemArrowFrom event. Fired when the user navigates via the keyboard away from a selected item.
Parameters:
event<Event.Facade> The itemArrowFrom event.

itemArrowTo

itemArrowTo ( event )
Handles the itemArrowTo event. Fired when the user navigates via the keyboard to a selected item.
Parameters:
event<Event.Facade> The itemArrowTo event.

itemMouseOut

itemMouseOut ( event )
Handles the itemMouseOut event. Fired when the user mouses away from an item.
Parameters:
event<Event.Facade> The itemMouseOut event.

itemMouseOver

itemMouseOver ( event )
Handles the itemMouseOver event. Fired when the user mouses over an item.
Parameters:
event<Event.Facade> The itemMouseOver event.

itemSelect

itemSelect ( event )
Handles the itemSelect event. Fired when an item in the list is selected.
Parameters:
event<Event.Facade> The itemSelect event.

matchKeyChange

matchKeyChange ( event )
Fires when the value for the configuration attribute 'matchKey' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

maxResultsDisplayedChange

maxResultsDisplayedChange ( event )
Fires when the value for the configuration attribute 'maxResultsDisplayed' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

minQueryLengthChange

minQueryLengthChange ( event )
Fires when the value for the configuration attribute 'minQueryLength' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

queryDelayChange

queryDelayChange ( event )
Fires when the value for the configuration attribute 'queryDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

queryIntervalChange

queryIntervalChange ( event )
Fires when the value for the configuration attribute 'queryInterval' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

queryMatchCaseChange

queryMatchCaseChange ( event )
Fires when the value for the configuration attribute 'queryMatchCase' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

queryMatchContainsChange

queryMatchContainsChange ( event )
Fires when the value for the configuration attribute 'queryMatchContains' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

queryQuestionMarkChange

queryQuestionMarkChange ( event )
Fires when the value for the configuration attribute 'queryQuestionMark' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

schemaChange

schemaChange ( event )
Fires when the value for the configuration attribute 'schema' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

schemaTypeChange

schemaTypeChange ( event )
Fires when the value for the configuration attribute 'schemaType' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

selectionEnforce

selectionEnforce ( event )
Handles the selectionEnforce event. Fired if forceSelection is enabled and the users input element has been cleared because it did not match one of the results.
Parameters:
event<Event.Facade> The selectionEnforce event.

suppressInputUpdateChange

suppressInputUpdateChange ( event )
Fires when the value for the configuration attribute 'suppressInputUpdate' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

textboxBlur

textboxBlur ( event )
Handles the textboxBlur event. Fired when the user leaves the input element.
Parameters:
event<Event.Facade> The textboxBlur event.

textboxChange

textboxChange ( event )
Handles the textboxChange event. Fired when the value in the input element is changed.
Parameters:
event<Event.Facade> The textboxChange event.

textboxFocus

textboxFocus ( event )
Handles the textboxFocus event. Fired when user moves focus to the input element.
Parameters:
event<Event.Facade> The textboxFocus event.

textboxKey

textboxKey ( event )
Handles the textboxKey event. Fired when the input element receives key input.
Parameters:
event<Event.Facade> The textboxKey event.

typeAhead

typeAhead ( event )
Handles the typeAhead event. Fired when the input element has been pre-filled by the type-ahead feature.
Parameters:
event<Event.Facade> The typeAhead event.

typeAheadChange

typeAheadChange ( event )
Fires when the value for the configuration attribute 'typeAhead' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

typeAheadDelayChange

typeAheadDelayChange ( event )
Fires when the value for the configuration attribute 'typeAheadDelay' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

uniqueNameChange

uniqueNameChange ( event )
Fires when the value for the configuration attribute 'uniqueName' is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.
Parameters:
event<Event.Facade> An Event Facade object with the following attribute specific properties added:
prevVal
The value of the attribute, prior to it being set
newVal
The value the attribute is to be set to
attrName
The name of the attribute being set
subAttrName
If setting a property within the attribute's value, the name of the sub-attribute property being set

unmatchedItemSelect

unmatchedItemSelect ( event )
Handles the unmatchedItemSelect event. Fired when a user selects something that does not match any of the displayed results.
Parameters:
event<Event.Facade> The unmatchedItemSelect event.