coffeescript-ui
Version:
Coffeescript User Interface System
662 lines (637 loc) • 14.2 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>Coffeescript-UI Documentation</title>
<script src='../../javascript/application.js'></script>
<script src='../../javascript/search.js'></script>
<link rel='stylesheet' href='../../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../../'></div>
<div id='header'>
<div id='menu'>
<a href='../../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>CUI</span>
»
<span class='title'>XHR</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.XHR
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>base/XHR/XHR.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<ul>
<li>coffeescript-ui - Coffeescript User Interface System (CUI)</li>
<li>Copyright (c) 2013 - 2016 Programmfabrik GmbH</li>
<li>MIT Licence</li>
<li><a href="https://github.com/programmfabrik/coffeescript-ui">https://github.com/programmfabrik/coffeescript-ui</a>, <a href="http://www.coffeescript-ui.org">http://www.coffeescript-ui.org</a></li>
</ul>
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='readyStates-variable'>
readyStates
=
</dt>
<dd>
<pre><code class='coffeescript'>{
0: "UNSENT",
1: "OPENED",
2: "HEADERS_RECEIVED",
3: "LOADING",
4: "DONE"
}</code></pre>
</dd>
<dt id='statusText-variable'>
statusText
=
</dt>
<dd>
<pre><code class='coffeescript'>{
"-1": "abort",
"-2": "timeout",
"-3": "network_failure"
}</code></pre>
</dd>
</dl>
<h3 class='inherited'>
Variable inherited from
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/Element.html#uniqueId-variable'>uniqueId</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#getGroup-dynamic'>
#
(void)
<b>getGroup</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#initOpts-dynamic'>
#
(void)
<b>initOpts</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#readOpts-dynamic'>
#
(void)
<b>readOpts</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__registerEvents-dynamic'>
#
(void)
<b>__registerEvents</b><span>(type)</span>
</a>
</span>
<span class='desc'>
type: xhr / upload
</span>
</li>
<li>
<span class='signature'>
<a href='#__setStatus-dynamic'>
#
(void)
<b>__setStatus</b><span>(__status)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__download_abort-dynamic'>
#
(void)
<b>__download_abort</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__download_timeout-dynamic'>
#
(void)
<b>__download_timeout</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__download_loadend-dynamic'>
#
(void)
<b>__download_loadend</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__download_readyStateChange-dynamic'>
#
(void)
<b>__download_readyStateChange</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__progress-dynamic'>
#
(void)
<b>__progress</b><span>(ev, type)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__upload_progress-dynamic'>
#
(void)
<b>__upload_progress</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#__download_progress-dynamic'>
#
(void)
<b>__download_progress</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#abort-dynamic'>
#
(void)
<b>abort</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isSuccess-dynamic'>
#
(void)
<b>isSuccess</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#status-dynamic'>
#
(void)
<b>status</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#statusText-dynamic'>
#
(void)
<b>statusText</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#response-dynamic'>
#
(void)
<b>response</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#start-dynamic'>
#
(void)
<b>start</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getXHR-dynamic'>
#
(void)
<b>getXHR</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getAllResponseHeaders-dynamic'>
#
(void)
<b>getAllResponseHeaders</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getResponseHeaders-dynamic'>
#
(void)
<b>getResponseHeaders</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getResponseHeader-dynamic'>
#
(void)
<b>getResponseHeader</b><span>(key)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#readyState-dynamic'>
#
(void)
<b>readyState</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
<h3 class='inherited'>
Methods inherited from
<a href='../../class/CUI/Element.html'>CUI.Element</a>
</h3>
<p class='inherited'>
<a href='../../class/CUI/Element.html#getElementClass-dynamic'>#getElementClass</a>
<a href='../../class/CUI/Element.html#getUniqueId-dynamic'>#getUniqueId</a>
<a href='../../class/CUI/Element.html#getOpts-dynamic'>#getOpts</a>
<a href='../../class/CUI/Element.html#getOpt-dynamic'>#getOpt</a>
<a href='../../class/CUI/Element.html#hasOpt-dynamic'>#hasOpt</a>
<a href='../../class/CUI/Element.html#getSetOpt-dynamic'>#getSetOpt</a>
<a href='../../class/CUI/Element.html#hasSetOpt-dynamic'>#hasSetOpt</a>
<a href='../../class/CUI/Element.html#initOpts-dynamic'>#initOpts</a>
<a href='../../class/CUI/Element.html#copy-dynamic'>#copy</a>
<a href='../../class/CUI/Element.html#mergeOpt-dynamic'>#mergeOpt</a>
<a href='../../class/CUI/Element.html#removeOpt-dynamic'>#removeOpt</a>
<a href='../../class/CUI/Element.html#addOpt-dynamic'>#addOpt</a>
<a href='../../class/CUI/Element.html#addOpts-dynamic'>#addOpts</a>
<a href='../../class/CUI/Element.html#mergeOpts-dynamic'>#mergeOpts</a>
<a href='../../class/CUI/Element.html#__getCheckMap-dynamic'>#__getCheckMap</a>
<a href='../../class/CUI/Element.html#readOpts-dynamic'>#readOpts</a>
<a href='../../class/CUI/Element.html#readOptsFromAttr-dynamic'>#readOptsFromAttr</a>
<a href='../../class/CUI/Element.html#proxy-dynamic'>#proxy</a>
<a href='../../class/CUI/Element.html#destroy-dynamic'>#destroy</a>
<a href='../../class/CUI/Element.html#isDestroyed-dynamic'>#isDestroyed</a>
<a href='../../class/CUI/Element.html#getOptKeys-static'>.getOptKeys</a>
</p>
</h2>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='getGroup-dynamic'>
#
(void)
<b>getGroup</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='initOpts-dynamic'>
#
(void)
<b>initOpts</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='readOpts-dynamic'>
#
(void)
<b>readOpts</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__registerEvents-dynamic'>
#
(void)
<b>__registerEvents</b><span>(type)</span>
<br>
</p>
<div class='docstring'>
<p>type: xhr / upload</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='__setStatus-dynamic'>
#
(void)
<b>__setStatus</b><span>(__status)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__download_abort-dynamic'>
#
(void)
<b>__download_abort</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__download_timeout-dynamic'>
#
(void)
<b>__download_timeout</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__download_loadend-dynamic'>
#
(void)
<b>__download_loadend</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__download_readyStateChange-dynamic'>
#
(void)
<b>__download_readyStateChange</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__progress-dynamic'>
#
(void)
<b>__progress</b><span>(ev, type)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__upload_progress-dynamic'>
#
(void)
<b>__upload_progress</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='__download_progress-dynamic'>
#
(void)
<b>__download_progress</b><span>(ev)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='abort-dynamic'>
#
(void)
<b>abort</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isSuccess-dynamic'>
#
(void)
<b>isSuccess</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='status-dynamic'>
#
(void)
<b>status</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='statusText-dynamic'>
#
(void)
<b>statusText</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='response-dynamic'>
#
(void)
<b>response</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='start-dynamic'>
#
(void)
<b>start</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getXHR-dynamic'>
#
(void)
<b>getXHR</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getAllResponseHeaders-dynamic'>
#
(void)
<b>getAllResponseHeaders</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getResponseHeaders-dynamic'>
#
(void)
<b>getResponseHeaders</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getResponseHeader-dynamic'>
#
(void)
<b>getResponseHeader</b><span>(key)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='readyState-dynamic'>
#
(void)
<b>readyState</b><span>()</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.2
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>