307 lines
6.5 KiB
HTML
307 lines
6.5 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'>Word</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Word
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Types/TextTypes.coffee</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Inherits:</td>
|
|
<td>
|
|
types.ListManager
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>Handles a Text-like data structures with support for insertText/deleteText at a word-position.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#insertText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>insertText</b><span>(position, content)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Inserts a string into the word
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#deleteText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>deleteText</b><span>(position, length)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Deletes a part of the word.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#replaceText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>replaceText</b><span>(text)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Replace the content of this word with another one.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#val-dynamic'>
|
|
#
|
|
(void)
|
|
<b>val</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
@returns [Json] A Json object.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#setReplaceManager-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setReplaceManager</b><span>(op)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
In most cases you would embed a Word in a Replaceable, wich is handled by the ReplaceManager in order to provide replace functionality.
|
|
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#_encode-dynamic'>
|
|
#
|
|
(void)
|
|
<b>_encode</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
</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='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>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='insertText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>insertText</b><span>(position, content)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Inserts a string into the word</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='deleteText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>deleteText</b><span>(position, length)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Deletes a part of the word.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='replaceText-dynamic'>
|
|
#
|
|
(void)
|
|
<b>replaceText</b><span>(text)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Replace the content of this word with another one. Concurrent replacements are not merged!
|
|
Only one of the replacements will be used.</p><p>Can only be used if the ReplaceManager was set!</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='Word.setReplaceManager'>Word.setReplaceManager</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='val-dynamic'>
|
|
#
|
|
(void)
|
|
<b>val</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>@returns [Json] A Json object.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='setReplaceManager-dynamic'>
|
|
#
|
|
(void)
|
|
<b>setReplaceManager</b><span>(op)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>In most cases you would embed a Word in a Replaceable, wich is handled by the ReplaceManager in order
|
|
to provide replace functionality.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='_encode-dynamic'>
|
|
#
|
|
(void)
|
|
<b>_encode</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
|
|
</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> |