cstd
Version:
CoffeeScript Standart Library
230 lines (227 loc) • 4.96 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript standarts</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='../extra/README.md.html' title='CSTD'>
CSTD
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>CSObject</span>
</div>
</div>
<div id='content'>
<h1>
Class:
CSObject
<span class='note title'>Abstract</span>
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib/object.coffee</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<div class='abstract note'>
<strong>
This
class
is abstract.
</strong>
</div>
<p>Simple abstract class for all classes.</p><p><code>destructor</code> is abstract method, must be defined by extended classes
@class CSObject</p>
</div>
<div class='tags'>
</div>
<h2>Direct Known Subclasses</h2>
<p class='children'>
<a href='../class/BaseCache.html'>BaseCache</a>
<a href='../class/NodeQueue.html'>NodeQueue</a>
<a href='../class/CircularList.html'>CircularList</a>
<a href='../class/Container.html'>Container</a>
<a href='../class/CSEvent.html'>CSEvent</a>
<a href='../class/CSEmitter.html'>CSEmitter</a>
<a href='../class/List.html'>List</a>
<a href='../class/Node.html'>Node</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#destructor-dynamic'>
#
(void)
<b>destructor</b><span>()</span>
</a>
</span>
<span class='desc'>
Destructor is method for clear object.
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>()</span>
<br>
</p>
<div class='docstring'>
<div class='abstract note'>
<strong>
This
method
is abstract.
</strong>
</div>
<p>Constructor of all classes by lib.
Can be call for check defined destructor.</p>
</div>
<div class='tags'>
<h3>Throws:</h3>
<ul class='throw'>
<li>
<span class='type'></span>
(
<tt>TypeError</tt>
)
—
<span class='desc'>if call <code>new CSObject()</code> </span>
</li>
<li>
<span class='type'></span>
(
<tt>Error</tt>
)
—
<span class='desc'>if <code>destructor</code> is not defined by child class </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='destructor-dynamic'>
#
(void)
<b>destructor</b><span>()</span>
<br>
</p>
<div class='docstring'>
<div class='abstract note'>
<strong>
This
method
is abstract.
</strong>
</div>
<p>Destructor is method for clear object. Must be override</p>
</div>
<div class='tags'>
<h3>Throws:</h3>
<ul class='throw'>
<li>
<span class='type'></span>
(
<tt>Error</tt>
)
—
<span class='desc'>if not defined by child class </span>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
By
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.1.0
✲
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>