aviat/kis-js
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
b13b012a25
kis-js/docs/symbols/$_.dom.html

686 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - $_.dom</title>
<script type="text/javascript" src="../jproton.js"></script>
<script type="text/javascript" src="../ui.js"></script>
<script type="text/javascript" src="../sh.js"></script>
<link rel=stylesheet href="../sh.css" type="text/css">
<link rel=stylesheet href="../default.css" type="text/css">
</head>
<body>
<div id="main-wrapper">
<div id="main">
<!-- ============================== classes index ============================ -->
<div id="index" class="fixed">
<div id="index-wrapper">
<div class="header">
<div id="index-close" title="Esconde o outline.">&nbsp;</div>
<div id="index-title">Project Outline</div>
</div>
<div id="index-menu"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<div id="index-content">
<div class="classList">
<div class="section">
<div title='$_ Constructor function' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><a href="../symbols/%24_.html">$_</a></span></div><div class='sectionItems'><div class='sectionItem classProperty'><b class='icon' title='DOM Dom manipulation module'><a href="../symbols/%24_.dom.html">dom</a></b></div><div class='sectionItem classProperty'><b class='icon' title='Wrapper for localstorage / sessionstorage data serialization'><a href="../symbols/%24_.store.html">store</a></b></div><div class='sectionItem classProperty'><b class='icon' title='String and object manipulation utilities'><a href="../symbols/%24_.util.html">util</a></b></div><div class='sectionItem classProperty'><b class='icon' title=''><a href="../symbols/%24_.event.html">event</a></b></div><div class='sectionItem classMethod'><b class='icon' title='$ Simple DOM selector function'><a href="../symbols/%24_.html#.$">$</a></b><span class='signature'>(<span title="selector">string</span>, <span title="context">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Adds the property `obj` to the $_ object, calling it `name`'><a href="../symbols/%24_.html#.ext">ext</a></b><span class='signature'>(<span title="name">string</span>, <span title="obj">object</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Iterates over a $_ object, applying a callback to each item'><a href="../symbols/%24_.html#.each">each</a></b><span class='signature'>(<span title="callback">function</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Retrieves the type of the passed variable'><a href="../symbols/%24_.html#.type">type</a></b><span class='signature'>(<span title="obj">mixed</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sends a GET type ajax request'><a href="../symbols/%24_.html#.get">get</a></b><span class='signature'>(<span title="url">string</span>, <span title="data">object</span>, <span title="callback">function</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sends a POST type ajax request'><a href="../symbols/%24_.html#.post">post</a></b><span class='signature'>(<span title="url">string</span>, <span title="data">object</span>, <span title="callback">function</span>)</span></div></div></div>
<div class="section">
<div title='DOM Dom manipulation module' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><a href="../symbols/%24_.dom.html">$_.dom</a></span></div><div class='sectionItems'><div class='sectionItem classMethod'><b class='icon' title='Adds a class to the element(s) specified by the current selector'><a href="../symbols/%24_.dom.html#.addClass">addClass</a></b><span class='signature'>(<span title="class">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Removes a class from the element(s) specified by the current selector'><a href="../symbols/%24_.dom.html#.removeClass">removeClass</a></b><span class='signature'>(<span title="class">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Hides the element(s) specified by the current selector'><a href="../symbols/%24_.dom.html#.hide">hide</a></b><span class='signature'>()</span></div><div class='sectionItem classMethod'><b class='icon' title='Shows the element(s) specified by the current selector.'><a href="../symbols/%24_.dom.html#.show">show</a></b><span class='signature'>(<span title="type">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector.'><a href="../symbols/%24_.dom.html#.attr">attr</a></b><span class='signature'>(<span title="name">string</span>, <span title="value">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sets or retrieves the text content of the element specified by the current selector.'><a href="../symbols/%24_.dom.html#.text">text</a></b><span class='signature'>(<span title="value">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sets or retrieves a css property of the element specified by the current selector.'><a href="../symbols/%24_.dom.html#.css">css</a></b><span class='signature'>(<span title="property">string</span>, <span title="value">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Sets or gets the innerHTML propery of the element(s) passed'><a href="../symbols/%24_.dom.html#.html">html</a></b><span class='signature'>(<span title="htm">string</span>)</span></div></div></div>
<div class="section">
<div title='' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><a href="../symbols/%24_.event.html">$_.event</a></span></div><div class='sectionItems'><div class='sectionItem classMethod'><b class='icon' title='Adds an event that returns a callback when triggered on the selected event and selector'><a href="../symbols/%24_.event.html#.add">add</a></b><span class='signature'>(<span title="event">string</span>, <span title="callback">function</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Removes an event bound the the specified selector, event type, and callback'><a href="../symbols/%24_.event.html#.remove">remove</a></b><span class='signature'>(<span title="event">string</span>, <span title="callback">string</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Binds a persistent, delegated event'><a href="../symbols/%24_.event.html#.live">live</a></b><span class='signature'>(<span title="target">string</span>, <span title="event">string</span>, <span title="callback">function</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Binds an event to a parent object'><a href="../symbols/%24_.event.html#.delegate">delegate</a></b><span class='signature'>(<span title="target">string</span>, <span title="event_type">string</span>)</span></div></div></div>
<div class="section">
<div title='Wrapper for localstorage / sessionstorage data serialization' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><a href="../symbols/%24_.store.html">$_.store</a></span></div><div class='sectionItems'><div class='sectionItem classMethod'><b class='icon' title='Retrieves and deserializes a value from localstorage, based on the specified key'><a href="../symbols/%24_.store.html#.get">get</a></b><span class='signature'>(<span title="key">string</span>, <span title="session">bool</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Puts a value into localstorage at the specified key, and JSON-encodes the value if not a string'><a href="../symbols/%24_.store.html#.set">set</a></b><span class='signature'>(<span title="key">string</span>, <span title="value">mixed</span>, <span title="session">bool</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Removes the specified item from storage'><a href="../symbols/%24_.store.html#.remove">remove</a></b><span class='signature'>(<span title="key">string</span>, <span title="session">bool</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Removes all values from the same domain storage'><a href="../symbols/%24_.store.html#.clear">clear</a></b><span class='signature'>(<span title="session">bool</span>)</span></div></div></div>
<div class="section">
<div title='String and object manipulation utilities' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><a href="../symbols/%24_.util.html">$_.util</a></span></div><div class='sectionItems'><div class='sectionItem classMethod'><b class='icon' title='Retrieve the keys, or member names of an object'><a href="../symbols/%24_.util.html#.object_keys">object_keys</a></b><span class='signature'>(<span>object</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Retrieves the values of an object, and returns them as an array'><a href="../symbols/%24_.util.html#.object_values">object_values</a></b><span class='signature'>(<span>object</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Creates an object, with the property names of the first array, and the values of the second.'><a href="../symbols/%24_.util.html#.array_combine">array_combine</a></b><span class='signature'>(<span title="keys">array/object</span>, <span title="vals">array/object</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Combines two or more objects/arrays.'><a href="../symbols/%24_.util.html#.object_merge">object_merge</a></b><span class='signature'>(<span title="[as many as you wish to combine]">object</span>)</span></div><div class='sectionItem classMethod'><b class='icon' title='Replaces sections of strings in a greedy fashion, starting with the longest replace pairs first.'><a href="../symbols/%24_.util.html#.str_trans">str_trans</a></b><span class='signature'>(<span title="input_string">string</span>, <span>mixed</span>, <span title="to">string</span>)</span></div></div></div>
<div class="section">
<div title='Global namespace.' class='itemName namespace'>
<div class='method-toggler'>&nbsp;</div><span class='icon'><i><a href="../symbols/_global_.html">_global_</a></i></span></div><div class='sectionItems'></div></div>
</div>
</div>
</div>
</div>
<div id="index-toggler" class="fixed">&laquo;</div>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div class="header">
Kis JS Documentation
</div>
<!-- end static/header.html -->
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Namespace $_.dom
</h1>
<!-- ============================== class summary ========================== -->
<!--
-->
<div class="full-description">
<p></p>
</div>
<p class="fileName itemName"><i>Defined in: </i> <span class="icon"><a href="../symbols/src/kis-js_src_modules_DOM.js.html">DOM.js</a>.</span></p>
<!-- ============================== constructor summary ==================== -->
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<div class="summary section">
<div class="sectionTitle">Method Summary</div>
<div class="sectionItems">
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Adds a class to the element(s) specified by the current selector"><a href="../symbols/%24_.dom.html#.addClass">addClass</a></b><span class='signature'>(<span title="class">string</span>)</span>
<span class='description'>Adds a class to the element(s) specified by the current selector</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Removes a class from the element(s) specified by the current selector"><a href="../symbols/%24_.dom.html#.removeClass">removeClass</a></b><span class='signature'>(<span title="class">string</span>)</span>
<span class='description'>Removes a class from the element(s) specified by the current selector</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Hides the element(s) specified by the current selector"><a href="../symbols/%24_.dom.html#.hide">hide</a></b><span class='signature'>()</span>
<span class='description'>Hides the element(s) specified by the current selector</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Shows the element(s) specified by the current selector."><a href="../symbols/%24_.dom.html#.show">show</a></b><span class='signature'>(<span title="type">string</span>)</span>
<span class='description'>Shows the element(s) specified by the current selector.</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector."><a href="../symbols/%24_.dom.html#.attr">attr</a></b><span class='signature'>(<span title="name">string</span>, <span title="value">string</span>)</span>
<span class='description'>Sets attributes on element(s) specified by the current selector, or, if name is not specified, returns the value of the attribute of the element specified by the current selector.</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Sets or retrieves the text content of the element specified by the current selector."><a href="../symbols/%24_.dom.html#.text">text</a></b><span class='signature'>(<span title="value">string</span>)</span>
<span class='description'>Sets or retrieves the text content of the element specified by the current selector.</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Sets or retrieves a css property of the element specified by the current selector."><a href="../symbols/%24_.dom.html#.css">css</a></b><span class='signature'>(<span title="property">string</span>, <span title="value">string</span>)</span>
<span class='description'>Sets or retrieves a css property of the element specified by the current selector.</span>
</div>
<div class="sectionItem classMethod">
<!--
<div class="module-filter">&nbsp;</div>
-->
<b class="icon" title="Sets or gets the innerHTML propery of the element(s) passed"><a href="../symbols/%24_.dom.html#.html">html</a></b><span class='signature'>(<span title="htm">string</span>)</span>
<span class='description'>Sets or gets the innerHTML propery of the element(s) passed</span>
</div>
</div>
</div>
<!-- ============================== constructor details ==================== -->
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="details section">
<div class="sectionTitle">
Method Detail
</div>
<div class="sectionItems">
<div class='sectionItem classMethod '>
<a name=".addClass"> </a>
<div class="itemTitle icon">
$_.dom.addClass<span class="signature">(<span title="class">string</span>)</span>
</div>
<div class="full-description">
Adds a class to the element(s) specified by the current
selector
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
class
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
void
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".removeClass"> </a>
<div class="itemTitle icon">
$_.dom.removeClass<span class="signature">(<span title="class">string</span>)</span>
</div>
<div class="full-description">
Removes a class from the element(s) specified by the current
selector
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
class
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
void
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".hide"> </a>
<div class="itemTitle icon">
$_.dom.hide<span class="signature">()</span>
</div>
<div class="full-description">
Hides the element(s) specified by the current selector
<pre class="prettyprint"></pre>
</div>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
void
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".show"> </a>
<div class="itemTitle icon">
$_.dom.show<span class="signature">(<span title="type">string</span>)</span>
</div>
<div class="full-description">
Shows the element(s) specified by the current selector.
if type is specified, the element will have it's style
property set to "display:[your type]". If type is not
specified, the element is set to "display:block".
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b><i class="help" title="Optional parameter">?</i>, Default: </i>
</td>
<td class="methodItemDesc">
type
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
void
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".attr"> </a>
<div class="itemTitle icon">
$_.dom.attr<span class="signature">(<span title="name">string</span>, <span title="value">string</span>)</span>
<span class="light" title="returns string">: string</span>
</div>
<div class="full-description">
Sets attributes on element(s) specified by the current
selector, or, if name is not specified, returns the
value of the attribute of the element specified by the
current selector.
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
name
</td>
</tr>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
value
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
string
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".text"> </a>
<div class="itemTitle icon">
$_.dom.text<span class="signature">(<span title="value">string</span>)</span>
<span class="light" title="returns string">: string</span>
</div>
<div class="full-description">
Sets or retrieves the text content of the element
specified by the current selector. If a value is
passed, it will set that value on the current element,
otherwise it will return the value of the current element
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b><i class="help" title="Optional parameter">?</i>, Default: </i>
</td>
<td class="methodItemDesc">
value
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
string
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".css"> </a>
<div class="itemTitle icon">
$_.dom.css<span class="signature">(<span title="property">string</span>, <span title="value">string</span>)</span>
<span class="light" title="returns string">: string</span>
</div>
<div class="full-description">
Sets or retrieves a css property of the element
specified by the current selector. If a value is
passed, it will set that value on the current element,
otherwise it will return the value of the css property
on the current element
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
property
</td>
</tr>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b><i class="help" title="Optional parameter">?</i>, Default: </i>
</td>
<td class="methodItemDesc">
value
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
string
</td>
</tr>
</tbody></table>
</div>
<div class='sectionItem classMethod '>
<a name=".html"> </a>
<div class="itemTitle icon">
$_.dom.html<span class="signature">(<span title="htm">string</span>)</span>
<span class="light" title="returns string">: string</span>
</div>
<div class="full-description">
Sets or gets the innerHTML propery of the element(s) passed
<pre class="prettyprint"></pre>
</div>
<div class="heading">Parameters:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemName">
<b>string</b>
</td>
<td class="methodItemDesc">
htm
</td>
</tr>
</tbody></table>
<div class="heading">Returns:</div>
<table class="methodItem"><tbody>
<tr>
<td class="methodItemType">
</td>
<td class="methodItemDesc">
string
</td>
</tr>
</tbody></table>
</div>
</div>
</div>
</div>
<!-- ============================== footer ================================= -->
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink