Plugin.Pjax - AlloyUI

`_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

`_afterHistoryChange`

(

e

)

protected

Inherited from Router: yui3/src/app/js/router.js:1600

Handles <code>history:change</code> and <code>hashchange</code> events.

Parameters:

e EventFacade

`_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

`_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

`_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

`_decode`

(

string

)

String protected

Inherited from Router: yui3/src/app/js/router.js:765

Wrapper around <code>decodeURIComponent</code> that also converts <code>+</code> chars into spaces.

Parameters:

string String

String to decode.

Returns:

String:

Decoded string.

`_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

`_defaultRoute`

(

req
res
next

)

protected

Inherited from Pjax: yui3/src/pjax/js/pjax.js:81

Available since 3.5.0

Default Pjax route callback. Fires either the load or error event based on the status of the Y.io request made by the loadContent() middleware.

Note: This route callback assumes that it's called after the loadContent() middleware.

Parameters:

req Object

Request object.
res Object

Response Object.
next Function

Function to pass control to the next route callback.

`_defCompleteFn`

(

e

)

protected

Inherited from Pjax: yui3/src/pjax/js/pjax.js:113

Available since 3.5.0

Default event handler for both the error and load events. Attempts to insert the loaded content into the container node and update the page's title.

Parameters:

e EventFacade

`_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.

`_defNavigateFn`

(

e

)

protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:291

Available since 3.5.0

Default handler for the <code>navigate</code> event. Adds a new history entry or replaces the current entry for the specified URL and will scroll the page to the top if configured to do so.

Parameters:

e EventFacade

`_defReadyFn`

(

e

)

protected

Inherited from Router: yui3/src/app/js/router.js:1635

Default handler for the <code>ready</code> event.

Parameters:

e EventFacade

`_dequeue`

() protected chainable

Inherited from Router: yui3/src/app/js/router.js:778

Shifts the topmost <code>_save()</code> call off the queue and executes it. Does nothing if the queue is empty.

`_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.

`_dispatch`

(

req
res

)

protected chainable

Inherited from Router: yui3/src/app/js/router.js:806

Dispatches to the first route handler that matches the specified path. If called before the <code>ready</code> event has fired, the dispatch will be aborted. This ensures normalized behavior between Chrome (which fires a <code>popstate</code> event on every pageview) and other browsers (which do not).

Parameters:

req Object

Request object.
res String

Response object.

`_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.

`_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.

`_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.

`_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

`_getHashPath`

(

[hash]

)

String protected

Inherited from Router: yui3/src/app/js/router.js:896

Returns the resolved path from the hash fragment, or an empty string if the hash is not path-like.

Parameters:

[hash] String optional

Hash fragment to resolve into a path. By default this will be the hash from the current URL.

Returns:

String:

Current hash path, or an empty string if the hash is empty.

`_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 <code>addAttrs</code>, 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>.

`_getOrigin`

() String protected

Inherited from Router: yui3/src/app/js/router.js:917

Gets the location origin (i.e., protocol, host, and port) as a URL.

Returns:

String:

Location origin (i.e., protocol, host, and port).

Example:

<pre class="code prettyprint"><code>http://example.com</code></pre>

`_getParams`

() Object protected

Inherited from Router: yui3/src/app/js/router.js:932

Available since 3.12.0

Getter for the <code>params</code> attribute.

Returns:

Object:

Mapping of param handlers: <code>name</code> -> RegExp | Function.

`_getParamValues`

(

route
path

)

Boolean | Array | Object protected

Inherited from Router: yui3/src/app/js/router.js:944

Available since 3.16.0

Gets the param values for the specified <code>route</code> and <code>path</code>, suitable to use form <code>req.params</code>. Note: This method will return <code>false</code> if a named param handler rejects a param value.

Parameters:

route Object

The route to get param values for.
path String

The route path (root removed) that provides the param values.

Returns:

Boolean | Array | Object:

The collection of processed param values. Either a hash of <code>name</code> -> <code>value</code> for named params processed by this router's param handlers, or an array of matches for a route with unnamed params. If a named param handler rejects a value, then <code>false</code> will be returned.

