|
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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
<title>Midas Specification</title>
<meta name="author" content="Kathleen Brade">
<style type="text/css">
td { vertical-align: top; }
</style>
</head>
<body>
Last revised: August 23, 2005<br>
<br>
This document describes the rich text editing controls for web pages
available in recent mozilla browsers.<br>
<br>
<h1> Enabling Rich Text Editing in your web page:</h1>
<div style="margin-left: 40px;">Given a document, you can add the
attribute "designMode" and set it to "on" to get an editable document.
For example, in JavaScript, if you have an iframe with an id of 'edit', you
can get its contentDocument and set designMode to "on" like this:<br>
<div style="margin-left: 40px;"><code>document.getElementById("edit").contentDocument.designMode="on";</code></div>
<br>
Right now, you can't completely turn off editing by setting designMode
to "off." Setting designMode to "off" will prevent certain operations
from being handled but typing and other actions are still possible.<br>
</div>
<br>
<h1>Invoking Commands:</h1>
<h2>execCommand</h2>
<div style="margin-left: 40px;">Given a document that has rich text
editing enabled (see above), you can invoke specific commands on the
document by calling execCommand with 3 parameters. For example,
in JavaScript, if you have an editable document,
you can invoke the bold command by calling this:<br>
<div style="margin-left: 40px;"><code>editableDocument.execCommand("Bold",
false, null);</code></div><br>
Notes: If you haven't set designMode to "On", you will get an
error. This could also happen if you call execCommand with the wrong
document.<br>
<br>
There are 3 required parameters for execCommand:<br>
<ol>
<li>command string</li>
<li>boolean flag for showing UI</li>
<li>value string</li>
</ol>
The first parameter is a string which contains the command. The
second parameter is a boolean flag. If it is set to true, you will
get an error (NS_ERROR_NOT_IMPLEMENTED). The third parameter is a
string which is the value. Some commands will require details such
as the particular size you want to set when setting a font size.<br>
<br>
The section on Supported Commands will document each command and any
corresponding values needed.<br>
</div>
<div style="margin-left: 40px;"> </div>
<br>
<h2>queryCommandEnabled</h2>
<blockquote>This command operates on the editable document. There
is one required parameter (the command string). The result is a
boolean which is true if the command is can be done given the current
selection and/or caret position. The result is false if the command
should not be invoked (execCommand) given the current selection and/or
caret position.<br>
</blockquote>
<br>
<h2>queryCommandState</h2>
<blockquote>This section needs to be written. It can be called
similarly to IE implementation.<br>
</blockquote>
<br>
<h2>queryCommandValue</h2>
<blockquote> This section needs to be written. It can be called
similarly to IE implementation.
</blockquote>
<br>
<h1>Supported Commands:</h1>
<div style="margin-left: 40px;">The following list of commands is
presented in alphabetical order. The commands may be mixed case
or whatever makes your code more readable.<br>
<br>
<table cellpadding="4" cellspacing="0" border="1"
style="text-align: left; width: 100%;">
<tbody>
<tr>
<td>command</td>
<td>value</td>
<td>explanation / behavior</td>
</tr>
<tr>
<td>backcolor</td>
<td>????</td>
<td>This command will set the background color of the document.</td>
</tr>
<tr>
<td>bold</td>
<td>none</td>
<td>If there is no selection, the insertion
point will set bold for subsequently typed characters.<br>
<br>
If there is a selection and all of the characters are already bold, the
bold will be removed. Otherwise, all selected characters will become
bold.</td>
</tr>
<tr>
<td>contentReadOnly</td>
<td>true<br>false</td>
<td>This command will make the editor readonly (true) or editable
(false). Anticipated usage is for temporarily disabling input while
something else is occurring elsewhere in the web page.</td>
</tr>
<tr>
<td>copy</td>
<td>none</td>
<td>If there is a selection, this command will copy the selection
to the clipboard. If there isn't a selection, nothing will happen.<br>
<br>
note: this command won't work without setting a pref or using signed
JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-C) with or without the signed JS or any code on the page to
handle it.</td>
</tr>
<tr>
<td>createlink</td>
<td>url (href)</td>
<td>This command will not do anything if no selection
is made. If there is a selection, a link will be inserted around
the selection with the url parameter as the href of the link.</td>
</tr>
<tr>
<td>cut</td>
<td>none</td>
<td>If there is a selection, this command will copy the selection
to the clipboard and remove the selection from the edit control.
If there isn't a selection, nothing will happen.<br>
<br>
note: this command won't work without setting a pref or using signed
JS. See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-X) with or without the signed JS or any code on the page to
handle it.</td>
</tr>
<tr>
<td>decreasefontsize</td>
<td>none</td>
<td>This command will add a <small> tag around selection or
at insertion point.</td>
</tr>
<tr>
<td>delete</td>
<td>none</td>
<td>This command will delete all text and objects that
are selected.</td>
</tr>
<tr>
<td>fontname</td>
<td>????</td>
<td>This command will set the fontface for a selection
or at the insertion point if there is no selection.</td>
</tr>
<tr>
<td>fontsize</td>
<td>????</td>
<td>This command will set the fontsize for a selection
or at the insertion point if there is no selection.</td>
</tr>
<tr>
<td>forecolor</td>
<td>????</td>
<td>This command will set the text color of the
selection or at the insertion point.</td>
</tr>
<tr>
<td>formatblock</td>
<td><h1><br>
<h2><br>
<h3><br>
<h4><br>
<h5><br>
<h6><br>
<pre><br>
<address><br>
<p><br>
p<br>
[this list may not be complete]</td>
<td><br></td>
</tr>
<tr>
<td>heading</td>
<td><h1><br>
<h2><br>
<h3><br>
<h4><br>
<h5><br>
<h6></td>
<td><br></td>
</tr>
<tr>
<td>hilitecolor</td>
<td>????</td>
<td>This command will set the hilite color of the selection or at
the insertion point. It only works with usecss enabled.</td>
</tr>
<tr>
<td>increasefontsize</td>
<td>none</td>
<td>This command will add a
<big> tag around selection or at insertion point.</td>
</tr>
<tr>
<td>indent</td>
<td>none</td>
<td>Indent the block where the caret is located.</td>
</tr>
<tr>
<td>inserthorizontalrule</td>
<td>none</td>
<td>This command will insert a horizontal rule
(line) at the insertion point.<br>
<br>
Does it delete the selection?</td>
</tr>
<tr>
<td>inserthtml</td>
<td>valid html string</td>
<td>This command will insert the given html into the <body>
in place of the current selection or at the caret location.</td>
</tr>
<tr>
<td>insertimage</td>
<td>url (src)</td>
<td>This command will insert an image (referenced by
url) at the insertion point.<br>
<br>
Does it delete the selection?</td>
</tr>
<tr>
<td>insertorderedlist</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>insertunorderedlist</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>insertparagraph</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>italic</td>
<td>none</td>
<td>If there is no selection, the insertion
point will set italic for subsequently typed characters. <br>
<br>
If there is a selection and all of the characters are already italic,
the italic will be removed. Otherwise, all selected characters will
become italic.</td>
</tr>
<tr>
<td>justifycenter</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>justifyfull</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>justifyleft</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>justifyright</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>outdent</td>
<td>none</td>
<td>Outdent the block where the caret is located. If the
block is not indented prior to calling outdent, nothing will happen.<br>
<br>
note: is an error thrown if no outdenting is done?</td>
</tr>
<tr>
<td>paste</td>
<td>none</td>
<td>This command will paste the contents of the clipboard at the
location of the caret. If there is a selection, it will be deleted
prior to the insertion of the clipboard's contents.<br>
<br>
note: this command won't work without setting a pref or using signed
JS.<br>
<tt>user_pref("capability.policy.policynames", "allowclipboard");</tt><tt>
user_pref("capability.policy.allowclipboard.Clipboard.paste",
"allAccess");</tt><br>
See: http://www.mozilla.org/editor/midasdemo/securityprefs.html<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-V) with or without the signed JS or any code on the page to
handle it.</td>
</tr>
<tr>
<td>redo</td>
<td>none</td>
<td>This command will redo the previous undo action. If undo
was not the most recent action, this command will have no effect.<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-shift-Z)</td>
</tr>
<tr>
<td>removeformat</td>
<td>none</td>
<td><br></td>
</tr>
<tr>
<td>selectall</td>
<td>none</td>
<td>This command will select all of the contents within the
editable area.<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-A)</td>
</tr>
<tr>
<td>strikethrough</td>
<td>none</td>
<td>If there is no selection, the insertion point
will set strikethrough for subsequently typed characters.<br>
<br>
If there is a selection and all of the characters are already striked,
the strikethrough will be removed. Otherwise, all selected characters
will have a line drawn through them.</td>
</tr>
<tr>
<td>styleWithCSS</td>
<td>true<br>false</td>
<td>This command is used for
toggling the format of generated content. By default (at least
today), this is true. An example of the differences is that the
"bold" command will generate <b> if the styleWithCSS command is false
and generate css style attribute if the styleWithCSS command is true.</td>
</tr>
<tr>
<td>subscript</td>
<td>none</td>
<td>If there is no selection, the insertion point
will set subscript for subsequently typed characters. <br>
<br>
If there is a selection and all of the characters are already
subscripted, the subscript will be removed. Otherwise, all
selected characters will be drawn slightly lower than normal text.</td>
</tr>
<tr>
<td>superscript</td>
<td>none</td>
<td>If there is no selection, the insertion point
will set superscript for subsequently typed characters.<br>
<br>
If there is a selection and all of the characters are already
superscripted, the superscript will be removed. Otherwise, all
selected characters will be drawn slightly higher than normal text.</td>
</tr>
<tr>
<td>underline</td>
<td>none</td>
<td>If there is no selection, the insertion
point will set underline for subsequently typed characters.<br>
<br>
If there is a selection and all of the characters are already
underlined, the underline will be removed. Otherwise, all
selected characters will become underlined.</td>
</tr>
<tr>
<td>undo</td>
<td>none</td>
<td>This command will undo the previous action. If no action
has occurred in the document, then this command will have no effect.<br>
<br>
note: the shortcut key will automatically trigger this command
(typically accel-Z)</td>
</tr>
<tr>
<td>unlink</td>
<td>none</td>
<td><br></td>
</tr>
</tbody>
</table>
<br>
<table cellpadding="4" cellspacing="0" border="1"
style="text-align: left; width: 100%;">
<tbody>
<tr>
<td colspan="3">DEPRECATED COMMANDS</td>
</tr>
<tr>
<td>readonly</td>
<td>true<br>false</td>
<td>This command has been replaced with contentReadOnly. It
takes the same values as contentReadOnly, but the meaning of true and
false are inversed.</td>
</tr>
<tr>
<td>useCSS</td>
<td>truefalse</td>
<td>This command has been replaced with styleWithCSS. It takes
the same values as styleWithCSS, but the meaning of true and false are
inversed.</td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|