yonote/yjs
14
0
Fork 0
Code Pull Requests 1 Releases Activity

Added cool json features (JsonWrapper)

Browse Source
This commit is contained in:
Kevin Jahns
2014-08-04 23:35:50 +02:00
parent 5ba735701c
commit 6c34d97432
72 changed files with 2237 additions and 889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/class/AddName.html
View File

@@ -63,10 +63,10 @@ only one will AddName operation will be executed.</p>
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -82,7 +82,41 @@ only one will AddName operation will be executed.</p>
<b>constructor</b><span>(uid, map_manager, name)</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>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
<li>
<span class='name'>map_manager</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>Uid or reference to the MapManager. </span>
</li>
<li>
<span class='name'>name</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>Name of the property that will be added. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -97,10 +131,10 @@ only one will AddName operation will be executed.</p>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
@@ -108,7 +142,7 @@ only one will AddName operation will be executed.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

40
doc/class/Delete.html
View File

@@ -49,12 +49,13 @@
<ul class='summary'>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
Convert all relevant information of this operation to the json-format.
</span>
@@ -67,6 +68,7 @@
<b>execute</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
Apply the deletion.
</span>
@@ -94,16 +96,41 @@
<b>constructor</b><span>(uid, deletes)</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>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
<li>
<span class='name'>deletes</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>UID or reference of the operation that this to be deleted. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -118,6 +145,7 @@ This result can be sent to other clients.</p>
#
(void)
<b>execute</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -129,7 +157,7 @@ This result can be sent to other clients.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

61
doc/class/Delimiter.html
View File

@@ -49,28 +49,6 @@ of the Engine is empty.</p>
</div>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#isDeleted-dynamic'>
#
(void)
<b>isDeleted</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getDistanceToOrigin-dynamic'>
#
(void)
<b>getDistanceToOrigin</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#execute-dynamic'>
@@ -79,17 +57,19 @@ of the Engine is empty.</p>
<b>execute</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
</span>
</li>
@@ -106,7 +86,6 @@ of the Engine is empty.</p>
<a href='../class/Insert.html#getDistanceToOrigin-dynamic'>#getDistanceToOrigin</a>
<a href='../class/Insert.html#update_sl-dynamic'>#update_sl</a>
<a href='../class/Insert.html#execute-dynamic'>#execute</a>
<a href='../class/Insert.html#val-dynamic'>#val</a>
<a href='../class/Operation.html#getUid-dynamic'>#getUid</a>
<a href='../class/Operation.html#saveOperation-dynamic'>#saveOperation</a>
<a href='../class/Operation.html#validateSavedOperations-dynamic'>#validateSavedOperations</a>
@@ -114,46 +93,32 @@ of the Engine is empty.</p>
</h2>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='isDeleted-dynamic'>
#
(void)
<b>isDeleted</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='getDistanceToOrigin-dynamic'>
#
(void)
<b>getDistanceToOrigin</b><span>()</span>
<br>
</p>
</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='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

28
doc/class/Engine.html
View File

@@ -65,10 +65,10 @@
</li>
<li>
<span class='signature'>
<a href='#cleanUp-dynamic'>
<a href='#applyOp-dynamic'>
#
(void)
<b>cleanUp</b><span>()</span>
<b>applyOp</b><span>(op_json)</span>
</a>
</span>
<span class='desc'>
@@ -76,10 +76,10 @@
</li>
<li>
<span class='signature'>
<a href='#applyOp-dynamic'>
<a href='#tryUnprocessed-dynamic'>
#
(void)
<b>applyOp</b><span>(op_json)</span>
<b>tryUnprocessed</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -117,15 +117,6 @@
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='cleanUp-dynamic'>
#
(void)
<b>cleanUp</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='applyOp-dynamic'>
@@ -136,10 +127,19 @@
</p>
</div>
<div class='method_details'>
<p class='signature' id='tryUnprocessed-dynamic'>
#
(void)
<b>tryUnprocessed</b><span>()</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

10
doc/class/HistoryBuffer.html
View File

@@ -71,10 +71,10 @@
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -175,10 +175,10 @@
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
@@ -228,7 +228,7 @@ other operations (it wont executed)</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

48
doc/class/Insert.html
View File

