AutoCompleteList

`_activateNextItem`

() protected chainable

Defined in yui3/src/autocomplete/js/autocomplete-list.js:212

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

Defined in yui3/src/autocomplete/js/autocomplete-list.js:237

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

)

NodeList protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:256

Appends the specified result items to the list inside a new item node.

Parameters:

items Array | Node | HTMLElement | String

Result item or array of result items.

Returns:

NodeList:

Added nodes.

`_addAttrs`

(

cfgs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:877

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:

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 <a href="#method_addAttr">addAttr</a>.

`_addLazyAttr`

(

name
[lazyCfg]

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:360

Finishes initializing an attribute which has been lazily added.

Parameters:

name Object

The name of the attribute
[lazyCfg] Object optional

Optional config hash for the attribute. This is added for performance along the critical path, where the calling method has already obtained lazy config from state.

`_addOutOfOrder`

(

name
cfg

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:550

Utility method used by get/set to add attributes encountered out of order when calling addAttrs(). For example, if: <pre><code>this.addAttrs({ foo: { setter: function() { // make sure this bar is available when foo is added this.get("bar"); } }, bar: { value: ... } });</code></pre>

Parameters:

name String

attribute name
cfg Object

attribute configuration

`_afterActiveItemChange`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:553

Handles activeItemChange events.

Parameters:

e EventFacade

`_afterAlignChange`

(

e

)

protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:654

Handles alignChange events by updating the UI in response to align Attribute changes.

Parameters:

e EventFacade

`_afterAlignOnChange`

(

e

)

protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:669

Handles alignOnChange events by updating the alignment-syncing event handlers.

Parameters:

e EventFacade

`_afterAlwaysShowListChange`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:590

Handles alwaysShowListChange events.

Parameters:

e EventFacade

`_afterChildSelectedChange`

(

event

)

protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:327

Default attribute change listener for the <code>selected</code> attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

event EventFacade

The event facade for the attribute change.

`_afterDocClick`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:601

Available since 3.5.0

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:

e EventFacade

`_afterHoveredItemChange`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:620

Handles hoveredItemChange events.

Parameters:

e EventFacade

`_afterListInputBlur`

() protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:640

Handles inputNode blur events.

`_afterListInputFocus`

() protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:658

Handles inputNode focus events.

`_afterMouseOut`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:685

Handles mouseout events.

Parameters:

e EventFacade

`_afterMouseOver`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:668

Handles mouseover events.

Parameters:

e EventFacade

`_afterResultsChange`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:697

Handles resultsChange events.

Parameters:

e EventFacade

`_afterSourceTypeChange`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:789

Updates the current <code>source</code> based on the new <code>sourceType</code> to ensure that the two attributes don't get out of sync when they're changed separately.

Parameters:

e EventFacade

`_afterValueChange`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:803

Handles change events for the <code>value</code> attribute.

Parameters:

e EventFacade

`_afterVisibleChange`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:712

Handles visibleChange events.

Parameters:

e EventFacade

`_afterXYChange`

(

e

)

protected

Inherited from WidgetPosition: yui3/src/widget-position/js/Widget-Position.js:245

Default attribute change listener for the xy attribute, responsible for updating the UI, in response to attribute changes.

Parameters:

e EventFacade

The event facade for the attribute change

`_aggregateAttrs`

(

allAttrs

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:618

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:

allAttrs Array

An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)

Returns:

Object:

The aggregate set of ATTRS definitions for the instance

`_applyParsedConfig`

() Object protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:121

Returns:

Object:

The merged configuration literal

`_applyParser`

(

config

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:130

Utility method used to apply the <code>HTML_PARSER</code> configuration for the instance, to retrieve config data values.

Parameters:

config Object

User configuration object (will be populated with values from Node)

`_ariaSay`

(

stringId
[subs]

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:278

Updates the ARIA live region with the specified message.

Parameters:

stringId String

String id (from the strings attribute) of the message to speak.
[subs] Object optional

Substitutions for placeholders in the string.

`_attachPosAlignUIHandles`

() protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:570

Attaches the alignment-syncing event handlers.

`_attrCfgHash`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:581

Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.

`_baseDestroy`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:364

Internal destroy implementation for BaseCore

`_baseInit`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:336

Internal initialization implementation for BaseCore

`_beforeCreateObjectSource`

(

source

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:29

Runs before AutoCompleteBase's <code>_createObjectSource()</code> method and augments it to support additional object-based source types.

Parameters:

source String

`_bindAttrUI`

(

attrs

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1185

Binds after listeners for the list of attributes provided

Parameters:

attrs Array

`_bindDOM`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:917

Sets up DOM listeners, on elements rendered by the widget.

`_bindInput`

() protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:292

Binds inputNode events and behavior.

`_bindKeys`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:53

Binds keyboard events.

`_bindList`

() protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:331

Binds list events.

`_bindUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:898

Sets up DOM and CustomEvent listeners for the widget.

`_bindUIACBase`

() protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:242

Attaches event listeners and behaviors.

`_bindUIChild`

() protected

Inherited from Widget: yui3/src/widget-child/js/Widget-Child.js:356

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

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:251

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

Inherited from WidgetPosition: yui3/src/widget-position/js/Widget-Position.js:146

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

Defined in yui3/src/autocomplete/js/autocomplete-list.js:358

Clears the contents of the tray.

`_cloneDefaultValue`

(

cfg

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:592

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.

Parameters:

cfg Object

`_createAriaNode`

() Node protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:371

Creates and returns an ARIA live region node.

Returns:

Node:

ARIA node.

`_createArraySource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:291

Creates a DataSource-like object that simply returns the specified array as a response. See the <code>source</code> attribute for more details.

Parameters:

source Array

Returns:

Object:

DataSource-like object.

`_createFunctionSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:311

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 <code>source</code> attribute for more details.

Parameters:

source Function

Function that accepts a query and a callback as parameters, and calls the callback with an array of results.

Returns:

Object:

DataSource-like object.

`_createIOSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:57

Creates a DataSource-like object that uses <code>Y.io</code> as a source. See the <code>source</code> attribute for more details.

Parameters:

source String

URL.

Returns:

Object:

DataSource-like object.

`_createItemNode`

(

result

)

Node protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:387

Creates and returns an item node with the specified content.

Parameters:

result Object

Result object.

Returns:

Node:

Item node.

`_createJSONPSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:130

Creates a DataSource-like object that uses the specified JSONPRequest instance as a source. See the <code>source</code> attribute for more details.

Parameters:

source JSONPRequest | String

URL string or JSONPRequest instance.

Returns:

Object:

DataSource-like object.

`_createListNode`

() Node protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:404

Creates and returns a list node. If the listNode attribute is already set to an existing node, that node will be used.

Returns:

Node:

List node.

`_createObjectSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:343

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 <code>source</code> attribute for more details.

Parameters:

source Object

Returns:

Object:

DataSource-like object.

`_createSelectSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:199

Creates a DataSource-like object that uses the specified <code><select></code> node as a source.

Parameters:

source Node

YUI Node instance wrapping a <code><select></code> node.

Returns:

Object:

DataSource-like object.

`_createStringSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:233

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 <code>source</code> attribute for more details.

Parameters:

source String

URL or YQL query.

Returns:

Object:

DataSource-like object.

`_createUIEvent`

(

type

)

private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:73

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:

type String

String representing the name of the event

`_createYQLSource`

(

source

)

Object protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:261

Creates a DataSource-like object that uses the specified YQL query string to create a YQL-based source. See the <code>source</code> attribute for details. If no <code>resultListLocator</code> is defined, this method will set a best-guess locator that might work for many typical YQL queries.

Parameters:

source String

YQL query.

Returns:

Object:

DataSource-like object.

`_defAttrChangeFn`

(

e
eventFastPath

)

private

Inherited from AttributeObservable: yui3/src/attribute/js/AttributeObservable.js:185

Default function for attribute change events.

Parameters:

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

`_defaultBB`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:776

Returns 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).

`_defaultCB`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:795

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

)

Array protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:348

Default resultListLocator used when a string-based YQL source is set and the implementer hasn't already specified one.

Parameters:

response Object

YQL response object.

Returns:

Array:

`_defClearFn`

() protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:932

Default <code>clear</code> event handler. Sets the <code>results</code> attribute to an empty array and <code>query</code> to null.

`_defDestroyFn`

(

e

)

protected

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:202

Default destroy event handler

Parameters:

e EventFacade

Event object

`_defInitFn`

(

e

)

protected

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:190

Default init event handler

Parameters:

e EventFacade

Event object, with a cfg property which refers to the configuration object passed to the constructor.

`_defQueryFn`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:944

Default <code>query</code> event handler. Sets the <code>query</code> attribute and sends a request to the source if one is configured.

Parameters:

e EventFacade

`_defRenderFn`

(

e
parentNode

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:567

Default render handler

Parameters:

e EventFacade

The Event object
parentNode Node

The parent node to render to, if passed in to the <code>render</code> method

`_defResultsFn`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:957

Default <code>results</code> event handler. Sets the <code>results</code> attribute to the latest results.

Parameters:

e EventFacade

`_defSelectFn`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:739

Default select event handler.

Parameters:

e EventFacade

`_destroyBox`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:472

Removes and destroys the widgets rendered boundingBox, contentBox, and detaches bound UI events.

`_destroyHierarchy`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:782

Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.

`_destroyUIEvents`

() private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:20

Destructor logic for UI event infrastructure, invoked during Widget destruction.

`_detachPosAlignUIHandles`

() protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:598

Detaches the alignment-syncing event handlers.

`_doAlign`

(

xy

)

private

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:614

Helper method, used to align the given point on the widget, with the XY page coordinates provided.

Parameters:

xy Array

XY page coordinates to align to.

`_filterAdHocAttrs`

(

allAttrs
userVals

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:470

Parameters:

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.

Returns:

Object:

The set of adhoc attributes passed in, in the form of an object with attribute name/configuration pairs.

`_filterUIEvent`

(

evt

)

Boolean private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:117

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:

evt DOMEventFacade

Returns:

Boolean:

true if it's OK to fire the custom UI event, false if not.

`_fireAttrChange`

(

attrName
subAttrName
currVal
newVal
opts
[cfg]

)

private

Inherited from AttributeObservable: yui3/src/attribute/js/AttributeObservable.js:120

Utility method to help setup the event payload and fire the attribute change event.

Parameters:

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.

`_functionValidator`

(

value

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:369

Returns <code>true</code> if value is either a function or <code>null</code>.

Parameters:

value Function | Null

Value to validate.

`_getAlignedXY`

(

[node]
points

)

Array protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:425

Returns Widget alignment coordinates realative to the given Node.

Parameters:

[node] Node | String | Null optional

The node to align to, or null to indicate the viewport.
points Array

The alignment points.

Returns:

Array:

the coordinates.

`_getAlignToXY`

(

'Node'
[point]
'Node'
'Node'

)

Array private

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:340

Returns coordinates realative to the passed Node alignment.

Parameters:

'Node' Node

The node to align to.
[point] Array optional

The node alignment points.
'Node' Number

x coordinate.
'Node' Number

y coordinate.

Returns:

Array:

the coordinates.

`_getAttr`

(

name

)

Any protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:587

Provides the common implementation for the public get method, allowing Attribute hosts to over-ride either method. See <a href="#method_get">get</a> for argument details.

Parameters:

name String

The name of the attribute.

Returns:

Any:

The value of the attribute.

`_getAttrCfg`

(

name

)

Object protected

Inherited from AttributeExtras: yui3/src/attribute/js/AttributeExtras.js:125

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:

name String

Optional. The attribute name. If not provided, the method will return the configuration for all attributes.

Returns:

Object:

The configuration properties for the given attribute, or all attributes.

`_getAttrCfgs`

() Object protected

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:394

Returns an aggregated set of attribute configurations, by traversing the class hierarchy.

Returns:

Object:

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.

`_getAttrInitVal`

(

attr
cfg
initValues

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:986

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:

attr String

The name of the attribute
cfg Object

The attribute configuration object
initValues Object

The object with simple and complex attribute name/value pairs returned from _normAttrVals

Returns:

Any:

The initial value of the attribute.

`_getAttrs`

(

attrs

)

Object protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:815

Implementation behind the public getAttrs method, to get multiple attribute values.

Parameters:

attrs String | Boolean

Optional. 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:

Object:

An object with attribute name/value pairs.

`_getClasses`

() Function protected

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:378

Returns the class hierarchy for this object, with BaseCore being the last class in the array.

Returns:

Function:

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.

`_getFirstItemNode`

() Node | Null protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:426

Gets the first item node in the list, or null if the list is empty.

Returns:

Node | Null:

`_getFullType`

(

type

)

String private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:564

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.

Parameters:

type String

The short type to prefix

Returns:

String:

The prefixed type, if a prefix is set, otherwise the type passed in

`_getHtmlParser`

() Object private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:187

Gets the HTML_PARSER definition for this instance, by merging HTML_PARSER definitions across the class hierarchy.

Returns:

Object:

HTML_PARSER definition for this instance

`_getInstanceAttrCfgs`

(

allCfgs

)

Object private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:411

A helper method used to isolate the attrs config for this instance to pass to addAttrs, from the static cached ATTRS for the class.

Parameters:

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.

Returns:

Object:

The set of attributes to be added for this instance, suitable for passing through to <code>addAttrs</code>.

`_getLastItemNode`

() Node | Null protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:437

Gets the last item node in the list, or null if the list is empty.

Returns:

Node | Null:

`_getNodeToParse`

() Node private

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:172

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:

Node:

The node reference to apply HTML_PARSER to.

`_getObjectValue`

(

obj
path

)

Any protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:380

Faster and safer alternative to <code>Y.Object.getValue()</code>. 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 <code>undefined</code> nor an object.

Parameters:

obj Object
path Array

Returns:

Any:

Located value, or <code>undefined</code> if the value was not found at the specified path.

`_getRegion`

(

[node]

)

Object private

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:628

Returns the region of the passed-in Node, or the viewport region if calling with passing in a Node.

Parameters:

[node] Node optional

The node to get the region of.

Returns:

Object:

The node's region.

`_getSrcNode`

() Node protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:74

Returns:

Node:

The Node to apply HTML_PARSER to

`_getStateVal`

(

name
[cfg]

)

Any private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:641

Gets the stored value for the attribute, from either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
[cfg] 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.

Returns:

Any:

The stored value of the attribute

`_getType`

() private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:36

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

Inherited from Widget but overwritten in yui3/src/widget/js/WidgetUIEvents.js:62

Returns the node on which to bind delegate listeners.

`_getX`

() Number protected

Inherited from WidgetPosition: yui3/src/widget-position/js/Widget-Position.js:221

Default getter for the X attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number:

The X page co-ordinate value

`_getXHRUrl`

(

url
request

)

String protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:380

Returns a formatted XHR URL based on the specified base url, query, and the current requestTemplate if any.

Parameters:

url String

Base URL.
request Object

Request object containing <code>query</code> and <code>request</code> properties.

Returns:

String:

Formatted URL.

`_getY`

() Number protected

Inherited from WidgetPosition: yui3/src/widget-position/js/Widget-Position.js:233

Default getter for the Y attribute. The value is retrieved from the XY attribute, which is the sole store for the XY state.

Returns:

Number:

The Y page co-ordinate value

`_guid`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1168

`_hasPotentialSubscribers`

(

fullType

)

Boolean private

Inherited from EventTarget: yui3/src/event-custom/js/event-facade.js:643

Parameters:

fullType String

The fully prefixed type name

Returns:

Boolean:

Whether the event has potential subscribers or not

`_initAttrHost`

(

attrs
values
lazy

)

private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:140

Constructor logic for attributes. Initializes the host state, and sets up the inital attributes passed to the constructor.

Parameters:

attrs Object

The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). 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 <a href="#method_addAttrs">addAttrs</a>). 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 <a href="#method_addAttrs">addAttrs</a>).

`_initAttribute`

() private

Inherited from BaseObservable but overwritten in yui3/src/base/js/BaseCore.js:309

Initializes AttributeCore

`_initAttrs`

(

attrs
values
lazy

)

protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:1052

Utility method to set up initial attributes defined during construction, either through the constructor.ATTRS property, or explicitly passed in.

Parameters:

attrs Object

The attributes to add during construction (passed through to <a href="#method_addAttrs">addAttrs</a>). 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 <a href="#method_addAttrs">addAttrs</a>). 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 <a href="#method_addAttrs">addAttrs</a>).

`_initBase`

(

config

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:274

Internal construction logic for BaseCore.

Parameters:

config Object

The constructor configuration object

`_initHierarchy`

(

userVals

)

private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:702

Initializes the class hierarchy for the instance, which includes initializing attributes for each class defined in the class's static <a href="#property_BaseCore.ATTRS">ATTRS</a> property and invoking the initializer method on the prototype of each class in the hierarchy.

Parameters:

userVals Object

Object with configuration property name/value pairs

`_initHierarchyData`

() private

Inherited from BaseCore: yui3/src/base/js/BaseCore.js:500

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

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:24

Initializes keyboard command mappings.

`_initUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:176

Sets up infrastructure required to fire a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

`_isLazyAttr`

(

name

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:347

Checks whether or not the attribute is one which has been added lazily and still requires initialization.

Parameters:

name String

The name of the attribute

Returns:

Boolean:

true if it's a lazily added attribute, false otherwise.

`_isUIEvent`

(

type

)

String private

Inherited from Widget: yui3/src/widget/js/WidgetUIEvents.js:143

Determines if the specified event is a UI event.

Parameters:

type String

String representing the name of the event

Returns:

String:

Event Returns the name of the UI Event, otherwise undefined.

`_jsonpFormatter`

(

url
proxy
query

)

String protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-sources.js:406

URL formatter passed to <code>JSONPRequest</code> instances.

Parameters:

url String
proxy String
query String

Returns:

String:

Formatted URL

`_keyDown`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:76

Called when the down arrow key is pressed.

`_keyEnter`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:90

Called when the enter key is pressed.

`_keyEsc`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:107

Called when the escape key is pressed.

`_keyTab`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:117

Called when the tab key is pressed.

`_keyUp`

() protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:138

Called when the up arrow key is pressed.

`_mapInstance`

(

The

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:410

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:

The String

boundingBox id

`_monitor`

(

what
eventType
o

)

private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:636

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.

Parameters:

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

`_normAttrVals`

(

valueHash

)

Object private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:938

Utility method to normalize attribute values. The base implementation simply merges the hash to protect the original.

Parameters:

valueHash Object

An object with attribute name/value pairs

Returns:

Object:

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.

`_onDocFocus`

(

evt

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1096

DOM focus event handler, used to sync the state of the Widget with the DOM

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onDocMouseDown`

(

evt

)

protected

Inherited from Widget: yui3/src/widget/js/Widget.js:1083

"mousedown" event handler for the owner document of the widget's bounding box.

Parameters:

evt EventFacade

The event facade for the DOM focus event

`_onInputBlur`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:860

Handles <code>blur</code> events on the input node.

Parameters:

e EventFacade

`_onInputKey`

(

e

)

protected

Provided by the autocomplete-list-keys module.

Defined in yui3/src/autocomplete/js/autocomplete-list-keys.js:150

Handles inputNode key events.

Parameters:

e EventTarget

`_onInputValueChange`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:898

Handles <code>valueChange</code> events on the input node and fires a <code>query</code> event when the input value meets the configured criteria.

Parameters:

e EventFacade

`_onItemClick`

(

e

)

protected

Defined in yui3/src/autocomplete/js/autocomplete-list.js:723

Delegated event handler for item click events.

Parameters:

e EventFacade

`_onResponse`

(

e

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:916

Handles source responses and fires the <code>results</code> event.

Parameters:

e EventFacade

`_parseResponse`

(

query
response
data

)

protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:405

Parses result responses, performs filtering and highlighting, and fires the <code>results</code> event.

Parameters:

query String

Query that generated these results.
response Object

Response containing results.
data Object

Raw response data.

`_parseType`

() private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:52

Returns an array with the detach key (if provided), and the prefixed event name from _getType Y.on('detachcategory| menu:click', fn)

`_parseValue`

(

value

)

String | Null protected

Inherited from AutoCompleteBase: yui3/src/autocomplete/js/autocomplete-base.js:536

Returns the query portion of the specified input value, or <code>null</code> 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:

value String

Input value from which to extract the query.

Returns:

String | Null:

query

`_preAddAttrs`

(

attrs
userVals
lazy

)

protected

Inherited from Widget: yui3/src/widget/js/WidgetHTMLParser.js:83

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.

Parameters:

attrs Object

The full hash of statically defined ATTRS attributes being added for this instance
userVals Object

The hash of user values passed to the constructor
lazy Boolean

Whether or not to add the attributes lazily

`_preInitEventCfg`

(

config

)

private

Inherited from BaseObservable: yui3/src/base/js/BaseObservable.js:110

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:

config Object

The user configuration object

`_protectAttrs`

(

attrs

)

Object deprecated protected

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:924

Deprecated: Use `AttributeCore.protectAttrs()` or `Attribute.protectAttrs()` which are the same static utility method.

Utility method to protect an attribute configuration hash, by merging the entire object and the individual attr config objects.

Parameters:

attrs Object

A hash of attribute to configuration object pairs.

Returns:

Object:

A protected version of the attrs argument.

`_publish`

(

fullType
etOpts
ceOpts

)

CustomEvent private

Inherited from EventTarget: yui3/src/event-custom/js/event-target.js:588

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.

Parameters:

fullType String

The prefixed type of the event to publish.
etOpts Object

The EventTarget specific configuration to mix into the published event.
ceOpts Object

The publish specific configuration to mix into the published event.

Returns:

CustomEvent:

The published event. If called without <code>etOpts</code> or <code>ceOpts</code>, this will be the default <code>CustomEvent</code> instance, and can be configured independently.

`_removeLoadingClassNames`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:877

Removes class names representative of the widget's loading state from the boundingBox.

`_renderBox`

(

parentNode

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:706

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:

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.

`_renderBoxClassNames`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:853

Applies standard class names to the boundingBox and contentBox

`_renderUI`

() protected

Inherited from Widget: yui3/src/widget/js/Widget.js:842

Initializes the UI state for the Widget's bounding/content boxes.

`_renderUIPosition`

() protected

Inherited from WidgetPosition: yui3/src/widget-position/js/Widget-Position.js:116

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
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:405

Allows setting of readOnly/writeOnce attributes. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
val Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.

Returns:

Object:

A reference to the host object.

`_setAlignCenter`

(

val

)

Boolean | Node protected

Inherited from WidgetPositionAlign: yui3/src/widget-position-align/js/Widget-PositionAlign.js:513

Default setter for center Attribute changes. Sets up the appropriate value, and passes it through the to the align attribute.

Parameters:

val Boolean | Node

The Attribute value being set.

Returns:

Boolean | Node:

the value passed in.

`_setAttr`

(

name
value
[opts]
force

)

Object protected chainable

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:421

Provides the common implementation for the public set and protected _set methods. See <a href="#method_set">set</a> for argument details.

Parameters:

name String

The name of the attribute.
value Any

The value to set the attribute to.
[opts] Object optional

Optional data providing the circumstances for the change.
force Boolean

If true, allows the caller to set values for readOnly or writeOnce attributes which have already been set.

Returns:

Object:

A reference to the host object.

`_setAttrs`

(

attrs
[opts]

)

Object protected chainable

Inherited from AttributeObservable but overwritten in yui3/src/attribute/js/AttributeCore.js:783

Implementation behind the public setAttrs method, to set multiple attribute values.

Parameters:

attrs Object

An object with attributes name/value pairs.
[opts] Object optional

Optional data providing the circumstances for the change

Returns:

Object:

A reference to the host object.

`_setAttrUI`

(

e

)

private

Inherited from Widget: yui3/src/widget/js/Widget.js:1216

Parameters:

e EventFacade

`_setAttrVal`

(

attrName
subAttrName
prevVal
newVal
[opts]
[attrCfg]

)

Boolean private

Inherited from AttributeCore: yui3/src/attribute/js/AttributeCore.js:681

Updates the stored value of the attribute in the privately held State object, if validation and setter passes.

Parameters:

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.

Returns:

Boolean:

APIs

AutoCompleteList Class

Constructor

Parameters:

Index

Methods

Properties

Attributes

Events

Methods

_activateNextItem

_activatePrevItem

_add

Parameters:

Returns:

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_afterActiveItemChange

Parameters:

_afterAlignChange

Parameters:

_afterAlignOnChange

Parameters:

_afterAlwaysShowListChange

Parameters:

_afterChildSelectedChange

Parameters:

_afterDocClick

Parameters:

_afterHoveredItemChange

Parameters:

_afterListInputBlur

_afterListInputFocus

_afterMouseOut

Parameters:

_afterMouseOver

Parameters:

_afterResultsChange

Parameters:

_afterSourceTypeChange

Parameters:

_afterValueChange

Parameters:

_afterVisibleChange

Parameters:

_afterXYChange

Parameters:

_aggregateAttrs

Parameters:

Returns:

_applyParsedConfig

Returns:

_applyParser

Parameters:

_ariaSay

Parameters:

_attachPosAlignUIHandles

_attrCfgHash

_baseDestroy

_baseInit

_beforeCreateObjectSource

Parameters:

_bindAttrUI

Parameters:

_bindDOM

_bindInput

_bindKeys

_bindList

_bindUI

_bindUIACBase

_bindUIChild

_bindUIPosAlign

_bindUIPosition

_clear

_cloneDefaultValue