mirror of
https://github.com/Mibew/CanteenHTML5.git
synced 2025-10-31 18:31:05 +03:00
2069 lines
45 KiB
HTML
2069 lines
45 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0/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="shortcut icon" type="image/png" href="../assets/favicon.png">
|
|
<script src="http://yui.yahooapis.com/3.10.1/build/yui/yui-min.js"></script>
|
|
<title>Canteen HTML5 API v1.0.0 API Documentation : Node</title>
|
|
</head>
|
|
<body class="yui3-skin-sam">
|
|
|
|
<div id="doc">
|
|
<div id="hd" class="yui3-g header">
|
|
<div class="yui3-u-3-4">
|
|
|
|
<h1><a href=""><img src="../assets/css/logo.png" title="Canteen HTML5 API"></a></h1>
|
|
|
|
</div>
|
|
<div class="yui3-u-1-4 version">
|
|
<em>API Documentation for: 1.0.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">
|
|
<div id="api-tabview-filter">
|
|
<input type="search" id="api-filter" placeholder="Type to filter APIs">
|
|
</div>
|
|
<ul class="tabs">
|
|
<li><a href="#api-classes">Classes</a></li>
|
|
<li><a href="#api-modules">Namespaces</a></li>
|
|
</ul>
|
|
<div id="api-tabview-panel">
|
|
<ul id="api-classes" class="apis classes">
|
|
|
|
<li><a href="../classes/Attribute.html">Attribute</a></li>
|
|
|
|
<li><a href="../classes/Comment.html">Comment</a></li>
|
|
|
|
<li><a href="../classes/Document.html">Document</a></li>
|
|
|
|
<li><a href="../classes/html.html">html</a></li>
|
|
|
|
<li><a href="../classes/HTML5Error.html">HTML5Error</a></li>
|
|
|
|
<li><a href="../classes/Node.html">Node</a></li>
|
|
|
|
<li><a href="../classes/NodeContainer.html">NodeContainer</a></li>
|
|
|
|
<li><a href="../classes/SimpleList.html">SimpleList</a></li>
|
|
|
|
<li><a href="../classes/Table.html">Table</a></li>
|
|
|
|
<li><a href="../classes/Text.html">Text</a></li>
|
|
|
|
</ul>
|
|
|
|
<ul id="api-modules" class="apis modules">
|
|
|
|
<li><a href="../modules/Canteen_HTML5.html">Canteen\HTML5</a></li>
|
|
|
|
<li><a href="../modules/global.html">global</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>Node Class</h1>
|
|
<div class="box meta">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Namespace: <a href="../modules/Canteen\HTML5.html">Canteen\HTML5</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="box intro">
|
|
<p>A generic html tag with any children or closing tag. (e.g., img, br, hr).
|
|
Do not initiate this class directly, use the <code>html()</code> function:</p>
|
|
<pre class="code prettyprint"><code>echo html('br');</code></pre>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="constructor">
|
|
<h2>Constructor</h2>
|
|
<div id="method_Node" class="method item">
|
|
<h3 class="name"><code>Node</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[tag=null]</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[attributes=null]</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[validAttrs=null]</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[tag=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the tag</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[attributes=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The collection of tag attributes</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[validAttrs=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The list of non-global valid attributes for the tag, comma separated</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>
|
|
|
|
|
|
|
|
</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">
|
|
|
|
<li class="index-item method">
|
|
<a href="#method___get">__get</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method___isset">__isset</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method___set">__set</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method___toString">__toString</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_appendTo">appendTo</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_getAttribute">getAttribute</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_getData">getData</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method private">
|
|
<a href="#method_getParent">getParent</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method protected">
|
|
<a href="#method_isEmpty">isEmpty</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_prependTo">prependTo</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_setAttribute">setAttribute</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_setAttributes">setAttributes</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method protected">
|
|
<a href="#method_setParent">setParent</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method protected">
|
|
<a href="#method_writeOpen">writeOpen</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="index-section properties">
|
|
<h3>Properties</h3>
|
|
|
|
<ul class="index-list properties">
|
|
|
|
<li class="index-item property protected">
|
|
<a href="#property__attributes">_attributes</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property protected">
|
|
<a href="#property__parent">_parent</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property protected">
|
|
<a href="#property__tag">_tag</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property protected">
|
|
<a href="#property__validAttrs">_validAttrs</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property">
|
|
<a href="#property_GLOBAL_ATTRS">GLOBAL_ATTRS</a>
|
|
|
|
|
|
<span class="flag static">static</span>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="methods" class="api-class-tabpanel">
|
|
<h2 class="off-left">Methods</h2>
|
|
|
|
|
|
<div id="method___get" class="method item">
|
|
<h3 class="name"><code>__get</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>name</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>General purpose getter to get attribute values</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the property to set</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method___isset" class="method item">
|
|
<h3 class="name"><code>__isset</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>name</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>See if a property exists</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the attribute</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method___set" class="method item">
|
|
<h3 class="name"><code>__set</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>value</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>General purpose setter to set attribute values</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the attribute</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">value</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>The value of the attribute</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method___toString" class="method item">
|
|
<h3 class="name"><code>__toString</code></h3>
|
|
|
|
|
|
<span class="paren">()</span>
|
|
|
|
|
|
|
|
<span class="returns-inline">
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Write to HTML</p>
|
|
|
|
</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/String" class="crosslink external" target="_blank">String</a></span>:
|
|
|
|
<p>The string representation of this HTML node</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_appendTo" class="method item">
|
|
<h3 class="name"><code>appendTo</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>container</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
<span class="returns-inline">
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Add this child to a node container at the end</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">container</code>
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The node container to add to</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="returns">
|
|
<h4>Returns:</h4>
|
|
|
|
<div class="returns-description">
|
|
|
|
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
|
|
|
|
<p>The instance of this Node</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_getAttribute" class="method item">
|
|
<h3 class="name"><code>getAttribute</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[name=null]</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Fetch and attribute by name from this Node. The attribute
|
|
name cannot be null; if so, this function will throw an
|
|
Exception.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[name=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the attribute to fetch</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/String" class="crosslink external" target="_blank">String</a></span>:
|
|
|
|
<p>The attribute's value, if any or null</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_getData" class="method item">
|
|
<h3 class="name"><code>getData</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>name</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Get the data-* HTML5 attribute value, if set</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the data attribute</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/String" class="crosslink external" target="_blank">String</a></span>:
|
|
|
|
<p>The value of the data</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_getParent" class="method item private">
|
|
<h3 class="name"><code>getParent</code></h3>
|
|
|
|
|
|
<span class="paren">()</span>
|
|
|
|
|
|
|
|
<span class="returns-inline">
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="flag private">private</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Returns the parent node of this node, if
|
|
a parent exists. If no parent exists,
|
|
this function returns null.</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="returns">
|
|
<h4>Returns:</h4>
|
|
|
|
<div class="returns-description">
|
|
|
|
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>:
|
|
|
|
<p>The parent node object</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_isEmpty" class="method item protected">
|
|
<h3 class="name"><code>isEmpty</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>var</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Checks if a variable is really "empty". Code borrowed from PHP.net at
|
|
<a href="http://us3.php.net/manual/en/function.empty.php#90767">http://us3.php.net/manual/en/function.empty.php#90767</a> because we were
|
|
previously using empty() to see if a variable is empty or not. But
|
|
empty() dosen't work for attributes that have a value of "0", so we need
|
|
something more robust here.</p>
|
|
<ul>
|
|
<li>an unset variable -> empty</li>
|
|
<li>null -> empty</li>
|
|
<li>0 -> NOT empty</li>
|
|
<li>"0" -> NOT empty</li>
|
|
<li>false -> empty</li>
|
|
<li>true -> NOT empty</li>
|
|
<li>'string value' -> NOT empty</li>
|
|
<li>" "(white space) -> empty</li>
|
|
<li>array()(empty array) -> empty</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">var</code>
|
|
<span class="type">Mixed</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The variable to check for empty on</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_prependTo" class="method item">
|
|
<h3 class="name"><code>prependTo</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>container</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
<span class="returns-inline">
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Add this child to the beginning of a node container</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">container</code>
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The node container to prepend to to</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="returns">
|
|
<h4>Returns:</h4>
|
|
|
|
<div class="returns-description">
|
|
|
|
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
|
|
|
|
<p>The instance of this Node</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setAttribute" class="method item">
|
|
<h3 class="name"><code>setAttribute</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[name=null]</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[value=null]</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code>The</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Given a name and value pair, sets an attribute on this Node.
|
|
The name and value cannot be empty; if so, this function
|
|
will throw an Exception. Note if the attribute already exists
|
|
and the caller wants to set an attribute of the same name,
|
|
this function will not create a new Attribute, but rather
|
|
update the value of the existing named attribute.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[name=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The name of the attribute to add</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[value=null]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The value of the attribute</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">The</code>
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>instance of this node</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setAttributes" class="method item">
|
|
<h3 class="name"><code>setAttributes</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>values</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
<span class="returns-inline">
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Set the list of all attributes.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">values</code>
|
|
<span class="type">Dictionary</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>An attributes array(name=>value, name=>value)</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="returns">
|
|
<h4>Returns:</h4>
|
|
|
|
<div class="returns-description">
|
|
|
|
|
|
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a></span>:
|
|
|
|
<p>The instance of this Node</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setParent" class="method item protected">
|
|
<h3 class="name"><code>setParent</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[parent=null]</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Sets the parent of this Node. Note that this
|
|
function is protected and can only be called by
|
|
classes that extend Node. The parent cannot
|
|
be null; this function will throw an Exception
|
|
if the parent node is empty.</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[parent=null]</code>
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The parent container node</p>
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_writeOpen" class="method item protected">
|
|
<h3 class="name"><code>writeOpen</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[selfClose=true]</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/String" class="crosslink external" target="_blank">String</a></span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Start the writing the tag</p>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[selfClose=true]</code>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>If the tag is a self closing tag (e.g., br, img, hr)</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/String" class="crosslink external" target="_blank">String</a></span>:
|
|
|
|
<p>The buffer of HTML</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="properties" class="api-class-tabpanel">
|
|
<h2 class="off-left">Properties</h2>
|
|
|
|
|
|
<div id="property__attributes" class="property item protected">
|
|
<h3 class="name"><code>_attributes</code></h3>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The collection of Attributes objects</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property__parent" class="property item protected">
|
|
<h3 class="name"><code>_parent</code></h3>
|
|
<span class="type"><a href="../classes/NodeContainer.html" class="crosslink">NodeContainer</a></span>
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The parent node, if any</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property__tag" class="property item protected">
|
|
<h3 class="name"><code>_tag</code></h3>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The string name of the tag</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property__validAttrs" class="property item protected">
|
|
<h3 class="name"><code>_validAttrs</code></h3>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
|
|
|
|
|
|
|
|
|
|
<span class="flag protected">protected</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The collection of valid attributes names for given tag</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_GLOBAL_ATTRS" class="property item">
|
|
<h3 class="name"><code>GLOBAL_ATTRS</code></h3>
|
|
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="flag final">final</span>
|
|
|
|
|
|
|
|
<span class="flag static">static</span>
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The default valid attributes</p>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="../assets/vendor/prettify/prettify-min.js"></script>
|
|
<script>prettyPrint();</script>
|
|
<script src="../assets/js/yui-prettify.js"></script>
|
|
<script src="../assets/../api.js"></script>
|
|
<script src="../assets/js/api-filter.js"></script>
|
|
<script src="../assets/js/api-list.js"></script>
|
|
<script src="../assets/js/api-search.js"></script>
|
|
<script src="../assets/js/apidocs.js"></script>
|
|
</body>
|
|
</html> |