@@ -49,6 +49,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
</div>
<h2>Direct Known Subclasses</h2>
<p class='children'>
<a href='../class/ImmutableObject.html'>ImmutableObject</a>
<a href='../class/Delimiter.html'>Delimiter</a>
</p>
<h2>Instance Method Summary</h2>
@@ -61,6 +62,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
<b>applyDelete</b><span>(o)</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
</span>
</li>
@@ -84,6 +86,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
<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>
@@ -96,6 +99,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
<b>update_sl</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
Update the short list TODO (Unused)
@@ -109,21 +113,11 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
<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>
<li>
<span class='signature'>
<a href='#val-dynamic'>
#
(void)
<b>val</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>
<small>Inherited Method Summary</small>
@@ -151,24 +145,14 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>creator</span>
<span class='name'>uid</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 getNextOperationIdentifier(). </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>
@@ -207,9 +191,11 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
#
(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'>
@@ -229,6 +215,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
#
(void)
<b>getDistanceToOrigin</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -242,6 +229,7 @@ For the sake of efficiency we maintain two lists: - The short-list (abbrev. sl)
#
(void)
<b>update_sl</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -256,6 +244,7 @@ TODO (Unused)</p>
#
(void)
<b>execute</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -264,19 +253,10 @@ TODO (Unused)</p>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
#
(void)
<b>val</b><span>()</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

2
doc/class/IwcConnector.html
View File

@@ -168,7 +168,7 @@
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

152
doc/class/JsonType.html
View File

@@ -45,31 +45,53 @@
</div>
<div class='tags'>
</div>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='mutable_default-variable'>
mutable_default
=
</dt>
<dd>
<pre><code class='coffeescript'>true</code></pre>
</dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#val-dynamic'>
~
<a href='#setMutableDefault-dynamic'>
#
(void)
<b>val</b><span>()</span>
<b>setMutableDefault</b><span>(mutable)</span>
</a>
</span>
<span class='desc'>
Get this as a Json object.
</span>
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<a href='#val-dynamic'>
~
(Json)
<b>val</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#_encode-dynamic'>
#
(void)
<b>_encode</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Constructor Details</h2>
<div class='methods'>
@@ -77,57 +99,102 @@
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(uid, initial_value)</span>
<b>constructor</b><span>(uid, initial_value, mutable)</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>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
<li>
<span class='name'>initial_value</span>
<span class='type'>
(
<tt>Object</tt>
)
</span>
&mdash;
<span class='desc'>Create this operation with an initial value. </span>
</li>
<li>
<span class='name'>Whether</span>
<span class='type'>
(
<tt>String|Boolean</tt>
)
</span>
&mdash;
<span class='desc'>the initial_value should be created as mutable. (Optional - see setMutableDefault) </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='setMutableDefault-dynamic'>
#
(void)
<b>setMutableDefault</b><span>(mutable)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
~
(void)
(Json)
<b>val</b><span>()</span>
<br>
~
(void)
(JsonType|Word|String|Object)
<b>val</b><span>(name)</span>
<br>
~
(void)
(JsonType)
<b>val</b><span>(name, content)</span>
<br>
</p>
<div class='docstring'>
<p>Get this as a Json object. Note that none of the values of the result is of type Operation.
Get value of a property.
Set a new property.</p>
</div>
<div class='tags'>
<div class='tags'>
<div class='overloads'>
<h3>Overloads:</h3>
<div class='overload'>
<p class='signature'>
~
(void)
(Json)
<b>val</b><span>()</span>
</p>
<div class='docstring'>
<p>@results [Json]</p>
<p>Get this as a Json object.</p>
</div>
<div class='tags'>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
<tt>Json</tt>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
~
(void)
(JsonType|Word|String|Object)
<b>val</b><span>(name)</span>
</p>
<div class='docstring'>
<p>@results [JsonType|WordType]</p>
<p>Get value of a property.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
@@ -143,15 +210,29 @@ Set a new property.</p>
<span class='desc'>Name of the object property. </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt>JsonType|Word|String|Object</tt>
)
&mdash;
<span class='desc'>Depending on the value of the property. If mutable it will return a Operation-type object, if immutable it will return String/Object. </span>
</li>
</ul>
</div>
</div>
<div class='overload'>
<p class='signature'>
~
(void)
(JsonType)
<b>val</b><span>(name, content)</span>
</p>
<div class='tags'>
<div class='docstring'>
<p>Set a new property.</p>
</div>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
@@ -175,24 +256,37 @@ Set a new property.</p>
<span class='desc'>Content of the object property. </span>
</li>
</ul>
<h3>Returns:</h3>
<ul class='return'>
<li>
<span class='type'></span>
(
<tt><a href='../class/JsonType.html'>JsonType</a></tt>
)
&mdash;
<span class='desc'>This object. (supports chaining) </span>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='tags'>
</div>
</div>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

