yonote/yjs
23
0
Fork 0
Code Pull Requests 1 Releases Activity
yjs/doc/class/I.html
Kevin Jahns b91135157e Initial Commit -> Text collaboration works
2014-07-29 21:29:10 +02:00

402 lines
9.3 KiB
HTML
Raw Blame History

<!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'>I</span>
</div>
</div>
<div id='content'>
<h1>
Class:
I
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>lib&#47;Engine.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/Delimiter.html'>Delimiter</a>
</p>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#getLength-dynamic'>
#
(void)
<b>getLength</b><span>()</span>
</a>
</span>
<span class='desc'>
Retrieve the effective length of the $content of this operation.
</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&#39;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='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='desc'>
Update the short list TODO
</span>
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
</a>
</span>
<span class='desc'>
Convert all relevant information of this operation into the json-format.
</span>
</li>
<li>
<span class='signature'>
<a href='#execute-dynamic'>
#
(void)
<b>execute</b><span>(current_position)</span>
</a>
</span>
<span class='desc'>
The result will be concatenated with the results from the other insert operations in order to retrieve the content of the engine.
</span>
</li>
<li>
<span class='signature'>
<a href='#IT-dynamic'>
#
(void)
<b>IT</b><span>()</span>
</a>
</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>
</p>
</h2>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(content, creator, op_number, prev_cl, next_cl)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>content</span>
<span class='type'>
(
<tt>Value</tt>
)
</span>
&mdash;
<span class='desc'>The value of the insert operation. E.g. for strings content is a char. </span>
</li>
<li>
<span class='name'>creator</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>A unique user identifier </span>
</li>
<li>
<span class='name'>op_number</span>
<span class='type'>
(
<tt>Integer</tt>
)
</span>
&mdash;
<span class='desc'>This Number was assigned via getOperationCounter(). </span>
</li>
<li>
<span class='name'>prev_cl</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<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>
&mdash;
<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.getOperationCounter'>HistoryBuffer.getOperationCounter</a>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='getLength-dynamic'>
#
(void)
<b>getLength</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Retrieve the effective length of the $content of this operation.</p>
</div>
<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&#39;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>
<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>
<br>
</p>
<div class='docstring'>
<p>Update the short list
TODO</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Convert all relevant information of this operation into the json-format.
This result can be send to other clients.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='execute-dynamic'>
#
(void)
<b>execute</b><span>(current_position)</span>
<br>
</p>
<div class='docstring'>
<p>The result will be concatenated with the results from the other insert operations
in order to retrieve the content of the engine.</p>
</div>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='HistoryBuffer.toExecutedArray'>HistoryBuffer.toExecutedArray</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='IT-dynamic'>
#
(void)
<b>IT</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Include this operation in the associative lists. (For historical reasons IT - Inclusion Transformation)</p>
</div>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
July 18, 14 02:21:01 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>
View Git Blame Copy Permalink