329 lines
7.8 KiB
HTML
329 lines
7.8 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>
|
|
»
|
|
<a href='../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Insert</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Insert
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Types/BasicTypes.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Inherits:</td>
|
|
<td>
|
|
<a href='../class/Operation.html'>Operation</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>A simple insert-type operation.</p><p>An insert operation is always positioned between two other insert operations.
|
|
Internally this is realized as associative lists, whereby each insert operation has a predecessor and a successor.
|
|
For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl) maintains only the operations that are not deleted - The complete-list (abbrev. cl) maintains all operations</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Direct Known Subclasses</h2>
|
|
<p class='children'>
|
|
<a href='../class/ImmutableObject.html'>ImmutableObject</a>
|
|
</p>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#applyDelete-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyDelete</b><span>(o)</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#isDeleted-dynamic'>
|
|
#
|
|
(void)
|
|
<b>isDeleted</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
If isDeleted() is true this operation won't be maintained in the sl
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#getDistanceToOrigin-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getDistanceToOrigin</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
The amount of positions that $this operation was moved to the right.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#update_sl-dynamic'>
|
|
#
|
|
(void)
|
|
<b>update_sl</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
Update the short list TODO (Unused)
|
|
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#execute-dynamic'>
|
|
#
|
|
(void)
|
|
<b>execute</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='note private title'>Private</span>
|
|
<span class='desc'>
|
|
Include this operation in the associative lists.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>
|
|
<small>Inherited Method Summary</small>
|
|
<h3 class='inherited'>
|
|
Methods inherited from
|
|
<a href='../class/Operation.html'>Operation</a>
|
|
</h3>
|
|
<p class='inherited'>
|
|
<a href='../class/Operation.html#getUid-dynamic'>#getUid</a>
|
|
<a href='../class/Operation.html#execute-dynamic'>#execute</a>
|
|
<a href='../class/Operation.html#saveOperation-dynamic'>#saveOperation</a>
|
|
<a href='../class/Operation.html#validateSavedOperations-dynamic'>#validateSavedOperations</a>
|
|
</p>
|
|
</h2>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(uid, prev_cl, next_cl, origin)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>uid</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Object</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>prev_cl</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/Operation.html'>Operation</a></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The predecessor of this operation in the complete-list (cl) </span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>next_cl</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/Operation.html'>Operation</a></tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>The successor of this operation in the complete-list (cl) </span>
|
|
</li>
|
|
</ul>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='HistoryBuffer.getNextOperationIdentifier'>HistoryBuffer.getNextOperationIdentifier</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='applyDelete-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyDelete</b><span>(o)</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='isDeleted-dynamic'>
|
|
#
|
|
(void)
|
|
<b>isDeleted</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>If isDeleted() is true this operation won't be maintained in the sl</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='getDistanceToOrigin-dynamic'>
|
|
#
|
|
(void)
|
|
<b>getDistanceToOrigin</b><span>()</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>The amount of positions that $this operation was moved to the right.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='update_sl-dynamic'>
|
|
#
|
|
(void)
|
|
<b>update_sl</b><span>()</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Update the short list
|
|
TODO (Unused)</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='execute-dynamic'>
|
|
#
|
|
(void)
|
|
<b>execute</b><span>()</span>
|
|
<span class='note private'>Private</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Include this operation in the associative lists.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 08, 14 04:37:31 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
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> |