122
doc/class/JsonYatta.html
View File

@@ -35,7 +35,13 @@
</table>
<h2>Overview</h2>
<div class='docstring'>
<p>Framework for arbitrary Json data-structures.</p>
<p>Framework for Json data-structures.
Known values that are supported:</p><ul>
<li>String</li>
<li>Integer</li>
<li>Array</li>
</ul>
</div>
<div class='tags'>
</div>
@@ -50,6 +56,7 @@
</a>
</span>
<span class='desc'>
@result JsonType
</span>
</li>
<li>
@@ -72,6 +79,7 @@
</a>
</span>
<span class='desc'>
Get the initialized connector.
</span>
</li>
<li>
@@ -87,21 +95,44 @@
</li>
<li>
<span class='signature'>
<a href='#getUserId-dynamic'>
<a href='#setMutableDefault-dynamic'>
#
(void)
<b>getUserId</b><span>()</span>
<b>setMutableDefault</b><span>(mutable)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#getUserId-dynamic'>
#
(void)
<b>getUserId</b><span>()</span>
</a>
</span>
<span class='desc'>
Get the UserId from the HistoryBuffer object.
</span>
</li>
<li>
<span class='signature'>
<a href='#val-dynamic'>
#
(void)
<b>val</b><span>(name, content)</span>
<b>val</b><span>(name, content, mutable)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#value-dynamic'>
#
(void)
<b>value</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -129,7 +160,11 @@
<b>getRootElement</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>@result JsonType</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getEngine-dynamic'>
@@ -138,7 +173,14 @@
<b>getEngine</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='../class/Engine.html'>Engine</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getConnector-dynamic'>
@@ -147,7 +189,11 @@
<b>getConnector</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the initialized connector.</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getHistoryBuffer-dynamic'>
@@ -156,7 +202,30 @@
<b>getHistoryBuffer</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='../class/HistoryBuffer.html'>HistoryBuffer</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='setMutableDefault-dynamic'>
#
(void)
<b>setMutableDefault</b><span>(mutable)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='JsonType.setMutableDefault'>JsonType.setMutableDefault</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='getUserId-dynamic'>
@@ -165,21 +234,50 @@
<b>getUserId</b><span>()</span>
<br>
</p>
<div class='docstring'>
<p>Get the UserId from the HistoryBuffer object.
In most cases this will be the same as the user_id value with which
JsonYatta was initialized (Depending on the HistoryBuffer implementation).</p>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='val-dynamic'>
#
(void)
<b>val</b><span>(name, content)</span>
<b>val</b><span>(name, content, mutable)</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='JsonType.val'>JsonType.val</a>
</li>
</ul>
</div>
</div>
<div class='method_details'>
<p class='signature' id='value-dynamic'>
#
(void)
<b>value</b><span>()</span>
<br>
</p>
<div class='tags'>
<h3>See also:</h3>
<ul class='see'>
<li>
<a href='JsonType.value'>JsonType.value</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

41
doc/class/ListManager.html
View File

@@ -110,7 +110,44 @@
<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>
@@ -171,7 +208,7 @@ Doesn&#39;t return left-right delimiter.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

18
doc/class/MapManager.html
View File

@@ -68,7 +68,21 @@
<b>constructor</b><span>(uid)</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>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -85,7 +99,7 @@
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

15
doc/class/Operation.html
View File

