yuidoc-asp

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>DocParser - yuidoc-root</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title="yuidoc-root" width="117" height="52"></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: 0.6.0</em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/CLI.html">CLI</a></li> <li><a href="../classes/DocBuilder.html">DocBuilder</a></li> <li><a href="../classes/DocParser.html">DocParser</a></li> <li><a href="../classes/DocView.html">DocView</a></li> <li><a href="../classes/Files.html">Files</a></li> <li><a href="../classes/Help.html">Help</a></li> <li><a href="../classes/Main.html">Main</a></li> <li><a href="../classes/Options.html">Options</a></li> <li><a href="../classes/Server.html">Server</a></li> <li><a href="../classes/Utils.html">Utils</a></li> <li><a href="../classes/YUIDoc.html">YUIDoc</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/yuidoc.html">yuidoc</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>DocParser Class</h1> <div class="box meta"> <div class="extends"> Extends <a href="http://yuilibrary.com/yui/docs/api/classes/Base.html" class="crosslink external" target="_blank">Base</a> </div> <div class="foundat"> Defined in: <a href="../files/lib_docparser.js.html#l749"><code>lib/docparser.js:749</code></a> </div> Module: <a href="../modules/yuidoc.html">yuidoc</a> </div> <div class="box intro"> <p>The doc parser accepts a <strong>map</strong> of files to file content. Once <code>parse()</code> is called, various properties will be populated with the parsers data (aggregated in the <code>'data'</code> property).</p> </div> <div class="constructor"> <h2>Constructor</h2> <div id="method_DocParser" class="method item"> <h3 class="name"><code>DocParser</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>o</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/lib_docparser.js.html#l749"><code>lib/docparser.js:749</code></a> </p> </div> <div class="description"> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">o</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>the config object</p> </div> </li> </ul> </div> </div> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> <li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li> <li class="api-class-tab events"><a href="#events">Events</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods extends"> <li class="index-item method private inherited"> <a href="#method__addAttrs">_addAttrs</a> </li> <li class="index-item method private inherited"> <a href="#method__addLazyAttr">_addLazyAttr</a> </li> <li class="index-item method private inherited"> <a href="#method__addOutOfOrder">_addOutOfOrder</a> </li> <li class="index-item method private inherited"> <a href="#method__aggregateAttrs">_aggregateAttrs</a> </li> <li class="index-item method private inherited"> <a href="#method__attrCfgHash">_attrCfgHash</a> </li> <li class="index-item method private inherited"> <a href="#method__baseDestroy">_baseDestroy</a> </li> <li class="index-item method private inherited"> <a href="#method__baseInit">_baseInit</a> </li> <li class="index-item method private inherited"> <a href="#method__cloneDefaultValue">_cloneDefaultValue</a> </li> <li class="index-item method private inherited"> <a href="#method__defAttrChangeFn">_defAttrChangeFn</a> </li> <li class="index-item method protected inherited"> <a href="#method__defDestroyFn">_defDestroyFn</a> </li> <li class="index-item method protected inherited"> <a href="#method__defInitFn">_defInitFn</a> </li> <li class="index-item method private inherited"> <a href="#method__destroyHierarchy">_destroyHierarchy</a> </li> <li class="index-item method private inherited"> <a href="#method__filterAdHocAttrs">_filterAdHocAttrs</a> </li> <li class="index-item method private inherited"> <a href="#method__fireAttrChange">_fireAttrChange</a> </li> <li class="index-item method protected inherited"> <a href="#method__getAttr">_getAttr</a> </li> <li class="index-item method protected inherited"> <a href="#method__getAttrCfg">_getAttrCfg</a> </li> <li class="index-item method protected inherited"> <a href="#method__getAttrCfgs">_getAttrCfgs</a> </li> <li class="index-item method private inherited"> <a href="#method__getAttrInitVal">_getAttrInitVal</a> </li> <li class="index-item method protected inherited"> <a href="#method__getAttrs">_getAttrs</a> </li> <li class="index-item method protected inherited"> <a href="#method__getClasses">_getClasses</a> </li> <li class="index-item method private inherited"> <a href="#method__getFullType">_getFullType</a> </li> <li class="index-item method private inherited"> <a href="#method__getInstanceAttrCfgs">_getInstanceAttrCfgs</a> </li> <li class="index-item method private inherited"> <a href="#method__getStateVal">_getStateVal</a> </li> <li class="index-item method private inherited"> <a href="#method__getType">_getType</a> </li> <li class="index-item method private inherited"> <a href="#method__hasPotentialSubscribers">_hasPotentialSubscribers</a> </li> <li class="index-item method private inherited"> <a href="#method__initAttrHost">_initAttrHost</a> </li> <li class="index-item method private inherited inherited"> <a href="#method__initAttribute">_initAttribute</a> </li> <li class="index-item method protected inherited"> <a href="#method__initAttrs">_initAttrs</a> </li> <li class="index-item method private inherited"> <a href="#method__initBase">_initBase</a> </li> <li class="index-item method private inherited"> <a href="#method__initHierarchy">_initHierarchy</a> </li> <li class="index-item method private inherited"> <a href="#method__initHierarchyData">_initHierarchyData</a> </li> <li class="index-item method private inherited"> <a href="#method__isLazyAttr">_isLazyAttr</a> </li> <li class="index-item method private inherited"> <a href="#method__monitor">_monitor</a> </li> <li class="index-item method private inherited"> <a href="#method__normAttrVals">_normAttrVals</a> </li> <li class="index-item method private inherited"> <a href="#method__parseType">_parseType</a> </li> <li class="index-item method private inherited"> <a href="#method__preInitEventCfg">_preInitEventCfg</a> </li> <li class="index-item method protected deprecated inherited"> <a href="#method__protectAttrs">_protectAttrs</a> <span class="flag deprecated">deprecated</span> </li> <li class="index-item method private inherited"> <a href="#method__publish">_publish</a> </li> <li class="index-item method private"> <a href="#method__resolveFor">_resolveFor</a> </li> <li class="index-item method protected inherited inherited"> <a href="#method__set">_set</a> </li> <li class="index-item method protected inherited"> <a href="#method__setAttr">_setAttr</a> </li> <li class="index-item method protected inherited inherited"> <a href="#method__setAttrs">_setAttrs</a> </li> <li class="index-item method private inherited"> <a href="#method__setAttrVal">_setAttrVal</a> </li> <li class="index-item method private inherited"> <a href="#method__setStateVal">_setStateVal</a> </li> <li class="index-item method inherited"> <a href="#method_addAttr">addAttr</a> </li> <li class="index-item method inherited"> <a href="#method_addAttrs">addAttrs</a> </li> <li class="index-item method inherited"> <a href="#method_addTarget">addTarget</a> </li> <li class="index-item method inherited"> <a href="#method_after">after</a> </li> <li class="index-item method inherited"> <a href="#method_attrAdded">attrAdded</a> </li> <li class="index-item method inherited"> <a href="#method_before">before</a> </li> <li class="index-item method inherited"> <a href="#method_bubble">bubble</a> </li> <li class="index-item method inherited inherited"> <a href="#method_destroy">destroy</a> </li> <li class="index-item method inherited"> <a href="#method_detach">detach</a> </li> <li class="index-item method inherited"> <a href="#method_detachAll">detachAll</a> </li> <li class="index-item method"> <a href="#method_extract">extract</a> </li> <li class="index-item method inherited"> <a href="#method_fire">fire</a> </li> <li class="index-item method inherited"> <a href="#method_get">get</a> </li> <li class="index-item method inherited"> <a href="#method_getAttrs">getAttrs</a> </li> <li class="index-item method inherited"> <a href="#method_getEvent">getEvent</a> </li> <li class="index-item method inherited"> <a href="#method_getTargets">getTargets</a> </li> <li class="index-item method"> <a href="#method_handlecomment">handlecomment</a> </li> <li class="index-item method private"> <a href="#method_implodeString">implodeString</a> </li> <li class="index-item method private"> <a href="#method_implodeString">implodeString</a> </li> <li class="index-item method inherited inherited"> <a href="#method_init">init</a> </li> <li class="index-item method inherited"> <a href="#method_modifyAttr">modifyAttr</a> </li> <li class="index-item method inherited"> <a href="#method_on">on</a> </li> <li class="index-item method inherited"> <a href="#method_once">once</a> </li> <li class="index-item method inherited"> <a href="#method_onceAfter">onceAfter</a> </li> <li class="index-item method"> <a href="#method_parse">parse</a> </li> <li class="index-item method inherited"> <a href="#method_parseType">parseType</a> </li> <li class="index-item method"> <a href="#method_processblock">processblock</a> </li> <li class="index-item method inherited"> <a href="#method_publish">publish</a> </li> <li class="index-item method inherited"> <a href="#method_removeAttr">removeAttr</a> </li> <li class="index-item method inherited"> <a href="#method_removeTarget">removeTarget</a> </li> <li class="index-item method inherited"> <a href="#method_reset">reset</a> </li> <li class="index-item method inherited inherited"> <a href="#method_set">set</a> </li> <li class="index-item method inherited inherited"> <a href="#method_setAttrs">setAttrs</a> </li> <li class="index-item method private"> <a href="#method_stringlog">stringlog</a> </li> <li class="index-item method deprecated inherited"> <a href="#method_subscribe">subscribe</a> <span class="flag deprecated">deprecated</span> </li> <li class="index-item method inherited"> <a href="#method_toString">toString</a> </li> <li class="index-item method"> <a href="#method_transform">transform</a> </li> <li class="index-item method private"> <a href="#method_unindent">unindent</a> </li> <li class="index-item method deprecated inherited"> <a href="#method_unsubscribe">unsubscribe</a> <span class="flag deprecated">deprecated</span> </li> <li class="index-item method deprecated inherited"> <a href="#method_unsubscribeAll">unsubscribeAll</a> <span class="flag deprecated">deprecated</span> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties extends"> <li class="index-item property protected inherited"> <a href="#property__allowAdHocAttrs">_allowAdHocAttrs</a> </li> <li class="index-item property"> <a href="#property_CORRECTIONS">CORRECTIONS</a> </li> <li class="index-item property"> <a href="#property_DIGESTERS">DIGESTERS</a> </li> <li class="index-item property"> <a href="#property_IGNORE_TAGLIST">IGNORE_TAGLIST</a> </li> <li class="index-item property deprecated inherited"> <a href="#property_name">name</a> <span class="flag deprecated">deprecated</span> </li> <li class="index-item property"> <a href="#property_TAGLIST">TAGLIST</a> </li> </ul> </div> <div class="index-section attrs"> <h3>Attributes</h3> <ul class="index-list attrs extends"> <li class="index-item attr"> <a href="#attr_currentclass">currentclass</a> </li> <li class="index-item attr"> <a href="#attr_currentfile">currentfile</a> </li> <li class="index-item attr"> <a href="#attr_currentmodule">currentmodule</a> </li> <li class="index-item attr"> <a href="#attr_currentsubmodule">currentsubmodule</a> </li> <li class="index-item attr inherited"> <a href="#attr_destroyed">destroyed</a> </li> <li class="index-item attr"> <a href="#attr_digesters">digesters</a> </li> <li class="index-item attr"> <a href="#attr_dirmap">dirmap</a> </li> <li class="index-item attr"> <a href="#attr_emitters">emitters</a> </li> <li class="index-item attr"> <a href="#attr_filemap">filemap</a> </li> <li class="index-item attr inherited"> <a href="#attr_initialized">initialized</a> </li> <li class="index-item attr"> <a href="#attr_mainmodule">mainmodule</a> </li> <li class="index-item attr"> <a href="#attr_syntaxtype">syntaxtype</a> </li> </ul> </div> <div class="index-section events"> <h3>Events</h3> <ul class="index-list events extends"> <li class="index-item event inherited"> <a href="#event_destroy">destroy</a> </li> <li class="index-item event inherited"> <a href="#event_init">init</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method__addAttrs" class="method item private inherited"> <h3 class="name"><code>_addAttrs</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>cfgs</code> </li> <li class="arg"> <code>values</code> </li> <li class="arg"> <code>lazy</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addAttrs">AttributeCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l854"><code>attribute/js/AttributeCore.js:854</code></a> </p> </div> <div class="description"> <p>Implementation behind the public addAttrs method.</p> <p>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).</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">cfgs</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>An object with attribute name/configuration pairs.</p> </div> </li> <li class="param"> <code class="param-name">values</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>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.</p> </div> </li> <li class="param"> <code class="param-name">lazy</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> <div class="param-description"> <p>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>.</p> </div> </li> </ul> </div> </div> <div id="method__addLazyAttr" class="method item private inherited"> <h3 class="name"><code>_addLazyAttr</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>name</code> </li> <li class="arg"> <code class="optional">[lazyCfg]</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addLazyAttr">AttributeCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l360"><code>attribute/js/AttributeCore.js:360</code></a> </p> </div> <div class="description"> <p>Finishes initializing an attribute which has been lazily added.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">name</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>The name of the attribute</p> </div> </li> <li class="param"> <code class="param-name optional">[lazyCfg]</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>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.</p> </div> </li> </ul> </div> </div> <div id="method__addOutOfOrder" class="method item private inherited"> <h3 class="name"><code>_addOutOfOrder</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>name</code> </li> <li class="arg"> <code>cfg</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeCore.html#method__addOutOfOrder">AttributeCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeCore.js.html#l527"><code>attribute/js/AttributeCore.js:527</code></a> </p> </div> <div class="description"> <p>Utility method used by get/set to add attributes encountered out of order when calling addAttrs().</p> <p>For example, if:</p> <pre class="code prettyprint"><code>this.addAttrs({ foo: { setter: function() { // make sure this bar is available when foo is added this.get("bar"); } }, bar: { value: ... } });</code></pre> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">name</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>attribute name</p> </div> </li> <li class="param"> <code class="param-name">cfg</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>attribute configuration</p> </div> </li> </ul> </div> </div> <div id="method__aggregateAttrs" class="method item private inherited"> <h3 class="name"><code>_aggregateAttrs</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>allAttrs</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> </span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__aggregateAttrs">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l618"><code>base/js/BaseCore.js:618</code></a> </p> </div> <div class="description"> <p>A helper method, used by _initHierarchyData to aggregate attribute configuration across the instances class hierarchy.</p> <p>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).</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">allAttrs</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span> <div class="param-description"> <p>An array of ATTRS definitions across classes in the hierarchy (subclass first, Base last)</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>: <p>The aggregate set of ATTRS definitions for the instance</p> </div> </div> </div> <div id="method__attrCfgHash" class="method item private inherited"> <h3 class="name"><code>_attrCfgHash</code></h3> <span class="paren">()</span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__attrCfgHash">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l581"><code>base/js/BaseCore.js:581</code></a> </p> </div> <div class="description"> <p>Utility method to define the attribute hash used to filter/whitelist property mixes for this class for iteration performance reasons.</p> </div> </div> <div id="method__baseDestroy" class="method item private inherited"> <h3 class="name"><code>_baseDestroy</code></h3> <span class="paren">()</span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__baseDestroy">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l364"><code>base/js/BaseCore.js:364</code></a> </p> </div> <div class="description"> <p>Internal destroy implementation for BaseCore</p> </div> </div> <div id="method__baseInit" class="method item private inherited"> <h3 class="name"><code>_baseInit</code></h3> <span class="paren">()</span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__baseInit">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l336"><code>base/js/BaseCore.js:336</code></a> </p> </div> <div class="description"> <p>Internal initialization implementation for BaseCore</p> </div> </div> <div id="method__cloneDefaultValue" class="method item private inherited"> <h3 class="name"><code>_cloneDefaultValue</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>cfg</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__cloneDefaultValue">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l592"><code>base/js/BaseCore.js:592</code></a> </p> </div> <div class="description"> <p>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.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">cfg</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method__defAttrChangeFn" class="method item private inherited"> <h3 class="name"><code>_defAttrChangeFn</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>e</code> </li> <li class="arg"> <code>eventFastPath</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/AttributeObservable.html#method__defAttrChangeFn">AttributeObservable</a>: <a href="http://yuilibrary.com/yui/docs/api/files/attribute_js_AttributeObservable.js.html#l185"><code>attribute/js/AttributeObservable.js:185</code></a> </p> </div> <div class="description"> <p>Default function for attribute change events.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">e</code> <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span> <div class="param-description"> <p>The event object for attribute change events.</p> </div> </li> <li class="param"> <code class="param-name">eventFastPath</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span> <div class="param-description"> <p>Whether or not we're using this as a fast path in the case of no listeners or not</p> </div> </li> </ul> </div> </div> <div id="method__defDestroyFn" class="method item protected inherited"> <h3 class="name"><code>_defDestroyFn</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>e</code> </li> </ul><span class="paren">)</span> </div> <span class="flag protected">protected</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__defDestroyFn">BaseObservable</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l202"><code>base/js/BaseObservable.js:202</code></a> </p> </div> <div class="description"> <p>Default destroy event handler</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">e</code> <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span> <div class="param-description"> <p>Event object</p> </div> </li> </ul> </div> </div> <div id="method__defInitFn" class="method item protected inherited"> <h3 class="name"><code>_defInitFn</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>e</code> </li> </ul><span class="paren">)</span> </div> <span class="flag protected">protected</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseObservable.html#method__defInitFn">BaseObservable</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseObservable.js.html#l190"><code>base/js/BaseObservable.js:190</code></a> </p> </div> <div class="description"> <p>Default init event handler</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">e</code> <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/EventFacade.html" class="crosslink external" target="_blank">EventFacade</a></span> <div class="param-description"> <p>Event object, with a cfg property which refers to the configuration object passed to the constructor.</p> </div> </li> </ul> </div> </div> <div id="method__destroyHierarchy" class="method item private inherited"> <h3 class="name"><code>_destroyHierarchy</code></h3> <span class="paren">()</span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__destroyHierarchy">BaseCore</a>: <a href="http://yuilibrary.com/yui/docs/api/files/base_js_BaseCore.js.html#l782"><code>base/js/BaseCore.js:782</code></a> </p> </div> <div class="description"> <p>Destroys the class hierarchy for this instance by invoking the destructor method on the prototype of each class in the hierarchy.</p> </div> </div> <div id="method__filterAdHocAttrs" class="method item private inherited"> <h3 class="name"><code>_filterAdHocAttrs</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>allAttrs</code> </li> <li class="arg"> <code>userVals</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> </span> <span class="flag private">private</span> <div class="meta"> <p>Inherited from <a href="http://yuilibrary.com/yui/docs/api/classes/BaseCore.html#method__filterAdHocAttrs">BaseCore</a>: <a href="http://yui