`_getPath`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1024

Gets the current route path.

Returns:

String:

Current route path.

`_getPathRoot`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1038

Available since 3.5.0

Returns the current path root after popping off the last path segment, making it useful for resolving other URL paths against. The path root will always begin and end with a '/'.

Returns:

String:

The URL's path root.

`_getQuery`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1064

Gets the current route query string.

Returns:

String:

Current route query string.

`_getRegex`

(

path
keys

)

RegExp protected

Inherited from Router: yui3/src/app/js/router.js:1085

Creates a regular expression from the given route specification. If path is already a regex, it will be returned unmodified.

Parameters:

path String | RegExp

Route path specification.
keys Array

Array reference to which route parameter names will be added.

Returns:

RegExp:

Route regex.

`_getRequest`

(

src

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1120

Gets a request object that can be passed to a route handler.

Parameters:

src String

What initiated the URL change and need for the request.

Returns:

Object:

Request object.

`_getResponse`

(

req

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1138

Gets a response object that can be passed to a route handler.

Parameters:

req Object

Request object.

Returns:

Object:

Response Object.

`_getRoutes`

() Object protected

Inherited from Router: yui3/src/app/js/router.js:1150

Getter for the <code>routes</code> attribute.

Returns:

Object:

Array of route objects.

`_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.

`_getURL`

() String protected

Inherited from Router: yui3/src/app/js/router.js:1161

Gets the current full URL.

Returns:

String:

URL.

`_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

`_hasSameOrigin`

(

url

)

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:1178

Returns <code>true</code> when the specified <code>url</code> is from the same origin as the current URL; i.e., the protocol, host, and port of the URLs are the same. All host or path relative URLs are of the same origin. A scheme-relative URL is first prefixed with the current scheme before being evaluated.

Parameters:

url String

URL to compare origin with the current URL.

Returns:

Boolean:

Whether the URL has the same origin of the current URL.

`_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.

`_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.

`_isLinkSameOrigin`

(

link

)

Boolean protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:152

Available since 3.6.0

Utility method to test whether a specified link/anchor node's <code>href</code> is of the same origin as the page's current location. This normalize browser inconsistencies with how the <code>port</code> is reported for anchor elements (IE reports a value for the default port, e.g. "80").

Parameters:

link Node

The anchor element to test whether its <code>href</code> is of the same origin as the page's current location.

Returns:

Boolean:

Whether or not the link's <code>href</code> is of the same origin as the page's current location.

`_joinURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1201

Joins the <code>root</code> URL to the specified url, normalizing leading/trailing <code>/</code> characters.

Parameters:

url String

URL to append to the <code>root</code> URL.

Returns:

String:

Joined URL.

Example:

<pre class="code prettyprint"><code>router.set('root', '/foo'); router._joinURL('bar'); // => '/foo/bar' router._joinURL('/bar'); // => '/foo/bar' router.set('root', '/foo/'); router._joinURL('bar'); // => '/foo/bar' router._joinURL('/bar'); // => '/foo/bar'</code></pre>

`_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

`_navigate`

(

url
[options]

)

Boolean protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:201

Available since 3.5.0

Underlying implementation for <code>navigate()</code>.

Parameters:

url String

The fully-resolved URL that the router should dispatch to its route handlers to fulfill the enhanced navigation "request", or use to update <code>window.location</code> in non-HTML5 history capable browsers.
[options] Object optional

Additional options to configure the navigation. These are mixed into the <code>navigate</code> event facade.
- [replace] Boolean optional
 
 Whether or not the current history entry will be replaced, or a new entry will be created. Will default to <code>true</code> if the specified <code>url</code> is the same as the current URL.
- [force=false] Boolean optional
 
 Whether the enhanced navigation should occur even in browsers without HTML5 history.

Returns:

Boolean:

<code>true</code> if the URL was navigated to, <code>false</code> otherwise.

`_normalizePath`

(

path

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1234

Available since 3.5.0

Returns a normalized path, ridding it of any '..' segments and properly handling leading and trailing slashes.

Parameters:

path String

URL path to normalize.

Returns:

String:

Normalized path.

`_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.

`_onLinkClick`

(

e

)

protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:316

Available since 3.5.0

Handler for delegated link-click events which match the <code>linkSelector</code>. This will attempt to enhance the navigation to the link element's <code>href</code> by passing the URL to the <code>_navigate()</code> method. When the navigation is being enhanced, the default action is prevented. If the user clicks a link with the middle/right mouse buttons, or is holding down the Ctrl or Command keys, this method's behavior is not applied and allows the native behavior to occur. Similarly, if the router is not capable or handling the URL because no route-handlers match, the link click will behave natively.

Parameters:

e EventFacade

`_onPjaxIOComplete`

(

id
ioResponse
details

)

protected

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:159

Available since 3.7.0

Handles IO complete events. This parses the content from the <code>Y.io()</code> response and puts it on the route's response object.

Parameters:

id String

The <code>Y.io</code> transaction id.
ioResponse Object

The <code>Y.io</code> response object.
details Object

Extra details carried through from <code>loadContent()</code>.

`_onPjaxIOEnd`

(

id
details

)

protected

Inherited from PjaxContent: yui3/src/pjax/js/pjax-content.js:189

Available since 3.5.0

Handles IO end events.

Parameters:

id String

The <code>Y.io</code> transaction id.
details Object

Extra details carried through from <code>loadContent()</code>.

`_parseQuery`

(

query

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1276

Parses a URL query string into a key/value hash. If <code>Y.QueryString.parse</code> is available, this method will be an alias to that.

Parameters:

query String

Query string to parse.

Returns:

Object:

Hash of key/value pairs for query parameters.

`_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)

`_pathHasRoot`

(

root
path

)

Boolean protected

Inherited from Router: yui3/src/app/js/router.js:1304

Available since 3.13.0

Returns <code>true</code> when the specified <code>path</code> is semantically within the specified <code>root</code> path. If the <code>root</code> does not end with a trailing slash ("/"), one will be added before the <code>path</code> is evaluated against the root path.

Parameters:

root String

Root path used to evaluate whether the specificed <code>path</code> is semantically within. A trailing slash ("/") will be added if it does not already end with one.
path String

Path to evaluate for containing the specified <code>root</code>.

Returns:

Boolean:

Whether or not the <code>path</code> is semantically within the <code>root</code> path.

Example:

<pre class="code prettyprint"><code>this._pathHasRoot('/app', '/app/foo'); // => true this._pathHasRoot('/app/', '/app/foo'); // => true this._pathHasRoot('/app/', '/app/'); // => true this._pathHasRoot('/app', '/foo/bar'); // => false this._pathHasRoot('/app/', '/foo/bar'); // => false this._pathHasRoot('/app/', '/app'); // => false this._pathHasRoot('/app', '/app'); // => false</code></pre>

`_pjaxBindUI`

() protected

Inherited from PjaxBase: yui3/src/pjax/js/pjax-base.js:270

Available since 3.5.0

Binds the delegation of link-click events that match the <code>linkSelector</code> to the <code>_onLinkClick()</code> handler. By default this method will only be called if the browser is capable of using HTML5 history.

`_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 <code>type</code> to <code>fullType</code> 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.

`_queue`

() protected chainable

Inherited from Router: yui3/src/app/js/router.js:1336

Queues up a <code>_save()</code> call to run after all previously-queued calls have finished. This is necessary because if we make multiple <code>_save()</code> calls before the first call gets dispatched, then both calls will dispatch to the last call's URL. All arguments passed to <code>_queue()</code> will be passed on to <code>_save()</code> when the queued function is executed.

`_resolvePath`

(

path

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1381

Available since 3.5.0

Returns the normalized result of resolving the <code>path</code> against the current path. Falsy values for <code>path</code> will return just the current path.

Parameters:

path String

URL path to resolve.

Returns:

String:

Resolved path.

`_resolveURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1403

Available since 3.5.0

Resolves the specified URL against the current URL. This method resolves URLs like a browser does and will always return an absolute URL. When the specified URL is already absolute, it is assumed to be fully resolved and is simply returned as is. Scheme-relative URLs are prefixed with the current protocol. Relative URLs are giving the current URL's origin and are resolved and normalized against the current path root.

Parameters:

url String

URL to resolve.

Returns:

String:

Resolved URL.

`_save`

(

[url]
[replace=false]

)

protected chainable

Inherited from Router: yui3/src/app/js/router.js:1454

Saves a history entry using either <code>pushState()</code> or the location hash. This method enforces the same-origin security constraint; attempting to save a <code>url</code> that is not from the same origin as the current URL will result in an error.

Parameters:

[url] String optional

URL for the history entry.
[replace=false] Boolean optional

If <code>true</code>, the current history entry will be replaced instead of a new one being added.

`_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.

`_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.

`_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:

true if the new attribute value was stored, false if not.

`_setParams`

(

params

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1518

Available since 3.12.0

Setter for the <code>params</code> attribute.

Parameters:

params Object

Map in the form: <code>name</code> -> RegExp | Function.

Returns:

Object:

The map of params: <code>name</code> -> RegExp | Function.

`_setRoutes`

(

routes

)

Object protected

Inherited from Router: yui3/src/app/js/router.js:1537

Setter for the <code>routes</code> attribute.

Parameters:

routes Object

Array of route objects.

Returns:

Object:

Array of route objects.

`_setStateVal`

(

name
value

)

private

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

Sets the stored value for the attribute, in either the internal state object, or the state proxy if it exits

Parameters:

name String

The name of the attribute
value Any

The value of the attribute

`_upgradeURL`

(

url

)

String protected

Inherited from Router: yui3/src/app/js/router.js:1555

Available since 3.5.0

Upgrades a hash-based URL to a full-path URL, if necessary. The specified <code>url</code> will be upgraded if its of the same origin as the current URL and has a path-like hash. URLs that don't need upgrading will be returned as-is.

Parameters:

url String

The URL to upgrade from hash-based to full-path.

Returns:

String:

The upgraded URL, or the specified URL untouched.

Example:

<pre class="code prettyprint"><code>app._upgradeURL('http://example.com/#/foo/'); // => 'http://example.com/foo/';</code></pre>

`addAttr`

(

name
config
lazy

)

Object chainable

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

Adds an attribute with the provided configuration to the host object. The config argument object supports the following properties: <dl> <dt>value <Any></dt> <dd>The initial value to set on the attribute</dd> <dt>valueFn <Function | String></dt> <dd> 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. </dd> <dt>readOnly <boolean></dt> <dd>Whether or not the attribute is read only. Attributes having readOnly set to true cannot be modified by invoking the set method.</dd> <dt>writeOnce <boolean> or <string></dt> <dd> Whether or not the attribute is "write once". Attributes having writeOnce set to true, can only have their values set once, be it through the default configuration, constructor configuration arguments, or by invoking set. The writeOnce attribute can also be set to the string "initOnly", in which case the attribute can only be set during initialization (when used with Base, this means it can only be set during construction) </dd> <dt>setter <Function | String></dt> <dd> 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 <a href="#property_Attribute.INVALID_VALUE">Attribute.INVALID_VALUE</a>, 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. </dd> <dt>getter <Function | String></dt> <dd> 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. </dd> <dt>validator <Function | String></dt> <dd> 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. </dd> <dt>lazyAdd <boolean></dt> <dd>Whether or not to delay initialization of the attribute until the first call to get/set it. This flag can be used to over-ride lazy initialization on a per attribute basis, when adding multiple attributes through the <a href="#method_addAttrs">addAttrs</a> method.</dd> </dl> The setter, getter and validator are invoked with the value and name passed in as the first and second arguments, and with the context ("this") set to the host object. Configuration properties outside of the list mentioned above are considered private properties used internally by attribute, and are not intended for public use.

Parameters:

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

Returns:

Object:

A reference to the host object.

`addAttrs`

(

cfgs
values
lazy

)

Object chainable

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

Configures a group of attributes, and sets initial values. NOTE: This method does not isolate the configuration object by merging/cloning. The caller is responsible for merging/cloning the configuration object if required.

Parameters:

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

Returns:

Object:

A reference to the host object.

`addTarget`

(

o

)

chainable

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

Registers another EventTarget as a bubble target. Bubble order is determined by the order registered. Multiple targets can be specified. Events can only bubble if emitFacade is true. Included in the event-custom-complex submodule.

Parameters:

o EventTarget

the target to add

`after`

(

type
fn
[context]
[arg*]

)

EventHandle

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

Subscribe to a custom event hosted by this object. The supplied callback will execute after any listeners add via the subscribe method, and after the default function, if configured for the event, has executed.

Parameters:

type String

The name of the event
fn Function

The callback to execute in response to the event
[context] Object optional

Override <code>this</code> object in callback
[arg*] Any optional

0..n additional arguments to supply to the subscriber

Returns:

EventHandle:

A subscription handle capable of detaching the subscription

`attrAdded`

(

name

)

Boolean

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

Checks if the given attribute has been added to the host

Parameters:

name String

<

APIs

Plugin.Pjax Class

Index

Methods

Properties

Attributes

Events

Methods

_addAttrs

Parameters:

_addLazyAttr

Parameters:

_addOutOfOrder

Parameters:

_afterHistoryChange

Parameters:

_aggregateAttrs

Parameters:

Returns:

_attrCfgHash

_baseDestroy

_baseInit

_cloneDefaultValue

Parameters:

_decode

Parameters:

Returns:

_defAttrChangeFn

Parameters:

_defaultRoute

Parameters:

_defCompleteFn

Parameters:

_defDestroyFn

Parameters:

_defInitFn

Parameters:

_defNavigateFn

Parameters:

_defReadyFn

Parameters:

_dequeue

_destroyHierarchy

_dispatch

Parameters:

_filterAdHocAttrs

Parameters:

Returns:

_fireAttrChange

Parameters:

_getAttr

Parameters:

Returns:

_getAttrCfg

Parameters:

Returns:

_getAttrCfgs

Returns:

_getAttrInitVal

Parameters:

Returns:

_getAttrs

Parameters:

Returns:

_getClasses

Returns:

_getFullType

Parameters:

Returns:

_getHashPath

Parameters:

Returns:

_getInstanceAttrCfgs

Parameters:

Returns:

_getOrigin

Returns:

Example:

_getParams

Returns:

`_addAttrs`

`_addLazyAttr`

`_addOutOfOrder`

`_afterHistoryChange`

`_aggregateAttrs`

`_attrCfgHash`

`_baseDestroy`

`_baseInit`

`_cloneDefaultValue`

`_decode`

`_defAttrChangeFn`

`_defaultRoute`

`_defCompleteFn`

`_defDestroyFn`

`_defInitFn`

`_defNavigateFn`

`_defReadyFn`

`_dequeue`

`_destroyHierarchy`

`_dispatch`

`_filterAdHocAttrs`

`_fireAttrChange`

`_getAttr`

`_getAttrCfg`

`_getAttrCfgs`

`_getAttrInitVal`

`_getAttrs`

`_getClasses`

`_getFullType`

`_getHashPath`

`_getInstanceAttrCfgs`

`_getOrigin`

`_getParams`

`_getParamValues`

`_getPath`

`_getPathRoot`

`_getQuery`

`_getRegex`

`_getRequest`

`_getResponse`

`_getRoutes`

`_getStateVal`

`_getType`

`_getURL`

`_hasPotentialSubscribers`

`_hasSameOrigin`

`_initAttrHost`

`_initAttribute`

`_initAttrs`

`_initBase`

`_initHierarchy`

`_initHierarchyData`

`_isLazyAttr`

`_isLinkSameOrigin`

`_joinURL`

`_monitor`

`_navigate`

`_normalizePath`

`_normAttrVals`

`_onLinkClick`

`_onPjaxIOComplete`

`_onPjaxIOEnd`