/usr/share/doc/libjs-edit-area/javascript_functions.html is in libjs-edit-area 0.8.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
<head>
<title>EditArea documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link href="doc_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div class='header'>
<h1>Javascript Functions</h1>
</div>
<div class='content'>
<p>This is for advanced users. The object editAreaLoader has some public functions that can be called from the page in order to manage the EditArea editors.</p>
<h3>editAreaLoader.getValue(editor_id)</h3>
<blockquote>
<p>This method return the content text of the editor. Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: the content text of the editor. <code>String</code></p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.setValue(editor_id, new_text)</h3>
<blockquote>
<p>This method allow to update the content text of an editor. Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
<tr>
<td>new_text</td>
<td>The new text that will replace the Editor content.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.insertTags(editor_id, open_tag, close_tag)</h3>
<blockquote>
<p>This method allow to insert tags at the current position. If no text was selected, the cursor is then
displayed between the open and the close tags. Otherwise, the cursor is positionned after the close tag.
Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
<tr>
<td>open_tag</td>
<td>The open tag string.</td>
</tr>
<tr>
<td>close_tag</td>
<td>The close tag string.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.getSelectedText(editor_id)</h3>
<blockquote>
<p>This method return the text contained in the the selection range.
Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: The text contained in the the selection range. <code>String</code></p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.setSelectedText(editor_id, new_text)</h3>
<blockquote>
<p>This method allow to replace the text contained in the selection range with a given string.
The selection range will then contain the new string.
Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
<tr>
<td>new_text</td>
<td>The string that will replace the current selected text.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.getSelectionRange(editor_id)</h3>
<blockquote>
<p>This method return the position start and position end of the selection range in the editor.
Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: An array containing the index of the selection start and end.
<code>Array("start", "end")</code> </p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.setSelectionRange(editor_id, new_start, new_end)</h3>
<blockquote>
<p>This method allow to set the selection range with the given start and end positions.
Works on normal textarea if the EditArea is toggled off.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea</td>
</tr>
<tr>
<td>new_start</td>
<td>The character position determining the start of the selection range.</td>
</tr>
<tr>
<td>new_end</td>
<td>The character position determining the end of the selection range.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.execCommand(editor_id, command, command_param)</h3>
<blockquote>
<p>Allow to access to EditArea functions and datas (for advanced users only).</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
<tr>
<td>command</td>
<td>The function or the parameter of the EditArea object that will be returned.</td>
</tr>
<tr>
<td>command_param (optionnal)</td>
<td>If command is a function, the you can pass one parameter to the function with command_param</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: the value of the executed command or data. <code>unknown</code></p>
<table>
<thead>
<tr>
<td colspan="2">Examples</td>
</tr>
</thead>
<tbody>
<tr>
<td>Change edit mode</td>
<td>
<p>Allow to toggle EditArea etit mode from normal edition to readonly with no toolbars.</p>
<pre>editAreaLoader.execCommand('editor_id', 'set_editable', !editAreaLoader.execCommand('editor_id', 'is_editable'));</pre>
</td>
</tr>
<tr>
<td>Insert tags</td>
<td>
<p>Insert tags arround selected text or at current cursor position if not text is selected</p>
<pre>editAreaLoader.insertTags('editor_id', "[OPEN]", "[CLOSE]");</pre>
</td>
</tr>
</tbody>
</table>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.delete_instance(editor_id)</h3>
<blockquote>
<p>Delete an instance of EditArea and restore simple textarea.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.hide(editor_id)</h3>
<blockquote>
<p>Hide a textarea and it's related EditArea.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.show(editor_id)</h3>
<blockquote>
<p>Restore a textarea and it's related EditArea hidden with the hide() function.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.openFile(editor_id, file_infos)</h3>
<blockquote>
<p></p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
<tr>
<td>file_infos</td>
<td>An object containing datas of the file that will be openned. Here are the main fields (for the other possible fields see the returned Object of the getFile function):<br>
<ul>
<li><strong>id</strong> : (required) A string that will identify the file. it's the only required field.
<br /><span class='underline'>Type</span>: String
</li>
<li><strong>title</strong> : (optionnal) The title that will be displayed in the tab area.
<br /><span class='underline'>Type</span>: String
<br /><span class='underline'>Default</span>: set with the id field value
</li>
<li><strong>text</strong> : (optionnal) The text content of the file.
<br /><span class='underline'>Type</span>: String
<br /><span class='underline'>Default</span>: ""
</li>
<li><strong>syntax</strong> : (optionnal) The syntax to use for this file.
<br /><span class='underline'>Type</span>: String
<br /><span class='underline'>Default</span>: ""
</li>
<li><strong>do_highlight</strong> : (optionnal) Set if the file should start highlighted or not
<br /><span class='underline'>Type</span>: String
<br /><span class='underline'>Default</span>: ""
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.getCurrentFile(editor_id)</h3>
<blockquote>
<p>Return datas of the currently selected file (for multi file editing mode).</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: An object containing datas related to the file.<code>Object</code></p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.getFile(editor_id, file_id)</h3>
<blockquote>
<p>Return datas of the file identified by file_id (for multi file editing mode).</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
<tr>
<td>file_id</td>
<td>The id of the file to close.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: An object containing datas related to the file.<code>Object</code></p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.getAllFiles(editor_id)</h3>
<blockquote>
<p>Return datas of all the currently openned files (for multi file editing mode).</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: An object containing datas of each files.<code>Object</code></p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.closeFile(editor_id, file_id)</h3>
<blockquote>
<p>Close the file identified by file_id (for multi file editing mode).</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
<tr>
<td>file_id</td>
<td>The id of the file to close.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
<div class='separator'></div>
<h3>editAreaLoader.setFileEditedMode(editor_id, file_id, edited_mode)</h3>
<blockquote>
<p>Define is the file should appears as edited or not.</p>
<table>
<thead>
<tr>
<td colspan="2">Parameters</td>
</tr>
</thead>
<tbody>
<tr>
<td>editor_id</td>
<td>The id of the converted textarea on which the command should be executed.</td>
</tr>
<tr>
<td>file_id</td>
<td>The id of the file to close.</td>
</tr>
<tr>
<td>edited_mode</td>
<td>A boolean that indicate if the file should be set edited or not edited.</td>
</tr>
</tbody>
</table>
<p><strong>Returns</strong>: Nothing.</p>
</blockquote>
</div>
<div class='footer'>
<div class="indexlink"><a href="index.html">Index</a></div>
<div class='copyright'>EditArea - © Christophe Dolivet 2007-2010</div>
<br style="clear: both" />
</div>
</body>
</html>
|