coffeescript-ui
Version:
Coffeescript User Interface System
637 lines (613 loc) • 13.8 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'>FileUpload</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CUI.FileUpload
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>elements/FileUpload/FileUpload.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>Direct Known Subclasses</h2>
<p class='children'>
<a href='../../class/CUI/FileReader.html'>CUI.FileReader</a>
</p>
<h2>Variables Summary</h2>
<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>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#setDropClassByEvent-static'>
.
(void)
<b>setDropClassByEvent</b><span>(ev)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<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='#setUrl-dynamic'>
#
(void)
<b>setUrl</b><span>(__url)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getUrl-dynamic'>
#
(void)
<b>getUrl</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getFiles-dynamic'>
#
(void)
<b>getFiles</b><span>(filter)</span>
</a>
</span>
<span class='desc'>
returns all uploaded files including completed
</span>
</li>
<li>
<span class='signature'>
<a href='#getInfo-dynamic'>
#
(void)
<b>getInfo</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getUploadFileClass-dynamic'>
#
(void)
<b>getUploadFileClass</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#queueFiles-dynamic'>
#
(void)
<b>queueFiles</b><span>(files)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isQueuing-dynamic'>
#
(void)
<b>isQueuing</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#stopQueuing-dynamic'>
#
(void)
<b>stopQueuing</b><span>(abort = false)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#clear-dynamic'>
#
(void)
<b>clear</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#removeFile-dynamic'>
#
(void)
<b>removeFile</b><span>(file)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isDone-dynamic'>
#
(void)
<b>isDone</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#isUploading-dynamic'>
#
(void)
<b>isUploading</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#uploadNextFiles-dynamic'>
#
(void)
<b>uploadNextFiles</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#uploadFile-dynamic'>
#
(void)
<b>uploadFile</b><span>(file)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#checkBatchDone-dynamic'>
#
(void)
<b>checkBatchDone</b><span>(file)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#initDropZone-dynamic'>
#
(void)
<b>initDropZone</b><span>(_opts = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#initFilePicker-dynamic'>
#
(void)
<b>initFilePicker</b><span>(opts)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#resetDropZones-dynamic'>
#
(void)
<b>resetDropZones</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#destroy-dynamic'>
#
(void)
<b>destroy</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>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='setDropClassByEvent-static'>
.
(void)
<b>setDropClassByEvent</b><span>(ev)</span>
<br>
</p>
</div>
</div>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(opts = {})</span>
<br>
</p>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<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='setUrl-dynamic'>
#
(void)
<b>setUrl</b><span>(__url)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getUrl-dynamic'>
#
(void)
<b>getUrl</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getFiles-dynamic'>
#
(void)
<b>getFiles</b><span>(filter)</span>
<br>
</p>
<div class='docstring'>
<p>returns all uploaded files including completed</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getInfo-dynamic'>
#
(void)
<b>getInfo</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getUploadFileClass-dynamic'>
#
(void)
<b>getUploadFileClass</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='queueFiles-dynamic'>
#
(void)
<b>queueFiles</b><span>(files)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isQueuing-dynamic'>
#
(void)
<b>isQueuing</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='stopQueuing-dynamic'>
#
(void)
<b>stopQueuing</b><span>(abort = false)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='clear-dynamic'>
#
(void)
<b>clear</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='removeFile-dynamic'>
#
(void)
<b>removeFile</b><span>(file)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isDone-dynamic'>
#
(void)
<b>isDone</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='isUploading-dynamic'>
#
(void)
<b>isUploading</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='uploadNextFiles-dynamic'>
#
(void)
<b>uploadNextFiles</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='uploadFile-dynamic'>
#
(void)
<b>uploadFile</b><span>(file)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='checkBatchDone-dynamic'>
#
(void)
<b>checkBatchDone</b><span>(file)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='initDropZone-dynamic'>
#
(void)
<b>initDropZone</b><span>(_opts = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='initFilePicker-dynamic'>
#
(void)
<b>initFilePicker</b><span>(opts)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='resetDropZones-dynamic'>
#
(void)
<b>resetDropZones</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='destroy-dynamic'>
#
(void)
<b>destroy</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>