Binds an AutoCompleteList instance to a Node instance.
_activateNextItemActivates 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.
_activatePrevItemActivates 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.
_additems
Appends the specified result items to the list inside a new item node.
items
Array | Node | HTMLElement | String
Result item or array of result items.
Added nodes.
_addAttrscfgs
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).
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An 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.
lazy
Boolean
Whether 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.
_addLazyAttrname
[lazyCfg]
Finishes initializing an attribute which has been lazily added.
_addOutOfOrdername
cfg
Utility method used by get/set to add attributes encountered out of order when calling addAttrs().
For example, if:
this.addAttrs({
foo: {
setter: function() {
// make sure this bar is available when foo is added
this.get("bar");
}
},
bar: {
value: ...
}
});_afterAlignChangee
Handles alignChange events by updating the UI in response to align
Attribute changes.
_afterAlignOnChangee
Handles alignOnChange events by updating the alignment-syncing event
handlers.
_afterAlwaysShowListChangee
Handles alwaysShowListChange events.
_afterChildSelectedChangeevent
Default attribute change listener for the selected
attribute, responsible for updating the UI, in response to
attribute changes.
event
EventFacade
The event facade for the attribute change.
_afterDocClicke
Handles click events on the document. If the click is outside both the input node and the bounding box, the list will be hidden.
_afterListInputBlurHandles inputNode blur events.
_afterListInputFocusHandles inputNode focus events.
_afterSourceTypeChangee
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.
_afterValueChangee
Handles change events for the value attribute.
_afterXYChangee
Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.
e
EventFacade
The event facade for the attribute change
_aggregateAttrsallAttrs
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).
allAttrs
Array
An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)
The aggregate set of ATTRS definitions for the instance
_applyParserconfig
Utility method used to apply the HTML_PARSER configuration for the
instance, to retrieve config data values.
config
Object
User configuration object (will be populated with values from Node)
_ariaSaystringId
[subs]
Updates the ARIA live region with the specified message.
_attachPosAlignUIHandlesAttaches the alignment-syncing event handlers.
_attrCfgHashUtility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.
_baseDestroyInternal destroy implementation for BaseCore
_baseInitInternal initialization implementation for BaseCore
_beforeCreateObjectSourcesource
Runs before AutoCompleteBase's _createObjectSource() method and augments
it to support additional object-based source types.
source
String
_bindAttrUIattrs
Binds after listeners for the list of attributes provided
attrs
Array
_bindDOMSets up DOM listeners, on elements rendered by the widget.
_bindInputBinds inputNode events and behavior.
_bindKeysBinds keyboard events.
_bindListBinds list events.
_bindUISets up DOM and CustomEvent listeners for the widget.
_bindUIACBaseAttaches event listeners and behaviors.
_bindUIChildBinds 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.
_bindUIPosAlignBind 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.
_bindUIPositionBinds 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.
_clearClears the contents of the tray.
_cloneDefaultValuecfg
This method assumes that the value has already been checked to be an object. Since it's on a critical path, we don't want to re-do the check.
cfg
Object
_createAriaNodeCreates and returns an ARIA live region node.
ARIA node.
_createArraySourcesource
Creates a DataSource-like object that simply returns the specified array as
a response. See the source attribute for more details.
source
Array
DataSource-like object.
_createFunctionSourcesource
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.
source
Function
Function that accepts a query and a callback as parameters, and calls the callback with an array of results.
DataSource-like object.
_createIOSourcesource
Creates a DataSource-like object that uses Y.io as a source. See the
source attribute for more details.
source
String
URL.
DataSource-like object.
_createItemNoderesult
Creates and returns an item node with the specified content.
result
Object
Result object.
Item node.
_createJSONPSourcesource
Creates a DataSource-like object that uses the specified JSONPRequest
instance as a source. See the source attribute for more details.
source
JSONPRequest | String
URL string or JSONPRequest instance.
DataSource-like object.
_createListNodeCreates and returns a list node. If the listNode attribute is already set
to an existing node, that node will be used.
List node.
_createObjectSourcesource
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.
source
Object
DataSource-like object.
_createSelectSourcesource
Creates a DataSource-like object that uses the specified <select> node as
a source.
source
Node
YUI Node instance wrapping a <select> node.
DataSource-like object.
_createStringSourcesource
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.
source
String
URL or YQL query.
DataSource-like object.
_createUIEventtype
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.
type
String
String representing the name of the event
_createYQLSourcesource
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.
source
String
YQL query.
DataSource-like object.
_defAttrChangeFne
eventFastPath
Default function for attribute change events.
e
EventFacade
The event object for attribute change events.
eventFastPath
Boolean
Whether or not we're using this as a fast path in the case of no listeners or not
_defaultBBReturns the default value for the boundingBox attribute.
For the Widget class, this will most commonly be null (resulting in a new boundingBox node instance being created), unless a srcNode was provided and CONTENT_TEMPLATE is null, in which case it will be srcNode. This behavior was introduced in @VERSION@ to accomodate single-box widgets whose BB & CB both point to srcNode (e.g. Y.Button).
_defaultCBReturns 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)
_defaultYQLLocatorresponse
Default resultListLocator used when a string-based YQL source is set and the implementer hasn't already specified one.
response
Object
YQL response object.
_defClearFnDefault clear event handler. Sets the results attribute to an empty
array and query to null.
_defInitFne
Default init event handler
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
_defQueryFne
Default query event handler. Sets the query attribute and sends a
request to the source if one is configured.
_defRenderFne
parentNode
Default render handler
e
EventFacade
The Event object
parentNode
Node
The parent node to render to, if passed in to the render method
_defResultsFne
Default results event handler. Sets the results attribute to the latest
results.
_destroyBoxRemoves and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.
_destroyHierarchyDestroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.
_destroyUIEventsDestructor logic for UI event infrastructure, invoked during Widget destruction.
_detachPosAlignUIHandlesDetaches the alignment-syncing event handlers.
_doAlignwidgetPoint
x
y
Helper method, used to align the given point on the widget, with the XY page coordinates provided.
_filterAdHocAttrsallAttrs
userVals
allAttrs
Object
The 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.
userVals
Object
The config object passed in by the user, from which adhoc attrs are to be filtered.
The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.
_filterUIEventevt
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.
evt
DOMEventFacade
true if it's OK to fire the custom UI event, false if not.
_fireAttrChangeattrName
subAttrName
currVal
newVal
opts
[cfg]
Utility method to help setup the event payload and fire the attribute change event.
attrName
String
The name of the attribute
subAttrName
String
The full path of the property being changed, if this is a sub-attribute value being change. Otherwise null.
currVal
Any
The current value of the attribute
newVal
Any
The new value of the attribute
opts
Object
Any additional event data to mix into the attribute change event's event facade.
[cfg]
Object
optional
The attribute config stored in State, if already available.
_functionValidatorvalue
Returns true if value is either a function or null.
value
Function | Null
Value to validate.
_getAttrname
Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method.
See get for argument details.
name
String
The name of the attribute.
The value of the attribute.
_getAttrCfgname
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.
name
String
Optional. The attribute name. If not provided, the method will return the configuration for all attributes.
The configuration properties for the given attribute, or all attributes.
_getAttrCfgsReturns an aggregated set of attribute configurations, by traversing the class hierarchy.
The hash of attribute configurations, aggregated across classes in the hierarchy This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return the cached value.
_getAttrInitValattr
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.
The initial value of the attribute.
_getAttrsattrs
Implementation behind the public getAttrs method, to get multiple attribute values.
An object with attribute name/value pairs.
_getClassesReturns the class hierarchy for this object, with BaseCore being the last class in the array.
An array of classes (constructor functions), making up the class hierarchy for this object. This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the cached value.
_getFirstItemNodeGets the first item node in the list, or null if the list is empty.
_getFullTypetype
Returns the fully qualified type, given a short type string. That is, returns "foo:bar" when given "bar" if "foo" is the configured prefix.
NOTE: This method, unlike _getType, does no checking of the value passed in, and is designed to be used with the low level _publish() method, for critical path implementations which need to fast-track publish for performance reasons.
type
String
The short type to prefix
The prefixed type, if a prefix is set, otherwise the type passed in
_getHtmlParserGets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.
HTML_PARSER definition for this instance
_getInstanceAttrCfgsallCfgs
A helper method used to isolate the attrs config for this instance to pass to addAttrs,
from the static cached ATTRS for the class.
allCfgs
Object
The 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.
The set of attributes to be added for this instance, suitable
for passing through to addAttrs.
_getLastItemNodeGets the last item node in the list, or null if the list is empty.
_getNodeToParseDetermines 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.
The node reference to apply HTML_PARSER to.
_getObjectValueobj
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.
Located value, or 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.
[node]
Node
optional
The node to get the region of.
The node's region.
_getStateValname
[cfg]
Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits
The stored value of the attribute
_getTypeIf the instance has a prefix attribute and the event type is not prefixed, the instance prefix is applied to the supplied type.
_getUIEventNodeReturns 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.
_getXDefault getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
The X page co-ordinate value
_getXHRUrlurl
request
Returns a formatted XHR URL based on the specified base url, query, and the current requestTemplate if any.
Formatted URL.
_getYDefault getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.
The Y page co-ordinate value
_guid_hasPotentialSubscribersfullType
fullType
String
The fully prefixed type name
Whether the event has potential subscribers or not
_initAttrHostattrs
values
lazy
Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.
attrs
Object
The 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.
values
Object
The 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.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initAttributeInitializes AttributeCore
_initAttrsattrs
values
lazy
Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.
attrs
Object
The 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.
values
Object
The 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.
lazy
Boolean
Whether or not to add attributes lazily (passed through to addAttrs).
_initBaseconfig
Internal construction logic for BaseCore.
config
Object
The constructor configuration object
_initHierarchyuserVals
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.
userVals
Object
Object with configuration property name/value pairs
_initHierarchyDataA 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.
_initKeysInitializes keyboard command mappings.
_initUIEventtype
Sets up infrastructure required to fire a UI event.
type
String
String representing the name of the event
_isLazyAttrname
Checks whether or not the attribute is one which has been added lazily and still requires initialization.
name
String
The name of the attribute
true if it's a lazily added attribute, false otherwise.
_isUIEventtype
Determines if the specified event is a UI event.
type
String
String representing the name of the event
Event Returns the name of the UI Event, otherwise undefined.
_jsonpFormatterurl
proxy
query
URL formatter passed to JSONPRequest instances.
Formatted URL
_keyDownCalled when the down arrow key is pressed.
_keyEnterCalled when the enter key is pressed.
_keyEscCalled when the escape key is pressed.
_keyTabCalled when the tab key is pressed.
_keyUpCalled when the up arrow key is pressed.
_mapInstanceThe
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.
The
String
boundingBox id
_monitorwhat
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 -> click_attach, click_detach, 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.
what
String
'attach', 'detach', 'fire', or 'publish'
eventType
String | CustomEvent
The prefixed name of the event being monitored, or the CustomEvent object.
o
Object
Information about the event interaction, such as fire() args, subscription category, publish config
_normAttrValsvalueHash
Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.
valueHash
Object
An object with attribute name/value pairs
An object literal with 2 properties - "simple" and "complex", containing simple and complex attribute values respectively keyed by the top level attribute name, or null, if valueHash is falsey.
_onDocFocusevt
DOM focus event handler, used to sync the state of the Widget with the DOM
evt
EventFacade
The event facade for the DOM focus event
_onDocMouseDownevt
"mousedown" event handler for the owner document of the widget's bounding box.
evt
EventFacade
The event facade for the DOM focus event
_onInputValueChangee
Handles valueChange events on the input node and fires a query event
when the input value meets the configured criteria.
_onItemClicke
Delegated event handler for item click events.
_onResponsee
Handles source responses and fires the results event.
_parseResponsequery
response
data
Parses result responses, performs filtering and highlighting, and fires the
results event.
_parseTypeReturns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)
_parseValuevalue
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.
value
String
Input value from which to extract the query.
query
_preAddAttrsattrs
userVals
lazy
Implement the BaseCore _preAddAttrs method hook, to add
the srcNode and related attributes, so that HTML_PARSER
(which relies on this.get("srcNode")) can merge in it's
results before the rest of the attributes are added.
_preInitEventCfgconfig
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.
config
Object
The user configuration object
_protectAttrsattrs
Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.
attrs
Object
A hash of attribute to configuration object pairs.
A protected version of the attrs argument.
_publishfullType
etOpts
ceOpts
The low level event publish implementation. It expects all the massaging to have been done
outside of this method. e.g. the type to fullType conversion. It's designed to be a fast
path publish, which can be used by critical code paths to improve performance.
The published event. If called without etOpts or ceOpts, this will
be the default CustomEvent instance, and can be configured independently.
_removeLoadingClassNamesRemoves class names representative of the widget's loading state from the boundingBox.
_renderBoxparentNode
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.
parentNode
Node
The 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.
_renderBoxClassNamesApplies standard class names to the boundingBox and contentBox
_renderUIInitializes the UI state for the Widget's bounding/content boxes.
_renderUIPositionCreates/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.
_setname
val
[opts]
Allows setting of readOnly/writeOnce attributes. See set for argument details.
A reference to the host object.
_setAlignCenterval
Default setter for center Attribute changes. Sets up the appropriate
value, and passes it through the to the align attribute.
_setAttrname
value
[opts]
force
Provides the common implementation for the public set and protected _set methods.
See set for argument details.
A reference to the host object.
_setAttrsattrs
[opts]
Implementation behind the public setAttrs method, to set multiple attribute values.
A reference to the host object.
_setAttrValattrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]
Updates the stored value of the attribute in the privately held State object, if validation and setter passes.
attrName
String
The attribute name.
subAttrName
String
The sub-attribute name, if setting a sub-attribute property ("x.y.z").
prevVal
Any
The currently stored value of the attribute.
newVal
Any
The value which is going to be stored.
[opts]
Object
optional
Optional data providing the circumstances for the change.
[attrCfg]
Object
optional
Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained the config from state.
true if the new attribute value was stored, false if not.
_setBBnode
Setter for the boundingBox attribute
Node
_setBoxid
node
template
isBounding
Helper method to set the bounding/content box, or create it from the provided template if not found.
The node
_setCBnode
Setter for the contentBox attribute
Node
_setLocatorlocator
Setter for locator attributes.
_setRequestTemplatetemplate
Setter for the requestTemplate attribute.
_setResultFiltersfilters
Setter for the resultFilters attribute.
Array of filter functions (empty if filters is
null).
_setResultHighlighterhighlighter
Setter for the resultHighlighter attribute.
_setSourcesource
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.
source
Any
AutoComplete source. See the source attribute for
details.
_setStateValname
value
Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits
name
String
The name of the attribute
value
Any
The value of the attribute
_setXval
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.
val
Number
The X page co-ordinate value
_setYval
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.
val
Number
The Y page co-ordinate value
_sourceSuccessdata
request
Shared success callback for non-DataSource sources.
data
Any
Response data.
request
Object
Request object.
_strSetterstrings
The default setter for the strings attribute. Merges partial sets into the full string set, to allow users to partial sets of strings
strings
Object
The full set of strings to set
_syncAttrUIattrs
Invokes the _uiSet=ATTR NAME> method for the list of attributes provided
attrs
Array
_syncBrowserAutocompleteSynchronizes the UI state of the allowBrowserAutocomplete attribute.
_syncPositionSynchronizes 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.
[results]
Array
optional
Results.
_syncShimSynchronizes the size of the iframe shim used for IE6 and lower. In other browsers, this method is a noop.
_syncUIUpdates the widget UI to reflect the attribute state.
_syncUIACBaseSynchronizes the UI state of the inputNode.
_syncUIChildSynchronizes the UI to match the WidgetChild state.
This method is invoked after bindUI is invoked for the Widget class using YUI's aop infrastructure.
_syncUIPosAlignSynchronizes 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.
_syncUIPositionSynchronizes 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.
[visible]
Boolean
optional
Visibility.
_uiSetAlign[node]
points
Updates the UI to reflect the align value passed in.
Note: See the align Attribute documentation, for the Object structure
expected.
_uiSetChildSelectedselected
Updates the UI to reflect the selected attribute value.
selected
Number
The selected value to be reflected in the UI.
_uiSetDimdim
val
_uiSetFocusedval
src
Sets the focused state for the UI
_uiSetHeightval
Sets the height on the widget's bounding box element
_uiSetTabIndexNumber
Set the tabIndex on the widget's rendered UI
Number
Object
_uiSetVisiblePosAlignvisible
Attaches or detaches alignment-syncing event handlers based on the widget's
visible Attribute state.
visible
Boolean
The current value of the widget's visible
Attribute.
_uiSetWidthval
Sets the width on the widget's bounding box element
_uiSetXYval
Updates the UI to reflect the XY page co-ordinates passed in.
val
String
The XY page co-ordinates value to be reflected in the UI
_unbindDOM_unbindKeysUnbinds keyboard events.
_unbindUI_updateValuenewVal
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.
newVal
String
New value.
_validateXYval
Default validator for the XY attribute
val
Array
The XY page co-ordinate value which is being set.
true if valid, false if not.
addAttrname
config
lazy
Adds an attribute with the provided configuration to the host object.
The config argument object supports the following properties:
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.
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)
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.
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.
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.
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.
name
String
The name of the attribute.
config
Object
An 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.
lazy
Boolean
(optional) Whether or not to add this attribute lazily (on the first call to get/set).
A reference to the host object.
addAttrscfgs
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.
cfgs
Object
An object with attribute name/configuration pairs.
values
Object
An 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.
lazy
Boolean
Whether 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.
A reference to the host object.
addTargeto
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.
o
EventTarget
the target to add
aftertype
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.
A subscription handle capable of detaching the subscription
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.
[node]
Node | String | Null
optional
A reference (or selector String) for the
Node which with the widget is to be aligned. If null is passed in, the
widget will be aligned with the viewport.
[points]
Array2
optional
A 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 the
Node/viewport. Valid point references are defined as static constants on
the WidgetPositionAlign extension.
Aligning to the top-left corner of the <body>:
myWidget.align('body',
[Y.WidgetPositionAlign.TL, Y.WidgetPositionAlign.TR]);ancestordepth
Returns the Widget instance at the specified depth.
depth
Number
Number representing the depth of the ancestor.
Widget instance.
attrAddedname
Checks if the given attribute has been added to the host
name
String
The name of the attribute to check.
true if an attribute with the given name has been added, false if it hasn't. This method will return true for lazily added attributes.
beforeExecutes 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
detach handle
bindUIConfigures/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.
blurCauses the Widget to lose focus by setting the "focused" attribute to "false"
bubbleevt
Propagate an event. Requires the event-custom-complex module.
evt
CustomEvent
the custom event to propagate
the aggregated return value from Event.Custom.fire
centered[node]
Centers the widget in the viewport, or if a Node is passed in, it will
be centered to that Node.
clearCacheClears the result cache.
destroydestroyAllNodes
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.
destroyAllNodes
Boolean
If true, all nodes contained within the Widget are removed and destroyed. Defaults to false due to potentially high run-time cost.
A reference to this object
destructorDestructor 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.
detachtype
fn
context
Detach one or more listeners the from the specified event
type
String | Object
Either 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.
fn
Function
The subscribed function to unsubscribe, if not supplied, all subscribers will be removed.
context
Object
The 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)
the host
detachAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
disableSet the Widget's "disabled" attribute to "true".
enableSet the Widget's "disabled" attribute to "false".
firetype
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.
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.
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.
type
String | Object
The type of the event, or an object that contains a 'type' property.
arguments
Object*
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.
True if the whole lifecycle of the event went through, false if at any point the event propagation was halted.
focusCauses the Widget to receive the focus by setting the "focused" attribute to "true".
getname
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.
name
String
The 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"))
The value of the attribute
getAttrsattrs
Gets multiple attribute values.
An object with attribute name/value pairs.
getClassNameargs
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.
args
String*
multiple
0..n strings which should be concatenated, using the default separator defined by ClassNameManager, to create the class name
getEventtype
prefixed
Returns the custom event of the provided type has been created, a falsy value otherwise
the custom event or null
getSkinName[skinPrefix]
Returns the name of the skin that's currently applied to the widget.
Searches up the Widget's ancestor axis for, by default, a class yui3-skin-(name), and returns the (name) portion. Otherwise, returns null.
This is only really useful after the widget's DOM structure is in the document, either by render or by progressive enhancement.
[skinPrefix]
String
optional
The prefix which the implementation uses for the skin ("yui3-skin-" is the default).
NOTE: skinPrefix will be used as part of a regular expression:
new RegExp('\b' + skinPrefix + '(\S+)')Although an unlikely use case, literal characters which may result in an invalid regular expression should be escaped.
The name of the skin, or null, if a matching skin class is not found.
getStringkey
Helper method to get a specific string value
key
String
The string
getStringskey
Helper method to get the complete set of strings for the widget
key
String
The strings
getTargetsReturns an array of bubble targets for this object.
EventTarget[]
hideHides the list, unless the alwaysShowList attribute is true.
initcfg
Init lifecycle method, invoked during construction. Sets up attributes and invokes initializers for the class hierarchy.
cfg
Object
Object with configuration property name/value pairs
A reference to this object
initializerconfig
Initializer lifecycle implementation for the Widget class. Registers the widget instance, and runs through the Widget's HTML_PARSER definition.
config
Object
Configuration object literal for the widget
isRootDetermines if the Widget is the root Widget in the object hierarchy.
Boolean indicating if Widget is the root Widget in the object hierarchy.
modifyAttrname
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:
Note: New attributes cannot be added using this interface. New attributes must be added using addAttr, or an appropriate manner for a class which utilises Attributes (e.g. the ATTRS property in Base).
movex
[y]
Moves the Widget to the specified page xy co-ordinate position.
nextcircular
Returns the Widget's next sibling.
circular
Boolean
Boolean indicating if the parent's first child should be returned if the child has no next sibling.
Widget instance.
ontype
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.
A subscription handle capable of detaching that subscription
oncetype
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.
A subscription handle capable of detaching the subscription
onceAftertype
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.
A subscription handle capable of detaching that subscription
parseTypetype
[pre]
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.
an array containing:
previouscircular
Returns the Widget's previous sibling.
circular
Boolean
Boolean indicating if the parent's last child should be returned if the child has no previous sibling.
Widget instance.
publishtype
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.
type
String
the type, or name of the event
opts
Object
optional config params. Valid properties are:
the custom event
removeAttrname
Removes an attribute from the host object
name
String
The name of the attribute to be removed.
renderparentNode
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.
parentNode
Object | String
Optional. 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.
rendererCreates 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.
renderUIAdds nodes to the DOM
This method is not called by framework and is not chained automatically for the class hierarchy.
resetname
Resets the attribute (or all attributes) to its initial value, as long as the attribute is not readOnly, or writeOnce.
name
String
Optional. The name of the attribute to reset. If omitted, all attributes are reset.
A reference to the host object.
selectItem[itemNode]
[originEvent]
Selects the specified itemNode, or the current activeItem if itemNode
is not specified.
[itemNode]
Node
optional
Item node to select.
[originEvent]
EventFacade
optional
Event 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.
[query]
String
optional
Query to send. If specified, the query attribute
will be set to this query. If not specified, the current value of the
query attribute will be used.
[requestTemplate]
Function
optional
Request template function. If not
specified, the current value of the requestTemplate attribute will be
used.
setname
value
[opts]
Sets the value of an attribute.
name
String
The 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)).
value
Any
The value to set the attribute to.
[opts]
Object
optional
Optional data providing the circumstances for the change.
A reference to the host object.
setAttrsattrs
[opts]
Sets multiple attribute values.
A reference to the host object.
showShows the Widget by setting the "visible" attribute to "true".
subscribesubscribe to an event
syncUIRefreshes the rendered UI, based on Widget State
This method is not called by framework and is not chained automatically for the class hierarchy.
syncXYSynchronizes the Panel's "xy", "x", and "y" properties with the Widget's position in the DOM.
toStringGeneric toString implementation for all widgets.
The default string value for the widget [ displays the NAME of the instance, and the unique id ]
unsubscribedetach a listener
unsubscribeAlltype
Removes all listeners from the specified event. If the event type is not specified, all listeners from all hosted custom events will be removed.
type
String
The type, or name of the event
_allowAdHocAttrsThis 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._NON_ATTRS_CFG
Default: undefined (false)
_UI_ATTRSThe lists of UI attributes to bind and sync for widget's _bindUI and _syncUI implementations
_YQL_SOURCE_REGEXRegular expression used to determine whether a String source is a YQL query.
CONTENT_TEMPLATEProperty 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.
activateFirstItemIf true, the first item in the list will be activated by default when
the list is initially displayed and when results change.
Default: false
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.
e
EventFacade
activeItemItem that's currently active, if any. When the user presses enter, this is the item that will be selected.
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.
e
EventFacade
alignThe 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: The Node to which the widget is to be aligned. If set to
null, or not provided, the widget is aligned to the viewport.
points: A two element Array, defining the two points on the widget
and Node/viewport which are to be aligned. The first element is the
point on the widget, and the second element is the point on the
Node/viewport. Supported alignment points are defined as static
properties on WidgetPositionAlign.
Default: null
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.
e
EventFacade
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]
});alignOnAn 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 optional Node that will fire the event, it can be a
Node reference or a selector String. This will default to the widget's
boundingBox.
Default: []
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.
e
EventFacade
Sync this widget's alignment on window resize:
myWidget.set('alignOn', [
{
node : Y.one('win'),
eventName: 'resize'
}
]);allowBrowserAutocompleteWhether or not to enable the browser's built-in autocomplete functionality for input fields.
Default: false
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.
e
EventFacade
allowTrailingDelimiterWhen 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
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.
e
EventFacade
alwaysShowListIf true, the list will remain visible even when there are no results
to display.
Default: false
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.
e
EventFacade
boundingBoxThe 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.
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.
e
EventFacade
centeredA 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
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.
e
EventFacade
circularIf true, keyboard navigation will wrap around to the opposite end of
the list when navigating past the first or last item.
Default: true
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.
e
EventFacade
contentBoxA DOM node that is a direct descendant of a Widget's bounding box that houses its content.
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.
e
EventFacade
destroyedFlag indicating whether or not this object has been through the destroy lifecycle phase.
Default: false
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.
e
EventFacade
disabledBoolean indicating if the Widget should be disabled. The disabled implementation is left to the specific classes extending widget.
Default: false
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.
e
EventFacade
enableCacheWhether or not to enable in-memory caching in result sources that support it.
Default: true
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.
e
EventFacade
focusedBoolean indicating if the Widget, or one of its descendants, has focus.
Default: false
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.
e
EventFacade
heightString 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
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.
e
EventFacade
hoveredItemItem currently being hovered over by the mouse, if any.
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.
e
EventFacade
idDefault: Generated using guid()
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.
e
EventFacade
initializedFlag indicating whether or not this object has been through the init lifecycle phase.
Default: false
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.
e
EventFacade
inputNodeNode to monitor for changes, which will generate query events when
appropriate. May be either an <input> or a <textarea>.
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.
e
EventFacade
listNodeNode that will contain result items.
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.
e
EventFacade
maxResultsMaximum number of results to return. A value of 0 or less will allow an
unlimited number of results.
Default: 0
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.
e
EventFacade
minQueryLengthMinimum 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
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.
e
EventFacade
queryCurrent 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
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.
e
EventFacade
queryDelayNumber 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
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.
e
EventFacade
queryDelimiterQuery 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
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.
e
EventFacade
renderWhether or not to render the widget automatically after init, and optionally, to which parent node.
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.
e
EventFacade
renderedFlag indicating whether or not this Widget has been through the render lifecycle phase.
Default: false
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.
e
EventFacade
requestTemplateSource 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
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.
e
EventFacade
resultFiltersArray 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: []
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.
e
EventFacade
resultFormatterFunction 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.
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.
e
EventFacade
resultHighlighterFunction 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.
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.
e
EventFacade
resultListLocatorLocator 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.
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.
e
EventFacade
resultsCurrent results, or an empty array if there are no results.
Default: []
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.
e
EventFacade
resultTextLocatorLocator 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.
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.
e
EventFacade
scrollIntoViewIf true, the viewport will be scrolled to ensure that the active list
item is visible when necessary.
Default: false
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.
e
EventFacade
sourceSource for autocomplete results. The following source types are supported:
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.
<p>
Example: <code>['first result', 'second result', 'etc']</code>
</p>
DataSource instance or other object that provides a DataSource-like
sendRequest method. See the DataSource documentation for details.
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).
<p>
Example (synchronous):
</p>
<pre>
function (query) {
return ['foo', 'bar'];
}
</pre>
<p>
Example (async):
</p>
<pre>
function (query, callback) {
callback(['foo', 'bar']);
}
</pre>
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.
<p>
The response is assumed to be an array of results by default. If the
response is not an array, provide a <code>resultListLocator</code> to
process the response and return an array.
</p>
<p>
Example: <code>{foo: ['foo result 1', 'foo result 2'], bar: ['bar result']}</code>
</p>
If the optional autocomplete-sources module is loaded, then
the following additional source types will be supported as well:
resultTextLocator of '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 content of the <option> element.
Index of the <option> element in the list.
Node instance referring to the original <option> element.
Whether or not this item is currently selected in the <select> list.
Text content of the <option> element.
Value of the <option> element.
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).
<p>
The response is assumed to be an array of results by default. If the
response is not an array, provide a <code>resultListLocator</code> to process the
response and return an array.
</p>
<p>
<strong>The <code>jsonp</code> module must be loaded in order for
JSONP URL sources to work.</strong> If the <code>jsonp</code> module
is not already loaded, it will be loaded on demand if possible.
</p>
<p>
Example: <code>'http://example.com/search?q={query}&callback={callback}'</code>
</p>
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).
<p>
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
<code>resultListLocator</code> to 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.
</p>
<p>
<strong>The <code>io-base</code> and <code>json-parse</code> modules
must be loaded in order for XHR URL sources to work.</strong> If
these modules are not already loaded, they will be loaded on demand
if possible.
</p>
<p>
Example: <code>'http://example.com/search?q={query}'</code>
</p>
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).
<p>
<strong>The <code>yql</code> module must be loaded in order for YQL
sources to work.</strong> If the <code>yql</code> module is not
already loaded, it will be loaded on demand if possible.
</p>
<p>
Example: <code>'select * from search.suggest where query="{query}"'</code>
</p>
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.
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.
e
EventFacade
sourceTypeMay 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'
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.
e
EventFacade
srcNodeThe DOM node to parse for configuration values, passed to the Widget's HTML_PARSER definition
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.
e
EventFacade
stringsTranslatable strings used by the AutoCompleteList widget.
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.
e
EventFacade
tabIndexNumber (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
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.
e
EventFacade
tabSelectIf true, pressing the tab key while the list is visible will select
the active item, if any.
Default: true
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.
e
EventFacade
tokenInputIf 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.
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.
e
EventFacade
valueCurrent value of the input node.
Default: ''
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.
e
EventFacade
visibleBoolean indicating whether or not the Widget is visible.
Default: TRUE
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.
e
EventFacade
widthString 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
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.
e
EventFacade
xPage 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
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.
e
EventFacade
xyPage XY co-ordinate pair for the widget.
Default: [0,0]
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.
e
EventFacade
yPage 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
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.
e
EventFacade
yqlEnvYQL 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
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.
e
EventFacade
yqlProtocolURL protocol to use when the source is set to a YQL query.
Default: 'http'
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.
e
EventFacade
clearFires after the query has been completely cleared or no longer meets the minimum query length requirement.
destroyLifecycle 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).
e
EventFacade
Event object
initLifecycle 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).
e
EventFacade
Event object, with a cfg property which refers to the configuration object passed to the constructor.
queryFires when the contents of the input field have changed and the input value meets the criteria necessary to generate an autocomplete query.
renderLifecycle 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.
e
EventFacade
The Event Facade
resultsFires after query results are received from the source. If no source has been set, this event will not fire.
data
Array | Object
Raw, unfiltered result data (if available).
query
String
Query that generated these results.
results
Object[]
Array of filtered, formatted, and highlighted results. Each item in the array is an object with the following properties:
display
Node | HTMLElement | String
Formatted 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
text property.
[highlighted]
String
optional
Highlighted (but not formatted) result text. This property will only be set if a highlighter is in use.
raw
Any
Raw, unformatted result in whatever form it was provided by the source.
text
String
Plain 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
innerHTML or Node#setContent().
selectFires when an autocomplete suggestion is selected from the list, typically via a keyboard action or mouse click.
widget:contentUpdateNotification 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).
e
EventFacade
The Event Facade