AutoCompleteList Class
Traditional autocomplete dropdown list widget, just like Mom used to make.
Constructor
Item Index
Methods
- _activateNextItem
- _activatePrevItem
- _add
- _addAttrs
- _addLazyAttr
- _afterActiveItemChange
- _afterAlignChange
- _afterAlignOnChange
- _afterAlwaysShowListChange
- _afterChildSelectedChange
- _afterDocClick
- _afterHoveredItemChange
- _afterListInputBlur
- _afterListInputFocus
- _afterMouseOut
- _afterMouseOver
- _afterResultsChange
- _afterSourceTypeChange
- _afterValueChange
- _afterVisibleChange
- _afterXYChange
- _aggregateAttrs
- _applyParsedConfig
- _applyParser
- _ariaSay
- _attachPosAlignUIHandles
- _attrCfgHash
- _baseDestroy
- _baseInit
- _beforeCreateObjectSource
- _bindAttrUI
- _bindDOM
- _bindInput
- _bindKeys
- _bindList
- _bindUI
- _bindUIACBase
- _bindUIChild
- _bindUIPosAlign
- _bindUIPosition
- _clear
- _createAriaNode
- _createArraySource
- _createFunctionSource
- _createIOSource
- _createItemNode
- _createJSONPSource
- _createListNode
- _createObjectSource
- _createSelectSource
- _createStringSource
- _createUIEvent
- _createYQLSource
- _defAttrChangeFn
- _defaultCB
- _defaultYQLLocator
- _defClearFn
- _defDestroyFn
- _defInitFn
- _defQueryFn
- _defRenderFn
- _defResultsFn
- _defSelectFn
- _destroyBox
- _destroyHierarchy
- _destroyUIEvents
- _detachPosAlignUIHandles
- _doAlign
- _filterAdHocAttrs
- _filterAttrCfs
- _filterUIEvent
- _fireAttrChange
- _functionValidator
- _getAttr
- _getAttrCfg
- _getAttrCfgs
- _getAttrInitVal
- _getAttrs
- _getClasses
- _getFirstItemNode
- _getHtmlParser
- _getLastItemNode
- _getNodeToParse
- _getObjectValue
- _getRegion
- _getSrcNode
- _getStateVal
- _getStrings
- _getType
- _getUIEventNode
- _getX
- _getXHRUrl
- _getY
- _guid
- _initAttrHost
- _initAttribute
- _initAttrs
- _initBase
- _initHierarchy
- _initHierarchyData
- _initKeys
- _initUIEvent
- _isLazyAttr
- _isUIEvent
- _jsonpFormatter
- _keyDown
- _keyEnter
- _keyEsc
- _keyTab
- _keyUp
- _mapInstance
- _monitor
- _normAttrVals
- _onDocFocus
- _onDocMouseDown
- _onInputBlur
- _onInputKey
- _onInputValueChange
- _onItemClick
- _onResponse
- _parseResponse
- _parseType
- _parseValue
- _preInitEventCfg
- _protectAttrs deprecated
- _removeLoadingClassNames
- _renderBox
- _renderBoxClassNames
- _renderUI
- _renderUIPosition
- _set
- _setAlignCenter
- _setAttr
- _setAttrs
- _setAttrUI
- _setAttrVal
- _setBB
- _setBox
- _setCB
- _setEnableCache
- _setLocator
- _setRequestTemplate
- _setResultFilters
- _setResultHighlighter
- _setSource
- _setStateVal
- _setStrings
- _setX
- _setY
- _sourceSuccess
- _strSetter
- _syncAttrUI
- _syncBrowserAutocomplete
- _syncPosition
- _syncResults
- _syncShim
- _syncUI
- _syncUIACBase
- _syncUIChild
- _syncUIPosAlign
- _syncUIPosition
- _syncVisibility
- _uiSetAlign
- _uiSetChildSelected
- _uiSetDim
- _uiSetDisabled
- _uiSetFocused
- _uiSetHeight
- _uiSetTabIndex
- _uiSetVisible
- _uiSetVisiblePosAlign
- _uiSetWidth
- _uiSetXY
- _uiSizeCB
- _unbindDOM
- _unbindKeys
- _unbindUI
- _updateValue
- _validateXY
- _validTabIndex
- addAttr
- addAttrs
- addTarget
- after
- align
- ancestor
- attrAdded
- before
- bindUI
- blur
- bubble
- centered
- clearCache
- destroy
- destructor
- detach
- detachAll
- disable
- enable
- fire
- focus
- get
- getAttrs
- getClassName
- getDefaultLocale
- getEvent
- getSkinName
- getString deprecated
- getStrings deprecated
- getTargets
- hide
- init
- initializer
- isRoot
- modifyAttr
- move
- next
- on
- once
- onceAfter
- parseType
- previous
- publish
- removeAttr
- removeTarget
- render
- renderer
- renderUI
- reset
- selectItem
- sendRequest
- set
- setAttrs
- show
- subscribe deprecated
- syncUI
- syncXY
- toString
- unsubscribe deprecated
- unsubscribeAll deprecated
Properties
Attributes
- activateFirstItem
- activeItem
- align
- alignOn
- allowBrowserAutocomplete
- allowTrailingDelimiter
- alwaysShowList
- boundingBox
- centered
- circular
- contentBox
- destroyed
- disabled
- enableCache
- focused
- height
- hoveredItem
- id
- initialized
- inputNode
- listNode
- locale
- maxResults
- minQueryLength
- query
- queryDelay
- queryDelimiter
- render
- rendered
- requestTemplate
- resultFilters
- resultFormatter
- resultHighlighter
- resultListLocator
- results
- resultTextLocator
- scrollIntoView
- source
- sourceType
- srcNode
- strings
- tabIndex
- tabSelect
- tokenInput
- value
- visible
- width
- x
- xy
- y
- yqlEnv
- yqlProtocol
Methods
_activateNextItem
()
protected
chainable
Activates the next item after the currently active item. If there is no next
item and the circular attribute is true, focus will wrap back to the
input node.
_activatePrevItem
()
protected
chainable
Activates the item previous to the currently active item. If there is no
previous item and the circular attribute is true, focus will wrap back
to the input node.
_add
-
items
Appends the specified result items to the list inside a new item node.
Parameters:
-
itemsArray | Node | HTMLElement | StringResult item or array of result items.
Returns:
_addAttrs
-
cfgs -
values -
lazy
Implementation behind the public addAttrs method.
This method is invoked directly by get if it encounters a scenario in which an attribute's valueFn attempts to obtain the value an attribute in the same group of attributes, which has not yet been added (on demand initialization).
Parameters:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
-
lazyBooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
_addLazyAttr
-
name
Finishes initializing an attribute which has been lazily added.
Parameters:
-
nameObjectThe name of the attribute
_afterAlignChange
-
e
Handles alignChange events by updating the UI in response to align
Attribute changes.
Parameters:
_afterAlignOnChange
-
e
Handles alignOnChange events by updating the alignment-syncing event
handlers.
Parameters:
_afterAlwaysShowListChange
-
e
Handles alwaysShowListChange events.
Parameters:
_afterChildSelectedChange
-
event
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
Parameters:
-
eventEventFacadeThe event facade for the attribute change.
_afterDocClick
-
e
Handles click events on the document. If the click is outside both the input node and the bounding box, the list will be hidden.
Parameters:
_afterListInputBlur
()
protected
Handles inputNode blur events.
_afterListInputFocus
()
protected
Handles inputNode focus events.
_afterSourceTypeChange
-
e
Updates the current source based on the new sourceType to ensure that
the two attributes don't get out of sync when they're changed separately.
Parameters:
_afterValueChange
-
e
Handles change events for the value attribute.
Parameters:
_afterXYChange
-
e
Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.
Parameters:
-
eEventFacadeThe event facade for the attribute change
_aggregateAttrs
-
allAttrs
A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.
The method will protect the attribute configuration value to protect the statically defined default value in ATTRS if required (if the value is an object literal, array or the attribute configuration has cloneDefaultValue set to shallow or deep).
Parameters:
-
allAttrsArrayAn array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
Returns:
_applyParser
-
config
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
Parameters:
-
configObjectUser configuration object (will be populated with values from Node)
_ariaSay
-
stringId -
[subs]
Updates the ARIA live region with the specified message.
_attachPosAlignUIHandles
()
protected
Attaches the alignment-syncing event handlers.
_attrCfgHash
()
private
Utility method to define the attribute hash used to filter/whitelist property mixes for this class.
_baseDestroy
()
private
Internal destroy implementation for BaseCore
_baseInit
()
private
Internal initialization implementation for BaseCore
_beforeCreateObjectSource
-
source
Runs before AutoCompleteBase's _createObjectSource() method and augments
it to support additional object-based source types.
Parameters:
-
sourceString
_bindAttrUI
-
attrs
Binds after listeners for the list of attributes provided
Parameters:
-
attrsArray
_bindDOM
()
protected
Sets up DOM listeners, on elements rendered by the widget.
_bindInput
()
protected
Binds inputNode events and behavior.
_bindKeys
()
protected
Binds keyboard events.
_bindList
()
protected
Binds list events.
_bindUI
()
protected
Sets up DOM and CustomEvent listeners for the widget.
_bindUIACBase
()
protected
Attaches event listeners and behaviors.
_bindUIChild
()
protected
Binds event listeners responsible for updating the UI state in response to WidgetChild related state changes.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_bindUIPosAlign
()
protected
Bind event listeners responsible for updating the UI state in response to the widget's position-align related state changes.
This method is invoked after bindUI has been invoked for the Widget
class using the AOP infrastructure.
_bindUIPosition
()
protected
Binds event listeners responsible for updating the UI state in response to Widget position related state changes.
This method in invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_clear
()
protected
Clears the contents of the tray.
_createAriaNode
()
Node
protected
Creates and returns an ARIA live region node.
Returns:
_createArraySource
-
source
Creates a DataSource-like object that simply returns the specified array as
a response. See the source attribute for more details.
Parameters:
-
sourceArray
Returns:
_createFunctionSource
-
source
Creates a DataSource-like object that passes the query to a custom-defined
function, which is expected to call the provided callback with an array of
results. See the source attribute for more details.
Parameters:
-
sourceFunctionFunction that accepts a query and a callback as parameters, and calls the callback with an array of results.
Returns:
_createIOSource
-
source
Creates a DataSource-like object that uses Y.io as a source. See the
source attribute for more details.
Parameters:
-
sourceStringURL.
Returns:
_createItemNode
-
result
Creates and returns an item node with the specified content.
Parameters:
-
resultObjectResult object.
Returns:
_createJSONPSource
-
source
Creates a DataSource-like object that uses the specified JSONPRequest
instance as a source. See the source attribute for more details.
Parameters:
-
sourceJSONPRequest | StringURL string or JSONPRequest instance.
Returns:
_createListNode
()
Node
protected
Creates and returns a list node. If the listNode attribute is already set
to an existing node, that node will be used.
Returns:
_createObjectSource
-
source
Creates a DataSource-like object that looks up queries as properties on the
specified object, and returns the found value (if any) as a response. See
the source attribute for more details.
Parameters:
-
sourceObject
Returns:
_createSelectSource
-
source
Creates a DataSource-like object that uses the specified <select> node as
a source.
Parameters:
-
sourceNodeYUI Node instance wrapping a
<select>node.
Returns:
_createStringSource
-
source
Creates a DataSource-like object that calls the specified URL or executes
the specified YQL query for results. If the string starts with "select ",
"use ", or "set " (case-insensitive), it's assumed to be a YQL query;
otherwise, it's assumed to be a URL (which may be absolute or relative).
URLs containing a "{callback}" placeholder are assumed to be JSONP URLs; all
others will use XHR. See the source attribute for more details.
Parameters:
-
sourceStringURL or YQL query.
Returns:
_createUIEvent
-
type
Binds a delegated DOM event listener of the specified type to the Widget's outtermost DOM element to facilitate the firing of a Custom Event of the same type for the Widget instance.
Parameters:
-
typeStringString representing the name of the event
_createYQLSource
-
source
Creates a DataSource-like object that uses the specified YQL query string to
create a YQL-based source. See the source attribute for details. If no
resultListLocator is defined, this method will set a best-guess locator
that might work for many typical YQL queries.
Parameters:
-
sourceStringYQL query.
Returns:
_defAttrChangeFn
-
e
Default function for attribute change events.
Parameters:
-
eEventFacadeThe event object for attribute change events.
_defaultCB
()
protected
Returns the default value for the contentBox attribute.
For the Widget class, this will be the srcNode if provided, otherwise null (resulting in a new contentBox node instance being created)
_defaultYQLLocator
-
response
Default resultListLocator used when a string-based YQL source is set and the implementer hasn't already specified one.
Parameters:
-
responseObjectYQL response object.
Returns:
_defClearFn
()
protected
Default clear event handler. Sets the results attribute to an empty
array and query to null.
_defInitFn
-
e
Default init event handler
Parameters:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
_defQueryFn
-
e
Default query event handler. Sets the query attribute and sends a
request to the source if one is configured.
Parameters:
_defRenderFn
-
e -
parentNode
Default render handler
Parameters:
-
eEventFacadeThe Event object
-
parentNodeNodeThe parent node to render to, if passed in to the
rendermethod
_defResultsFn
-
e
Default results event handler. Sets the results attribute to the latest
results.
Parameters:
_destroyBox
()
protected
Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyHierarchy
()
private
Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyUIEvents
()
private
Destructor logic for UI event infrastructure, invoked during Widget destruction.
_detachPosAlignUIHandles
()
protected
Detaches the alignment-syncing event handlers.
_doAlign
-
widgetPoint -
x -
y
Helper method, used to align the given point on the widget, with the XY page coordinates provided.
_filterAdHocAttrs
-
allAttrs -
userVals
Parameters:
-
allAttrsObjectThe set of all attribute configurations for this instance. Attributes will be removed from this set, if they belong to the filtered class, so that by the time all classes are processed, allCfgs will be empty.
-
userValsObjectThe config object passed in by the user, from which adhoc attrs are to be filtered.
Returns:
_filterAttrCfs
-
clazz -
allCfgs
A helper method used when processing ATTRS across the class hierarchy during initialization. Returns a disposable object with the attributes defined for the provided class, extracted from the set of all attributes passed in.
Parameters:
Returns:
_filterUIEvent
-
evt
This method is used to determine if we should fire the UI Event or not. The default implementation makes sure that for nested delegates (nested unrelated widgets), we don't fire the UI event listener more than once at each level.
For example, without the additional filter, if you have nested widgets, each widget will have a delegate listener. If you click on the inner widget, the inner delegate listener's filter will match once, but the outer will match twice (based on delegate's design) - once for the inner widget, and once for the outer.
Parameters:
-
evtDOMEventFacade
Returns:
_fireAttrChange
-
attrName -
subAttrName -
currVal -
newVal -
opts
Utility method to help setup the event payload and fire the attribute change event.
Parameters:
-
attrNameStringThe name of the attribute
-
subAttrNameStringThe full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
-
currValAnyThe current value of the attribute
-
newValAnyThe new value of the attribute
-
optsObjectAny additional event data to mix into the attribute change event's event facade.
_functionValidator
-
value
Returns true if value is either a function or null.
Parameters:
-
valueFunction | NullValue to validate.
_getAttr
-
name
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
Parameters:
-
nameStringThe name of the attribute.
Returns:
_getAttrCfg
-
name
Returns an object with the configuration properties (and value) for the given attribute. If attrName is not provided, returns the configuration properties for all attributes.
Parameters:
-
nameStringOptional. The attribute name. If not provided, the method will return the configuration for all attributes.
Returns:
_getAttrCfgs
()
Object
protected
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
Returns:
_getAttrInitVal
-
attr -
cfg -
initValues
Returns the initial value of the given attribute from either the default configuration provided, or the over-ridden value if it exists in the set of initValues provided and the attribute is not read-only.
Parameters:
Returns:
_getAttrs
-
attrs
Implementation behind the public getAttrs method, to get multiple attribute values.
Parameters:
-
attrsArray | booleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
_getClasses
()
Function[]
protected
Returns the class hierarchy for this object, with BaseCore being the last class in the array.
Returns:
_getFirstItemNode
()
Node | Null
protected
Gets the first item node in the list, or null if the list is empty.
Returns:
_getHtmlParser
()
Object
private
Gets the HTMLPARSER definition for this instance, by merging HTMLPARSER definitions across the class hierarchy.
Returns:
_getLastItemNode
()
Node | Null
protected
Gets the last item node in the list, or null if the list is empty.
Returns:
_getNodeToParse
()
Node
private
Determines whether we have a node reference which we should try and parse.
The current implementation does not parse nodes generated from CONTENT_TEMPLATE, only explicitly set srcNode, or contentBox attributes.
Returns:
_getObjectValue
-
obj -
path
Faster and safer alternative to Y.Object.getValue(). Doesn't bother
casting the path to an array (since we already know it's an array) and
doesn't throw an error if a value in the middle of the object hierarchy is
neither undefined nor an object.
Returns:
undefined if the value was
not found at the specified path.
_getRegion
-
[node]
Returns the region of the passed-in Node, or the viewport region if
calling with passing in a Node.
Parameters:
-
[node]Node optionalThe node to get the region of.
Returns:
_getStateVal
-
name
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
Returns:
_getStrings
-
locale
Returns the strings key/value hash for a paricular locale, without locale lookup applied.
Parameters:
-
localeObject
_getType
()
private
If the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNode
()
protected
Returns the node on which to bind delegate listeners.
Override of Widget's implementation of _getUIEventNode() to ensure that all event listeners are bound to the Widget's topmost DOM element. This ensures that the firing of each type of Widget UI event (click, mousedown, etc.) is facilitated by a single, top-level, delegated DOM event listener.
_getX
()
Number
protected
Default getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
Returns:
_getXHRUrl
-
url -
request
Returns a formatted XHR URL based on the specified base url, query, and the current requestTemplate if any.
Parameters:
Returns:
_getY
()
Number
protected
Default getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
Returns:
_guid
()
protected
_initAttrHost
-
attrs -
values -
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
Parameters:
-
attrsObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
-
valuesObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initAttribute
()
private
Initializes AttributeCore
_initAttrs
-
attrs -
values -
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
Parameters:
-
attrsObjectThe attributes to add during construction (passed through to addAttrs). These can also be defined on the constructor being augmented with Attribute by defining the ATTRS property on the constructor.
-
valuesObjectThe initial attribute values to apply (passed through to addAttrs). These are not merged/cloned. The caller is responsible for isolating user provided values if required.
-
lazyBooleanWhether or not to add attributes lazily (passed through to addAttrs).
_initBase
-
config
Internal construction logic for BaseCore.
Parameters:
-
configObjectThe constructor configuration object
_initHierarchy
-
userVals
Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static ATTRS property and invoking the initializer method on the prototype of each class in the hierarchy.
Parameters:
-
userValsObjectObject with configuration property name/value pairs
_initHierarchyData
()
private
A helper method used by _getClasses and _getAttrCfgs, which determines both the array of classes and aggregate set of attribute configurations across the class hierarchy for the instance.
_initKeys
()
protected
Initializes keyboard command mappings.
_initUIEvent
-
type
Sets up infrastructure required to fire a UI event.
Parameters:
-
typeStringString representing the name of the event
Returns:
_isLazyAttr
-
name
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
Parameters:
-
nameStringThe name of the attribute
Returns:
_isUIEvent
-
type
Determines if the specified event is a UI event.
Parameters:
-
typeStringString representing the name of the event
Returns:
_jsonpFormatter
-
url -
proxy -
query
URL formatter passed to JSONPRequest instances.
Returns:
_keyDown
()
protected
Called when the down arrow key is pressed.
_keyEnter
()
protected
Called when the enter key is pressed.
_keyEsc
()
protected
Called when the escape key is pressed.
_keyTab
()
protected
Called when the tab key is pressed.
_keyUp
()
protected
Called when the up arrow key is pressed.
_mapInstance
-
The
Utility method used to add an entry to the boundingBox id to instance map.
This method can be used to populate the instance with lazily created boundingBox Node references.
Parameters:
-
TheStringboundingBox id
_monitor
-
what -
eventType -
o
This is the entry point for the event monitoring system. You can monitor 'attach', 'detach', 'fire', and 'publish'. When configured, these events generate an event. click -> clickattach, clickdetach, click_publish -- these can be subscribed to like other events to monitor the event system. Inividual published events can have monitoring turned on or off (publish can't be turned off before it it published) by setting the events 'monitor' config.
Parameters:
-
whatString'attach', 'detach', 'fire', or 'publish'
-
eventTypeString | CustomEventThe prefixed name of the event being monitored, or the CustomEvent object.
-
oObjectInformation about the event interaction, such as fire() args, subscription category, publish config
_normAttrVals
-
valueHash
Utility method to split out simple attribute name/value pairs ("x") from complex attribute name/value pairs ("x.y.z"), so that complex attributes can be keyed by the top level attribute name.
Parameters:
-
valueHashObjectAn object with attribute name/value pairs
Returns:
_onDocFocus
-
evt
DOM focus event handler, used to sync the state of the Widget with the DOM
Parameters:
-
evtEventFacadeThe event facade for the DOM focus event
_onDocMouseDown
-
evt
"mousedown" event handler for the owner document of the widget's bounding box.
Parameters:
-
evtEventFacadeThe event facade for the DOM focus event
_onInputValueChange
-
e
Handles valueChange events on the input node and fires a query event
when the input value meets the configured criteria.
Parameters:
_onItemClick
-
e
Delegated event handler for item click events.
Parameters:
_onResponse
-
e
Handles source responses and fires the results event.
Parameters:
_parseResponse
-
query -
response -
data
Parses result responses, performs filtering and highlighting, and fires the
results event.
_parseType
()
private
Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_parseValue
-
value
Returns the query portion of the specified input value, or null if there
is no suitable query within the input value.
If a query delimiter is defined, the query will be the last delimited part of of the string.
Parameters:
-
valueStringInput value from which to extract the query.
Returns:
_preInitEventCfg
-
config
Handles the special on, after and target properties which allow the user to easily configure on and after listeners as well as bubble targets during construction, prior to init.
Parameters:
-
configObjectThe user configuration object
_protectAttrs
-
attrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
Parameters:
-
attrsObjectA hash of attribute to configuration object pairs.
Returns:
_removeLoadingClassNames
()
protected
Removes class names representative of the widget's loading state from the boundingBox.
_renderBox
-
parentNode
Helper method to collect the boundingBox and contentBox and append to the provided parentNode, if not already a child. The owner document of the boundingBox, or the owner document of the contentBox will be used as the document into which the Widget is rendered if a parentNode is node is not provided. If both the boundingBox and the contentBox are not currently in the document, and no parentNode is provided, the widget will be rendered to the current document's body.
Parameters:
-
parentNodeNodeThe parentNode to render the widget to. If not provided, and both the boundingBox and the contentBox are not currently in the document, the widget will be rendered to the current document's body.
_renderBoxClassNames
()
protected
Applies standard class names to the boundingBox and contentBox
_renderUI
()
protected
Initializes the UI state for the Widget's bounding/content boxes.
_renderUIPosition
()
protected
Creates/Initializes the DOM to support xy page positioning.
This method in invoked after renderUI is invoked for the Widget class using YUI's aop infrastructure.
_set
-
name -
val
Allows setting of readOnly/writeOnce attributes. See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valAnyThe value to set the attribute to.
Returns:
_setAlignCenter
-
val
Default setter for center Attribute changes. Sets up the appropriate
value, and passes it through the to the align attribute.
_setAttr
-
name -
value -
opts -
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
Parameters:
-
nameStringThe name of the attribute.
-
valueAnyThe value to set the attribute to.
-
optsObject(Optional) Optional event data to be mixed into the event facade passed to subscribers of the attribute's change event. This is currently a hack. There's no real need for the AttributeCore implementation to support this parameter, but breaking it out into AttributeObservable, results in additional function hops for the critical path.
-
forceBooleanIf true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.
Returns:
_setAttrs
-
attrs
Implementation behind the public setAttrs method, to set multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
Returns:
_setAttrVal
-
attrName -
subAttrName -
prevVal -
newVal
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
Parameters:
Returns:
_setBB
-
Node/String
Setter for the boundingBox attribute
Parameters:
-
Node/StringObject
Returns:
_setBox
-
id -
node -
template -
true
Helper method to set the bounding/content box, or create it from the provided template if not found.
Parameters:
Returns:
_setCB
-
node
Setter for the contentBox attribute
Returns:
_setLocator
-
locator
Setter for locator attributes.
Returns:
_setRequestTemplate
-
template
Setter for the requestTemplate attribute.
Returns:
_setResultFilters
-
filters
Setter for the resultFilters attribute.
Parameters:
Returns:
null).
_setResultHighlighter
-
highlighter
Setter for the resultHighlighter attribute.
Parameters:
Returns:
_setSource
-
source
Setter for the source attribute. Returns a DataSource or a DataSource-like
object depending on the type of source and/or the value of the
sourceType attribute.
Parameters:
-
sourceAnyAutoComplete source. See the
sourceattribute for details.
Returns:
_setStateVal
-
name -
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
Parameters:
-
nameStringThe name of the attribute
-
valueAnyThe value of the attribute
_setStrings
-
strings -
locale
Sets strings for a particular locale, merging with any existing strings which may already be defined for the locale.
_setX
-
val
Default setter for the X attribute. The setter passes the X value through to the XY attribute, which is the sole store for the XY state.
Parameters:
-
valNumberThe X page co-ordinate value
_setY
-
val
Default setter for the Y attribute. The setter passes the Y value through to the XY attribute, which is the sole store for the XY state.
Parameters:
-
valNumberThe Y page co-ordinate value
_sourceSuccess
-
data -
request
Shared success callback for non-DataSource sources.
Parameters:
-
dataAnyResponse data.
-
requestObjectRequest object.
_strSetter
-
strings
The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings
Parameters:
-
stringsObject
Returns:
_syncAttrUI
-
attrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
Parameters:
-
attrsArray
_syncBrowserAutocomplete
()
protected
Synchronizes the UI state of the allowBrowserAutocomplete attribute.
_syncPosition
()
protected
Synchronizes the result list's position and alignment.
_syncResults
-
[results]
Synchronizes the results displayed in the list with those in the results
argument, or with the results attribute if an argument is not provided.
Parameters:
-
[results]Array optionalResults.
_syncShim
()
protected
Synchronizes the size of the iframe shim used for IE6 and lower. In other browsers, this method is a noop.
_syncUI
()
protected
Updates the widget UI to reflect the attribute state.
_syncUIACBase
()
protected
Synchronizes the UI state of the inputNode.
_syncUIChild
()
protected
Synchronizes the UI to match the WidgetChild state.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIPosAlign
()
protected
Synchronizes the current align Attribute value to the DOM.
This method is invoked after syncUI has been invoked for the Widget
class using the AOP infrastructure.
_syncUIPosition
()
protected
Synchronizes the UI to match the Widgets xy page position state.
This method in invoked after syncUI is invoked for the Widget class using YUI's aop infrastructure.
_syncVisibility
-
[visible]
Synchronizes the visibility of the tray with the visible argument, or with
the visible attribute if an argument is not provided.
Parameters:
-
[visible]Boolean optionalVisibility.
_uiSetAlign
-
[node] -
points
Updates the UI to reflect the align value passed in.
Note: See the align Attribute documentation, for the Object structure
expected.
_uiSetChildSelected
-
selected
Updates the UI to reflect the selected attribute value.
Parameters:
-
selectedNumberThe selected value to be reflected in the UI.
_uiSetDim
-
dim -
val
_uiSetFocused
-
val -
src
Sets the focused state for the UI
_uiSetHeight
-
val
Sets the height on the widget's bounding box element
_uiSetTabIndex
-
Number
Set the tabIndex on the widget's rendered UI
Parameters:
-
NumberObject
_uiSetVisiblePosAlign
-
visible
Attaches or detaches alignment-syncing event handlers based on the widget's
visible Attribute state.
Parameters:
-
visibleBooleanThe current value of the widget's
visibleAttribute.
_uiSetWidth
-
val
Sets the width on the widget's bounding box element
_uiSetXY
-
val
Updates the UI to reflect the XY page co-ordinates passed in.
Parameters:
-
valStringThe XY page co-ordinates value to be reflected in the UI
_unbindDOM
()
protected
_unbindKeys
()
protected
Unbinds keyboard events.
_unbindUI
()
protected
_updateValue
-
newVal
Updates the query portion of the value attribute.
If a query delimiter is defined, the last delimited portion of the input value will be replaced with the specified value.
Parameters:
-
newValStringNew value.
_validateXY
-
val
Default validator for the XY attribute
Parameters:
-
valArrayThe XY page co-ordinate value which is being set.
Returns:
addAttr
-
name -
config -
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
- value <Any>
- The initial value to set on the attribute
- valueFn <Function | String>
-
A function, which will return the initial value to set on the attribute. This is useful for cases where the attribute configuration is defined statically, but needs to reference the host instance ("this") to obtain an initial value. If both the value and valueFn properties are defined, the value returned by the valueFn has precedence over the value property, unless it returns undefined, in which case the value property is used.
valueFn can also be set to a string, representing the name of the instance method to be used to retrieve the value.
- readOnly <boolean>
- Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.
- writeOnce <boolean> or <string>
-
Whether or not the attribute is "write once". Attributes having writeOnce set to true,
can only have their values set once, be it through the default configuration,
constructor configuration arguments, or by invoking set.
The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction)
- setter <Function | String>
-
The setter function used to massage or normalize the value passed to the set method for the attribute. The value returned by the setter will be the final stored value. Returning Attribute.INVALID_VALUE, from the setter will prevent the value from being stored.
setter can also be set to a string, representing the name of the instance method to be used as the setter function.
- getter <Function | String>
-
The getter function used to massage or normalize the value returned by the get method for the attribute. The value returned by the getter function is the value which will be returned to the user when they invoke get.
getter can also be set to a string, representing the name of the instance method to be used as the getter function.
- validator <Function | String>
-
The validator function invoked prior to setting the stored value. Returning false from the validator function will prevent the value from being stored.
validator can also be set to a string, representing the name of the instance method to be used as the validator function.
- lazyAdd <boolean>
- Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the addAttrs method.
The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object.
Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.
Parameters:
-
nameStringThe name of the attribute.
-
configObjectAn object with attribute configuration property/value pairs, specifying the configuration for the attribute.
NOTE: The configuration object is modified when adding an attribute, so if you need to protect the original values, you will need to merge the object.
-
lazyBoolean(optional) Whether or not to add this attribute lazily (on the first call to get/set).
Returns:
addAttrs
-
cfgs -
values -
lazy
Configures a group of attributes, and sets initial values.
NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.
Parameters:
-
cfgsObjectAn object with attribute name/configuration pairs.
-
valuesObjectAn object with attribute name/value pairs, defining the initial values to apply. Values defined in the cfgs argument will be over-written by values in this argument unless defined as read only.
-
lazyBooleanWhether or not to delay the intialization of these attributes until the first call to get/set. Individual attributes can over-ride this behavior by defining a lazyAdd configuration property in their configuration. See addAttr.
Returns:
addTarget
-
o
Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified.
Events can only bubble if emitFacade is true.
Included in the event-custom-complex submodule.
Parameters:
-
oEventTargetthe target to add
after
-
type -
fn -
[context] -
[arg*]
Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.
Parameters:
Returns:
align
-
[node] -
[points]
Aligns this widget to the provided Node (or viewport) using the provided
points. This method can be invoked with no arguments which will cause the
widget's current align Attribute value to be synced to the DOM.
Parameters:
-
[node]Node | String | Null optionalA reference (or selector String) for the
Nodewhich with the widget is to be aligned. If null is passed in, the widget will be aligned with the viewport. -
[points]Array2 optionalA two item array specifying the points on the widget and
Node/viewport which will to be aligned. The first entry is the point on the widget, and the second entry is the point on theNode/viewport. Valid point references are defined as static constants on theWidgetPositionAlignextension.
Example:
Aligning to the top-left corner of the <body>:
myWidget.align('body',
[Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);
ancestor
-
depth
Returns the Widget instance at the specified depth.
Parameters:
-
depthNumberNumber representing the depth of the ancestor.
Returns:
attrAdded
-
name
Checks if the given attribute has been added to the host
Parameters:
-
nameStringThe name of the attribute to check.
Returns:
before
()
Executes the callback before a DOM event, custom event or method. If the first argument is a function, it is assumed the target is a method. For DOM and custom events, this is an alias for Y.on.
For DOM and custom events: type, callback, context, 0-n arguments
For methods: callback, object (method host), methodName, context, 0-n arguments
Returns:
bindUI
()
protected
Configures/Sets up listeners to bind Widget State to UI/DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
blur
()
chainable
Causes the Widget to lose focus by setting the "focused" attribute to "false"
bubble
-
evt
Propagate an event. Requires the event-custom-complex module.
Parameters:
-
evtCustomEventthe custom event to propagate
Returns:
centered
-
[node]
Centers the widget in the viewport, or if a Node is passed in, it will
be centered to that Node.
clearCache
()
chainable
Clears the result cache.
destroy
-
destroyAllNodes
Destroy lifecycle method. Fires the destroy event, prior to invoking destructors for the class hierarchy. Overrides Base's implementation, to support arguments to destroy
Subscribers to the destroy event can invoke preventDefault on the event object, to prevent destruction from proceeding.
Parameters:
-
destroyAllNodesBooleanIf true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
Returns:
destructor
()
protected
Destructor lifecycle implementation for the Widget class. Purges events attached to the bounding box and content box, removes them from the DOM and removes the Widget from the list of registered widgets.
detach
-
type -
fn -
context
Detach one or more listeners the from the specified event
Parameters:
-
typeString | ObjectEither the handle to the subscriber or the type of event. If the type is not specified, it will attempt to remove the listener from all hosted events.
-
fnFunctionThe subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
-
contextObjectThe custom object passed to subscribe. This is optional, but if supplied will be used to disambiguate multiple listeners that are the same (e.g., you subscribe many object using a function that lives on the prototype)
Returns:
detachAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
disable
()
chainable
Set the Widget's "disabled" attribute to "true".
enable
()
chainable
Set the Widget's "disabled" attribute to "false".
fire
-
type -
arguments
Fire a custom event by name. The callback functions will be executed from the context specified when the event was created, and with the following parameters.
If the custom event object hasn't been created, then the event hasn't been published and it has no subscribers. For performance sake, we immediate exit in this case. This means the event won't bubble, so if the intention is that a bubble target be notified, the event must be published on this object first.
The first argument is the event type, and any additional arguments are passed to the listeners as parameters. If the first of these is an object literal, and the event is configured to emit an event facade, that object is mixed into the event facade and the facade is provided in place of the original object.
Parameters:
-
typeString | ObjectThe type of the event, or an object that contains a 'type' property.
-
argumentsObject*an arbitrary set of parameters to pass to the handler. If the first of these is an object literal and the event is configured to emit an event facade, the event facade will replace that parameter after the properties the object literal contains are copied to the event facade.
Returns:
focus
()
chainable
Causes the Widget to receive the focus by setting the "focused" attribute to "true".
get
-
name
Returns the current value of the attribute. If the attribute has been configured with a 'getter' function, this method will delegate to the 'getter' to obtain the value of the attribute.
Parameters:
-
nameStringThe name of the attribute. If the value of the attribute is an Object, dot notation can be used to obtain the value of a property of the object (e.g.
get("x.y.z"))
Returns:
getAttrs
-
attrs
Gets multiple attribute values.
Parameters:
-
attrsArray | booleanOptional. An array of attribute names. If omitted, all attribute values are returned. If set to true, all attributes modified from their initial values are returned.
Returns:
getClassName
-
args
Generate a standard prefixed classname for the Widget, prefixed by the default prefix defined
by the Y.config.classNamePrefix attribute used by ClassNameManager and
Widget.NAME.toLowerCase() (e.g. "yui-widget-xxxxx-yyyyy", based on default values for
the prefix and widget class name).
The instance based version of this method can be used to generate standard prefixed classnames, based on the instances NAME, as opposed to Widget.NAME. This method should be used when you need to use a constant class name across different types instances.
Parameters:
-
argsString* multiple0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getDefaultLocale
()
String
Returns the default locale for the widget (the locale value defined by the widget class, or provided by the user during construction).
Returns:
getEvent
-
type -
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
Parameters:
Returns:
getSkinName
()
String
Returns the name of the skin that's currently applied to the widget. This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement. Searches up the Widget's ancestor axis for a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
Returns:
getString
-
key
Helper method to get a specific string value
Parameters:
-
keyString
Returns:
getStrings
-
key
Helper method to get the complete set of strings for the widget
Parameters:
-
keyString
Returns:
getTargets
()
Returns an array of bubble targets for this object.
Returns:
hide
()
chainable
Hides the list, unless the alwaysShowList attribute is true.
init
-
cfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
Parameters:
-
cfgObjectObject with configuration property name/value pairs
Returns:
initializer
-
config
Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.
Parameters:
-
configObjectConfiguration object literal for the widget
isRoot
()
Boolean
Determines if the Widget is the root Widget in the object hierarchy.
Returns:
modifyAttr
-
name -
config
Updates the configuration of an attribute which has already been added.
The properties which can be modified through this interface are limited to the following subset of attributes, which can be safely modified after a value has already been set on the attribute: readOnly, writeOnce, broadcast and getter.
move
-
x -
y -
x,
Moves the Widget to the specified page xy co-ordinate position.
next
-
circular
Returns the Widget's next sibling.
Parameters:
-
circularBooleanBoolean indicating if the parent's first child should be returned if the child has no next sibling.
Returns:
on
-
type -
fn -
[context] -
[arg*]
Subscribe a callback function to a custom event fired by this object or from an object that bubbles its events to this object.
Callback functions for events published with emitFacade = true will
receive an EventFacade as the first argument (typically named "e").
These callbacks can then call e.preventDefault() to disable the
behavior published to that event's defaultFn. See the EventFacade
API for all available properties and methods. Subscribers to
non-emitFacade events will receive the arguments passed to fire()
after the event name.
To subscribe to multiple events at once, pass an object as the first argument, where the key:value pairs correspond to the eventName:callback, or pass an array of event names as the first argument to subscribe to all listed events with the same callback.
Returning false from a callback is supported as an alternative to
calling e.preventDefault(); e.stopPropagation();. However, it is
recommended to use the event methods whenever possible.
Parameters:
Returns:
once
-
type -
fn -
[context] -
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to on except the
listener is immediatelly detached when it is executed.
Parameters:
Returns:
onceAfter
-
type -
fn -
[context] -
[arg*]
Listen to a custom event hosted by this object one time.
This is the equivalent to after except the
listener is immediatelly detached when it is executed.
Parameters:
Returns:
parseType
-
type -
[pre=this._yuievt.config.prefix]
Takes the type parameter passed to 'on' and parses out the various pieces that could be included in the type. If the event type is passed without a prefix, it will be expanded to include the prefix one is supplied or the event target is configured with a default prefix.
Returns:
previous
-
circular
Returns the Widget's previous sibling.
Parameters:
-
circularBooleanBoolean indicating if the parent's last child should be returned if the child has no previous sibling.
Returns:
publish
-
type -
opts
Creates a new custom event of the specified type. If a custom event by that name already exists, it will not be re-created. In either case the custom event is returned.
Parameters:
-
typeStringthe type, or name of the event
-
optsObjectoptional config params. Valid properties are:
- 'broadcast': whether or not the YUI instance and YUI global are notified when the event is fired (false)
- 'bubbles': whether or not this event bubbles (true) Events can only bubble if emitFacade is true.
- 'context': the default execution context for the listeners (this)
- 'defaultFn': the default function to execute when this event fires if preventDefault was not called
- 'emitFacade': whether or not this event emits a facade (false)
- 'prefix': the prefix for this targets events, e.g., 'menu' in 'menu:click'
- 'fireOnce': if an event is configured to fire once, new subscribers after the fire will be notified immediately.
- 'async': fireOnce event listeners will fire synchronously if the event has already fired unless async is true.
- 'preventable': whether or not preventDefault() has an effect (true)
- 'preventedFn': a function that is executed when preventDefault is called
- 'queuable': whether or not this event can be queued during bubbling (false)
- 'silent': if silent is true, debug messages are not provided for this event.
- 'stoppedFn': a function that is executed when stopPropagation is called
- 'monitored': specifies whether or not this event should send notifications about when the event has been attached, detached, or published.
- 'type': the event type (valid option if not provided as the first parameter to publish)
Returns:
removeAttr
-
name
Removes an attribute from the host object
Parameters:
-
nameStringThe name of the attribute to be removed.
render
-
parentNode
Establishes the initial DOM for the widget. Invoking this method will lead to the creating of all DOM elements for the widget (or the manipulation of existing DOM elements for the progressive enhancement use case).
This method should only be invoked once for an initialized widget.
It delegates to the widget specific renderer method to do the actual work.
Parameters:
-
parentNodeObject | StringOptional. The Node under which the Widget is to be rendered. This can be a Node instance or a CSS selector string.
If the selector string returns more than one Node, the first node will be used as the parentNode. NOTE: This argument is required if both the boundingBox and contentBox are not currently in the document. If it's not provided, the Widget will be rendered to the body of the current document in this case.
renderer
()
protected
Creates DOM (or manipulates DOM for progressive enhancement) This method is invoked by render() and is not chained automatically for the class hierarchy (unlike initializer, destructor) so it should be chained manually for subclasses if required.
renderUI
()
protected
Adds nodes to the DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
reset
-
name
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
Parameters:
-
nameStringOptional. The name of the attribute to reset. If omitted, all attributes are reset.
Returns:
selectItem
-
[itemNode] -
[originEvent]
Selects the specified itemNode, or the current activeItem if itemNode
is not specified.
Parameters:
-
[itemNode]Node optionalItem node to select.
-
[originEvent]EventFacade optionalEvent that triggered the selection, if any.
sendRequest
-
[query] -
[requestTemplate]
Sends a request to the configured source. If no source is configured, this method won't do anything.
Usually there's no reason to call this method manually; it will be called
automatically when user input causes a query event to be fired. The only
time you'll need to call this method manually is if you want to force a
request to be sent when no user input has occurred.
Parameters:
-
[query]String optionalQuery to send. If specified, the
queryattribute will be set to this query. If not specified, the current value of thequeryattribute will be used. -
[requestTemplate]Function optionalRequest template function. If not specified, the current value of the
requestTemplateattribute will be used.
set
-
name -
value
Sets the value of an attribute.
Parameters:
-
nameStringThe name of the attribute. If the current value of the attribute is an Object, dot notation can be used to set the value of a property within the object (e.g.
set("x.y.z", 5)). -
valueAnyThe value to set the attribute to.
Returns:
setAttrs
-
attrs
Sets multiple attribute values.
Parameters:
-
attrsObjectAn object with attributes name/value pairs.
Returns:
show
()
chainable
Shows the Widget by setting the "visible" attribute to "true".
subscribe
()
deprecated
subscribe to an event
syncUI
()
protected
Refreshes the rendered UI, based on Widget State
This method is not called by framework and is not chained automatically for the class hierarchy.
syncXY
()
Synchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.
toString
()
String
Generic toString implementation for all widgets.
Returns:
unsubscribe
()
deprecated
detach a listener
unsubscribeAll
-
type
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
Parameters:
-
typeStringThe type, or name of the event
Properties
_allowAdHocAttrs
Boolean
protected
This property controls whether or not instances of this class should allow users to add ad-hoc attributes through the constructor configuration hash.
AdHoc attributes are attributes which are not defined by the class, and are not handled by the MyClass.NONATTRS_CFG
Default: undefined (false)
_UI_ATTRS
Object
private
The lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
_YQL_SOURCE_REGEX
RegExp
protected
Regular expression used to determine whether a String source is a YQL query.
CONTENT_TEMPLATE
String
Property defining the markup template for content box. If your Widget doesn't need the dual boundingBox/contentBox structure, set CONTENT_TEMPLATE to null, and contentBox and boundingBox will both point to the same Node.
Attributes
activateFirstItem
Boolean
If true, the first item in the list will be activated by default when
the list is initially displayed and when results change.
Default: false
Fires event activateFirstItemChange
Fires when the value for the configuration attribute activateFirstItem 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
activeItem
Node
Item that's currently active, if any. When the user presses enter, this is the item that will be selected.
Fires event activeItemChange
Fires when the value for the configuration attribute activeItem 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
align
Object
The alignment configuration for this widget.
The align attribute is used to align a reference point on the widget, with
the reference point on another Node, or the viewport. The object which
align expects has the following properties:
node: TheNodeto which the widget is to be aligned. If set tonull, or not provided, the widget is aligned to the viewport.points: A two element Array, defining the two points on the widget andNode/viewport which are to be aligned. The first element is the point on the widget, and the second element is the point on theNode/viewport. Supported alignment points are defined as static properties onWidgetPositionAlign.
Default: null
Fires event alignChange
Fires when the value for the configuration attribute align 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Example:
Aligns the top-right corner of the widget with the top-left corner of the viewport:
myWidget.set('align', {
points: [Y.WidgetPositionAlign.TR, Y.WidgetPositionAlign.TL]
});
alignOn
Array
An Array of Objects corresponding to the Nodes and events that will cause
the alignment of this widget to be synced to the DOM.
The alignOn Attribute is expected to be an Array of Objects with the
following properties:
eventName: The String event name to listen for.node: The optionalNodethat will fire the event, it can be aNodereference or a selector String. This will default to the widget'sboundingBox.
Default: []
Fires event alignOnChange
Fires when the value for the configuration attribute alignOn 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Example:
Sync this widget's alignment on window resize:
myWidget.set('alignOn', [
{
node : Y.one('win'),
eventName: 'resize'
}
]);
allowBrowserAutocomplete
Boolean
Whether or not to enable the browser's built-in autocomplete functionality for input fields.
Default: false
Fires event allowBrowserAutocompleteChange
Fires when the value for the configuration attribute allowBrowserAutocomplete 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
allowTrailingDelimiter
Boolean
When a queryDelimiter is set, trailing delimiters will automatically be
stripped from the input value by default when the input node loses focus.
Set this to true to allow trailing delimiters.
Default: false
Fires event allowTrailingDelimiterChange
Fires when the value for the configuration attribute allowTrailingDelimiter 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
alwaysShowList
Boolean
If true, the list will remain visible even when there are no results
to display.
Default: false
Fires event alwaysShowListChange
Fires when the value for the configuration attribute alwaysShowList 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
boundingBox
String | Node
The outermost DOM node for the Widget, used for sizing and positioning of a Widget as well as a containing element for any decorator elements used for skinning.
Fires event boundingBoxChange
Fires when the value for the configuration attribute boundingBox 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
centered
Boolean | Node
A convenience Attribute, which can be used as a shortcut for the align
Attribute.
If set to true, the widget is centered in the viewport. If set to a Node
reference or valid selector String, the widget will be centered within the
Node. If set to false, no center positioning is applied.
Default: false
Fires event centeredChange
Fires when the value for the configuration attribute centered 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
circular
Boolean
If true, keyboard navigation will wrap around to the opposite end of
the list when navigating past the first or last item.
Default: true
Fires event circularChange
Fires when the value for the configuration attribute circular 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
contentBox
String | Node
A DOM node that is a direct descendant of a Widget's bounding box that houses its content.
Fires event contentBoxChange
Fires when the value for the configuration attribute contentBox 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
destroyed
Boolean
readonly
Flag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
Fires event destroyedChange
Fires when the value for the configuration attribute destroyed 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
disabled
Boolean
Boolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.
Default: false
Fires event disabledChange
Fires when the value for the configuration attribute disabled 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
enableCache
Boolean
Whether or not to enable in-memory caching in result sources that support it.
Default: true
Fires event enableCacheChange
Fires when the value for the configuration attribute enableCache 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
focused
Boolean
readonly
Boolean indicating if the Widget, or one of its descendants, has focus.
Default: false
Fires event focusedChange
Fires when the value for the configuration attribute focused 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
height
String | Number
String with units, or number, representing the height of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.
Default: EMPTY_STR
Fires event heightChange
Fires when the value for the configuration attribute height 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
hoveredItem
Node | Null
readonly
Item currently being hovered over by the mouse, if any.
Fires event hoveredItemChange
Fires when the value for the configuration attribute hoveredItem 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
id
String
Default: Generated using guid()
Fires event idChange
Fires when the value for the configuration attribute id 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
initialized
Boolean
readonly
Flag indicating whether or not this object has been through the init lifecycle phase.
Default: false
Fires event initializedChange
Fires when the value for the configuration attribute initialized 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
inputNode
Node | HTMLElement | String
Node to monitor for changes, which will generate query events when
appropriate. May be either an <input> or a <textarea>.
Fires event inputNodeChange
Fires when the value for the configuration attribute inputNode 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
listNode
Node | Null
Node that will contain result items.
Fires event listNodeChange
Fires when the value for the configuration attribute listNode 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
locale
String
deprecated
The default locale for the widget. NOTE: Using get/set on the "strings" attribute will return/set strings for this locale.
Default: "en"
Fires event localeChange
Fires when the value for the configuration attribute locale 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
maxResults
Number
Maximum number of results to return. A value of 0 or less will allow an
unlimited number of results.
Default: 0
Fires event maxResultsChange
Fires when the value for the configuration attribute maxResults 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
minQueryLength
Number
Minimum number of characters that must be entered before a query event
will be fired. A value of 0 allows empty queries; a negative value will
effectively disable all query events.
Default: 1
Fires event minQueryLengthChange
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
query
String | Null
readonly
Current query, or null if there is no current query.
The query might not be the same as the current value of the input node, both
for timing reasons (due to queryDelay) and because when one or more
queryDelimiter separators are in use, only the last portion of the
delimited input string will be used as the query value.
Default: null
Fires event queryChange
Fires when the value for the configuration attribute query 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
queryDelay
Number
Number of milliseconds to delay after input before triggering a query
event. If new input occurs before this delay is over, the previous input
event will be ignored and a new delay will begin.
This can be useful both to throttle queries to a remote data source and to avoid distracting the user by showing them less relevant results before they've paused their typing.
Default: 100
Fires event queryDelayChange
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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
queryDelimiter
String | Null
Query delimiter string. When a delimiter is configured, the input value
will be split on the delimiter, and only the last portion will be used in
autocomplete queries and updated when the query attribute is
modified.
Default: null
Fires event queryDelimiterChange
Fires when the value for the configuration attribute queryDelimiter 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
render
Boolean | Node
Whether or not to render the widget automatically after init, and optionally, to which parent node.
Fires event renderChange
Fires when the value for the configuration attribute render 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
rendered
Boolean
readonly
Flag indicating whether or not this Widget has been through the render lifecycle phase.
Default: false
Fires event renderedChange
Fires when the value for the configuration attribute rendered 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
requestTemplate
Function | String | Null
Source request template. This can be a function that accepts a query as a
parameter and returns a request string, or it can be a string containing the
placeholder "{query}", which will be replaced with the actual URI-encoded
query. In either case, the resulting string will be appended to the request
URL when the source attribute is set to a remote DataSource, JSONP URL, or
XHR URL (it will not be appended to YQL URLs).
While requestTemplate may be set to either a function or a string, it will
always be returned as a function that accepts a query argument and returns a
string.
Default: null
Fires event requestTemplateChange
Fires when the value for the configuration attribute requestTemplate 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
resultFilters
Array
Array of local result filter functions. If provided, each filter will be
called with two arguments when results are received: the query and an array
of result objects. See the documentation for the results event for a list
of the properties available on each result object.
Each filter is expected to return a filtered or modified version of the
results array, which will then be passed on to subsequent filters, then the
resultHighlighter function (if set), then the resultFormatter function
(if set), and finally to subscribers to the results event.
If no source is set, result filters will not be called.
Prepackaged result filters provided by the autocomplete-filters and
autocomplete-filters-accentfold modules can be used by specifying the filter
name as a string, such as 'phraseMatch' (assuming the necessary filters
module is loaded).
Default: []
Fires event resultFiltersChange
Fires when the value for the configuration attribute resultFilters 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
resultFormatter
Function | Null
Function which will be used to format results. If provided, this function will be called with two arguments after results have been received and filtered: the query and an array of result objects. The formatter is expected to return an array of HTML strings or Node instances containing the desired HTML for each result.
See the documentation for the results event for a list of the properties
available on each result object.
If no source is set, the formatter will not be called.
Fires event resultFormatterChange
Fires when the value for the configuration attribute resultFormatter 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
resultHighlighter
Function | Null
Function which will be used to highlight results. If provided, this function will be called with two arguments after results have been received and filtered: the query and an array of filtered result objects. The highlighter is expected to return an array of highlighted result text in the form of HTML strings.
See the documentation for the results event for a list of the properties
available on each result object.
If no source is set, the highlighter will not be called.
Fires event resultHighlighterChange
Fires when the value for the configuration attribute resultHighlighter 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
resultListLocator
Function | String | Null
Locator that should be used to extract an array of results from a non-array response.
By default, no locator is applied, and all responses are assumed to be arrays by default. If all responses are already arrays, you don't need to define a locator.
The locator may be either a function (which will receive the raw response as
an argument and must return an array) or a string representing an object
path, such as "foo.bar.baz" (which would return the value of
result.foo.bar.baz if the response is an object).
While resultListLocator may be set to either a function or a string, it
will always be returned as a function that accepts a response argument and
returns an array.
Fires event resultListLocatorChange
Fires when the value for the configuration attribute resultListLocator 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
results
Array
readonly
Current results, or an empty array if there are no results.
Default: []
Fires event resultsChange
Fires when the value for the configuration attribute results 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
resultTextLocator
Function | String | Null
Locator that should be used to extract a plain text string from a non-string result item. The resulting text value will typically be the value that ends up being inserted into an input field or textarea when the user of an autocomplete implementation selects a result.
By default, no locator is applied, and all results are assumed to be plain text strings. If all results are already plain text strings, you don't need to define a locator.
The locator may be either a function (which will receive the raw result as
an argument and must return a string) or a string representing an object
path, such as "foo.bar.baz" (which would return the value of
result.foo.bar.baz if the result is an object).
While resultTextLocator may be set to either a function or a string, it
will always be returned as a function that accepts a result argument and
returns a string.
Fires event resultTextLocatorChange
Fires when the value for the configuration attribute resultTextLocator 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
scrollIntoView
Boolean
If true, the viewport will be scrolled to ensure that the active list
item is visible when necessary.
Default: false
Fires event scrollIntoViewChange
Fires when the value for the configuration attribute scrollIntoView 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
source
Array | DataSource | Function | Node | Object | String | Null
Source for autocomplete results. The following source types are supported:
- Array
-
The full array will be provided to any configured filters for each query. This is an easy way to create a fully client-side autocomplete implementation.
Example:
['first result', 'second result', 'etc'] - DataSource
-
A
DataSourceinstance or other object that provides a DataSource-likesendRequestmethod. See theDataSourcedocumentation for details. - Function
-
A function source will be called with the current query and a callback function as parameters, and should either return an array of results (for synchronous operation) or return nothing and pass an array of results to the provided callback (for asynchronous operation).
Example (synchronous):
function (query) { return ['foo', 'bar']; }Example (async):
function (query, callback) { callback(['foo', 'bar']); } - Object
-
An object will be treated as a query hashmap. If a property on the object matches the current query, the value of that property will be used as the response.
The response is assumed to be an array of results by default. If the response is not an array, provide a
resultListLocatorto process the response and return an array.Example:
{foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}
If the optional autocomplete-sources module is loaded, then
the following additional source types will be supported as well:
- <select> Node
-
You may provide a YUI Node instance wrapping a <select>
element, and the options in the list will be used as results. You
will also need to specify a
resultTextLocatorof 'text' or 'value', depending on what you want to use as the text of the result. Each result will be an object with the following properties:- html (String)
-
HTML content of the <option> element.
- index (Number)
-
Index of the <option> element in the list.
- node (Y.Node)
-
Node instance referring to the original <option> element.
- selected (Boolean)
-
Whether or not this item is currently selected in the <select> list.
- text (String)
-
Text content of the <option> element.
- value (String)
-
Value of the <option> element.
- String (JSONP URL)
-
If a URL with a
{callback}placeholder is provided, it will be used to make a JSONP request. The{query}placeholder will be replaced with the current query, and the{callback}placeholder will be replaced with an internally-generated JSONP callback name. Both placeholders must appear in the URL, or the request will fail. An optional{maxResults}placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).The response is assumed to be an array of results by default. If the response is not an array, provide a
resultListLocatorto process the response and return an array.The
jsonpmodule must be loaded in order for JSONP URL sources to work. If thejsonpmodule is not already loaded, it will be loaded on demand if possible.Example:
'http://example.com/search?q={query}&callback={callback}' - String (XHR URL)
-
If a URL without a
{callback}placeholder is provided, it will be used to make a same-origin XHR request. The{query}placeholder will be replaced with the current query. An optional{maxResults}placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).The response is assumed to be a JSON array of results by default. If the response is a JSON object and not an array, provide a
resultListLocatorto process the response and return an array. If the response is in some form other than JSON, you will need to use a custom DataSource instance as the source.The
io-baseandjson-parsemodules must be loaded in order for XHR URL sources to work. If these modules are not already loaded, they will be loaded on demand if possible.Example:
'http://example.com/search?q={query}' - String (YQL query)
-
If a YQL query is provided, it will be used to make a YQL request. The
{query}placeholder will be replaced with the current autocomplete query. This placeholder must appear in the YQL query, or the request will fail. An optional{maxResults}placeholder may also be provided, and will be replaced with the value of the maxResults attribute (or 1000 if the maxResults attribute is 0 or less).The
yqlmodule must be loaded in order for YQL sources to work. If theyqlmodule is not already loaded, it will be loaded on demand if possible.Example:
'select * from search.suggest where query="{query}"'
As an alternative to providing a source, you could simply listen for query
events and handle them any way you see fit. Providing a source is optional,
but will usually be simpler.
Fires event sourceChange
Fires when the value for the configuration attribute source 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
sourceType
String
May be used to force a specific source type, overriding the automatic source type detection. It should almost never be necessary to do this, but as they taught us in the Boy Scouts, one should always be prepared, so it's here if you need it. Be warned that if you set this attribute and something breaks, it's your own fault.
Supported sourceType values are: 'array', 'datasource', 'function', and
'object'.
If the autocomplete-sources module is loaded, the following additional
source types are supported: 'io', 'jsonp', 'select', 'string', 'yql'
Fires event sourceTypeChange
Fires when the value for the configuration attribute sourceType 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
srcNode
String | Node
The DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition
Fires event srcNodeChange
Fires when the value for the configuration attribute srcNode 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
strings
Object
Translatable strings used by the AutoCompleteList widget.
Fires event stringsChange
Fires when the value for the configuration attribute strings 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
tabIndex
Number
Number (between -32767 to 32767) indicating the widget's position in the default tab flow. The value is used to set the "tabIndex" attribute on the widget's bounding box. Negative values allow the widget to receive DOM focus programmatically (by calling the focus method), while being removed from the default tab flow. A value of null removes the "tabIndex" attribute from the widget's bounding box.
Default: null
Fires event tabIndexChange
Fires when the value for the configuration attribute tabIndex 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
tabSelect
Boolean
If true, pressing the tab key while the list is visible will select
the active item, if any.
Default: true
Fires event tabSelectChange
Fires when the value for the configuration attribute tabSelect 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
tokenInput
Plugin.TokenInput
readonly
If the inputNode specified at instantiation time has a node-tokeninput
plugin attached to it, this attribute will be a reference to the
Y.Plugin.TokenInput instance.
Fires event tokenInputChange
Fires when the value for the configuration attribute tokenInput 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
value
String
Current value of the input node.
Default: ''
Fires event valueChange
Fires when the value for the configuration attribute value 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
visible
Boolean
Boolean indicating whether or not the Widget is visible.
Default: TRUE
Fires event visibleChange
Fires when the value for the configuration attribute visible 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
width
String | Number
String with units, or number, representing the width of the Widget. If a number is provided, the default unit, defined by the Widgets DEF_UNIT, property is used.
Default: EMPTY_STR
Fires event widthChange
Fires when the value for the configuration attribute width 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
x
Number
Page X co-ordinate for the widget. This attribute acts as a facade for the xy attribute. Changes in position can be monitored by listening for xyChange events.
Default: 0
Fires event xChange
Fires when the value for the configuration attribute x 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
xy
Array
Page XY co-ordinate pair for the widget.
Default: [0,0]
Fires event xyChange
Fires when the value for the configuration attribute xy 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
y
Number
Page Y co-ordinate for the widget. This attribute acts as a facade for the xy attribute. Changes in position can be monitored by listening for xyChange events.
Default: 0
Fires event yChange
Fires when the value for the configuration attribute y 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yqlEnv
String
YQL environment file URL to load when the source is set to a YQL query.
Set this to null to use the default Open Data Tables environment file
(http://datatables.org/alltables.env).
Default: null
Fires event yqlEnvChange
Fires when the value for the configuration attribute yqlEnv 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
yqlProtocol
String
URL protocol to use when the source is set to a YQL query.
Default: 'http'
Fires event yqlProtocolChange
Fires when the value for the configuration attribute yqlProtocol 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:
-
eEventFacadeAn Event Facade object with the following attribute-specific properties added:
Events
clear
Fires after the query has been completely cleared or no longer meets the minimum query length requirement.
destroy
Lifecycle event for the destroy phase, fired prior to destruction. Invoking the preventDefault method on the event object provided to subscribers will prevent destruction from proceeding.
Subscribers to the "after" moment of this event, will be notified after destruction is complete (and as a result cannot prevent destruction).
Event Payload:
-
eEventFacadeEvent object
init
Lifecycle event for the init phase, fired prior to initialization. Invoking the preventDefault() method on the event object provided to subscribers will prevent initialization from occuring.
Subscribers to the "after" momemt of this event, will be notified after initialization of the object is complete (and therefore cannot prevent initialization).
Event Payload:
-
eEventFacadeEvent object, with a cfg property which refers to the configuration object passed to the constructor.
query
Fires when the contents of the input field have changed and the input value meets the criteria necessary to generate an autocomplete query.
results
Fires after query results are received from the source. If no source has been set, this event will not fire.
Event Payload:
-
dataArray | ObjectRaw, unfiltered result data (if available).
-
queryStringQuery that generated these results.
-
resultsObject[]Array of filtered, formatted, and highlighted results. Each item in the array is an object with the following properties:
-
displayNode | HTMLElement | StringFormatted result HTML suitable for display to the user. If no custom formatter is set, this will be an HTML-escaped version of the string in the
textproperty. -
[highlighted]String optionalHighlighted (but not formatted) result text. This property will only be set if a highlighter is in use.
-
rawAnyRaw, unformatted result in whatever form it was provided by the source.
-
textStringPlain text version of the result, suitable for being inserted into the value of a text input field or textarea when the result is selected by a user. This value is not HTML-escaped and should not be inserted into the page using
innerHTMLorNode#setContent().
-
select
Fires when an autocomplete suggestion is selected from the list, typically via a keyboard action or mouse click.
widget:contentUpdate
Notification event, which widget implementations can fire, when they change the content of the widget. This event has no default behavior and cannot be prevented, so the "on" or "after" moments are effectively equivalent (with on listeners being invoked before after listeners).
Event Payload:
-
eEventFacadeThe Event Facade
widget:render
Lifecycle event for the render phase, fired prior to rendering the UI for the widget (prior to invoking the widget's renderer method).
Subscribers to the "on" moment of this event, will be notified before the widget is rendered.
Subscribers to the "after" moment of this event, will be notified after rendering is complete.
Event Payload:
-
eEventFacadeThe Event Facade