yjs/doc/class/ListManager.html
2014-08-05 17:04:39 +02:00

282 lines
6.0 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8'>
<title>Yatta! 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='../extra/README.md.html' title='Yatta!'>
Yatta!
</a>
&raquo;
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
&raquo;
<span class='title'>ListManager</span>
</div>
</div>
<div id='content'>
<h1>
Class:
ListManager
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib&#47;Types&#47;StructuredTypes.coffee</td>
</tr>
<tr>
<td>Inherits:</td>
<td>
types.Insert
</td>
</tr>
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Manages a list of Insert-type operations.</p>
</div>
<div class='tags'>
</div>
<h2>Direct Known Subclasses</h2>
<p class='children'>
<a href='../class/ReplaceManager.html'>ReplaceManager</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#getLastOperation-dynamic'>
#
(void)
<b>getLastOperation</b><span>()</span>
</a>
</span>
<span class='desc'>
Get the element previous to the delemiter at the end
</span>
</li>
<li>
<span class='signature'>
<a href='#getFirstOperation-dynamic'>
#
(void)
<b>getFirstOperation</b><span>()</span>
</a>
</span>
<span class='desc'>
similar to the above
</span>
</li>
<li>
<span class='signature'>
<a href='#toArray-dynamic'>
#
(void)
<b>toArray</b><span>()</span>
</a>
</span>
<span class='desc'>
Transforms the the list to an array Doesn&#39;t return left-right delimiter.
</span>
</li>
<li>
<span class='signature'>
<a href='#getOperationByPosition-dynamic'>
#
(void)
<b>getOperationByPosition</b><span>(position)</span>
</a>
</span>
<span class='desc'>
Retrieves the x-th not deleted element.
</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>(uid, beginning, end, prev, next, origin)</span>
<br>
</p>
<div class='docstring'>
<p>A ListManager maintains a non-empty list that has a beginning and an end (both Delimiters!)</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>uid</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
<li>
<span class='name'>beginning</span>
<span class='type'>
(
<tt><a href='../class/Delimiter.html'>Delimiter</a></tt>
)
</span>
&mdash;
<span class='desc'>Reference or Object. </span>
</li>
<li>
<span class='name'>end</span>
<span class='type'>
(
<tt><a href='../class/Delimiter.html'>Delimiter</a></tt>
)
</span>
&mdash;
<span class='desc'>Reference or Object. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='getLastOperation-dynamic'>
#
(void)
<b>getLastOperation</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the element previous to the delemiter at the end</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getFirstOperation-dynamic'>
#
(void)
<b>getFirstOperation</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>similar to the above</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toArray-dynamic'>
#
(void)
<b>toArray</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Transforms the the list to an array
Doesn&#39;t return left-right delimiter.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getOperationByPosition-dynamic'>
#
(void)
<b>getOperationByPosition</b><span>(position)</span>
<br>
</p>
<div class='docstring'>
<p>Retrieves the x-th not deleted element.</p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
August 05, 14 16:58:39 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
&#10034;
Press H to see the keyboard shortcuts
&#10034;
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
&#10034;
<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>