@@ -36,7 +36,7 @@
<h2>Overview</h2>
<div class='docstring'>
<p>A generic interface to operations.</p><p>An operation has the following methods:
toJson: encodes an operation (needed only if instance of this operation is sent).
_encode: encodes an operation (needed only if instance of this operation is sent).
execute: execute the effects of this operations. Good examples are Insert-type and AddName-type
val: in the case that the operation holds a value</p><p>Furthermore an encodable operation has a parser.</p>
</div>
@@ -58,7 +58,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
</a>
</span>
<span class='desc'>
Computes a unique identifier (uid).
Computes a unique identifier (uid) that identifies this operation.
</span>
</li>
<li>
@@ -69,6 +69,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
<b>execute</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
Notify the all the listeners.
</span>
@@ -81,6 +82,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
<b>saveOperation</b><span>(name, op_uid)</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
Operations may depend on other operations (linked lists, etc.).
</span>
@@ -93,6 +95,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
<b>validateSavedOperations</b><span>()</span>
</a>
</span>
<span class='note private title'>Private</span>
<span class='desc'>
After calling this function all not instantiated operations will be accessible.
</span>
@@ -118,7 +121,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
)
</span>
&mdash;
<span class='desc'>A unique identifier </span>
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
</ul>
<h3>See also:</h3>
@@ -140,7 +143,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
<br>
</p>
<div class='docstring'>
<p>Computes a unique identifier (uid).</p>
<p>Computes a unique identifier (uid) that identifies this operation.</p>
</div>
<div class='tags'>
</div>
@@ -150,6 +153,7 @@ val: in the case that the operation holds a value</p><p>Furthermore an encodable
#
(void)
<b>execute</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -251,6 +255,7 @@ an easy way to refer to these operations via an uid or object reference.</p><p>F
#
(Boolean)
<b>validateSavedOperations</b><span>()</span>
<span class='note private'>Private</span>
<br>
</p>
<div class='docstring'>
@@ -279,7 +284,7 @@ an easy way to refer to these operations via an uid or object reference.</p><p>F
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

56
doc/class/ReplaceManager.html
View File

@@ -78,10 +78,10 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -110,7 +110,51 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
<b>constructor</b><span>(initial_content, uid, beginning, end, prev, next, origin)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>initial_content</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>Initialize this with a Replaceable that holds the initial_content. </span>
</li>
<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>
@@ -134,10 +178,10 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
@@ -145,7 +189,7 @@ Each Replaceable holds a value that is now replaceable.</p><p>The Word-type has
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

46
doc/class/Replaceable.html
View File

@@ -88,10 +88,10 @@
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -108,7 +108,41 @@
<b>constructor</b><span>(content, parent, uid, prev, next, origin)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>content</span>
<span class='type'>
(
<tt><a href='../class/Operation.html'>Operation</a></tt>
)
</span>
&mdash;
<span class='desc'>The value that this Replaceable holds. </span>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>
(
<tt><a href='../class/ReplaceManager.html'>ReplaceManager</a></tt>
)
</span>
&mdash;
<span class='desc'>Used to replace this Replaceable with another one. </span>
</li>
<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>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -141,10 +175,10 @@
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
<div class='docstring'>
@@ -157,7 +191,7 @@ This result can be send to other clients.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

2
doc/class/TestConnector.html
View File

@@ -219,7 +219,7 @@
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

2
doc/class/TextDelete.html
View File

@@ -53,7 +53,7 @@
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

36
doc/class/TextInsert.html
View File

@@ -74,10 +74,10 @@
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -94,7 +94,31 @@
<b>constructor</b><span>(content, uid, prev, next, origin)</span>
<br>
</p>
<div class='tags'>
<h3>Parameters:</h3>
<ul class='param'>
<li>
<span class='name'>content</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
&mdash;
<span class='desc'>The content of this Insert-type Operation. Usually you restrict the length of content to size 1 </span>
</li>
<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>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -133,10 +157,10 @@ in order to retrieve the content of the engine.</p>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
<div class='docstring'>
@@ -149,7 +173,7 @@ This result can be send to other clients.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

2
doc/class/TextYatta.html
View File

@@ -239,7 +239,7 @@
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>

34
doc/class/Word.html
View File

@@ -110,10 +110,10 @@
</li>
<li>
<span class='signature'>
<a href='#toJson-dynamic'>
<a href='#_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
</a>
</span>
<span class='desc'>
@@ -129,7 +129,29 @@
<b>constructor</b><span>(uid, initial_content, beginning, end, prev, next, 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>
&mdash;
<span class='desc'>A unique identifier. If uid is undefined, a new uid will be created. </span>
</li>
<li>
<span class='name'>initial_content</span>
<span class='type'>
(
<tt>String</tt>
)
</span>
</li>
</ul>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
@@ -208,10 +230,10 @@ to provide replace functionality.</p>
</div>
</div>
<div class='method_details'>
<p class='signature' id='toJson-dynamic'>
<p class='signature' id='_encode-dynamic'>
#
(void)
<b>toJson</b><span>()</span>
<b>_encode</b><span>()</span>
<br>
</p>
@@ -219,7 +241,7 @@ to provide replace functionality.</p>
</div>
</div>
<div id='footer'>
August 03, 14 03:14:41 by
August 04, 14 23:05:04 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>