Midas

Introduction

Midas is the code name for Gecko's built-in rich text editor. Midas can be enabled via JavaScript on an HTML document. When Midas is enabled, the document becomes editable by the user. Scripting for Midas is based on the DHTML commands supported by Internet Explorer. Internet Explorer supports the ability to make an entire document editable by setting the designMode property of the document object; this is how Midas is invoked in Gecko. Internet Explorer also supports the ability to edit specific elements using the contentEditable attribute; Starting with Firefox 3, Gecko also supports contentEditable. Once Midas is invoked, a few more methods of the document object become available.

Properties

document.designMode: By setting this property to "on", the document becomes editable.

Notes

Since an entire document becomes editable, authors often load the editable document into an IFRAME and do the bulk of the scripting in the parent document. According to standards, The IFRAME element has the contentDocument property that refers to the document in the inline frame. It also has a property called contentWindow that refers to the window object inside the inline frame. This also avoids problems with Bug 198155.

In addition to the built-in commands, advanced editing can be done by manipulating the Selection and range objects. It is beneficial to be familiar with these objects when working with an editable document.

Examples

This example shows the basic structure described in the Notes section :

<html>
	<head>
		<title>Simple Edit Box</title>
	</head>
	<body>
		<iframe
			id="MidasForm"
			src="about:blank"
			onload="this.contentDocument.designMode='on';"
		></iframe>
	</body>
</html>

Methods

Document.execCommand: Executes the given command.
Document.queryCommandEnabled: Determines whether the given command can be executed on the document in its current state.
Document.queryCommandIndeterm: Determines whether the current selection is in an indetermined state.
Document.queryCommandState: Determines whether the given command has been executed on the current selection.
Document.queryCommandValue: Determines the current value of the document, range, or current selection for the given command.

Supported Commands

Command	Value	Description
backcolor	A color code.	This command will set the background color of the document.
bold		If there is no selection, the insertion point will set bold for subsequently typed characters. 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.
contentReadOnly		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.
copy		If there is a selection, this command will copy the selection to the clipboard. If there isn't a selection, nothing will happen. note: this command won't work without setting a pref or using signed JS. See: more about security preferences 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.
createlink	A URI.	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.
cut		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. note: this command won't work without setting a pref or using signed JS. See: more about security preferences 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.
decreasefontsize		This command will add a <small> tag around selection or at insertion point.
delete		This command will delete all text and objects that are selected. If no text is selected it deletes one character to the right. This is similar to the Delete button on the keyboard.
fontname	A font name	This command will set the font face for a selection or at the insertion point if there is no selection. The given string is such as would be used in the "face" attribute of the font tag, i.e., a comma-separated list of font names.
fontsize	A number	This command will set the fontsize for a selection or at the insertion point if there is no selection. The given number is such as would be used in the "size" attribute of the font tag.
forecolor	A color code	This command will set the text color of the selection or at the insertion point.
formatblock	H1, H2, H3, H4, H5, H6, P, DIV, ADDRESS, BLOCKQUOTE (more?)	The selection surrounded by the given block element.
heading	H1, H2, H3, H4, H5, H6	Selected block will be formatted as the given type of heading.
hilitecolor	A color code	This command will set the hilite color of the selection or at the insertion point. It only works with styleWithCSS enabled.
increasefontsize		This command will add a <big> tag around selection or at insertion point.
indent		Indent the block where the caret is located. If the caret is inside a list, that item becomes a sub-item one level deeper.
insertbronreturn	true/false	Selects whether pressing return inside a paragraph creates another paragraph or just inserts a <br> tag.
inserthorizontalrule	null/string (when string is the Line's id)	This command will insert a horizontal rule (line) at the insertion point. Does it delete the selection? Yes!
inserthtml	A string.	This command will insert the given html into the <body> in place of the current selection or at the caret location. The given string is the HTML to insert.
insertimage	A URI.	This command will insert an image (referenced by the given url) at the insertion point.
insertorderedlist		Depends on the selection. If the caret is not inside a non-LI block, that block becomes the first LI and an OL. If the caret is inside a bulleted item, the bulleted item becomes a numbered item.
insertunorderedlist		Depends on the selection. If the caret is not inside a non-LI block, that block becomes the first LI and UL. If the caret is inside a numbered item, the numbered item becomes a bulleted item.
insertparagraph		Inserts a new paragraph.
italic		If there is no selection, the insertion point will set italic for subsequently typed characters. 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.
justifycenter		Center-aligns the current block.
justifyfull		Fully-justifies the current block.
justifyleft		Left-aligns the current block.
justifyright		Right aligns the current block.
outdent		Outdent the block where the caret is located. If the block is not indented prior to calling outdent, nothing will happen. If the caret is in a list item, the item will bump up a level in the list or break out of the list entirely.
paste		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. note: this command won't work without setting a pref or using signed JS. user_pref("capability.policy.policynames", "allowclipboard"); user_pref("capability.policy.allowclipboard.Clipboard.paste", "allAccess"); See: more about security preferences 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.
redo		This command will redo the previous undo action. If undo was not the most recent action, this command will have no effect. note: the shortcut key will automatically trigger this command (typically accel-shift-Z)
removeformat		Removes inline formatting from the current selection.
selectall		This command will select all of the contents within the editable area. note: the shortcut key will automatically trigger this command (typically accel-A)
strikethrough		If there is no selection, the insertion point will set strikethrough for subsequently typed characters. 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.
styleWithCSS		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.
subscript		If there is no selection, the insertion point will set subscript for subsequently typed characters. 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.
superscript		If there is no selection, the insertion point will set superscript for subsequently typed characters. 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.
underline		If there is no selection, the insertion point will set underline for subsequently typed characters. 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.
undo		This command will undo the previous action. If no action has occurred in the document, then this command will have no effect. note: the shortcut key will automatically trigger this command (typically accel-Z)
unlink		If the insertion point is within a link or if the current selection contains a link, the link will be removed and the text will remain.
Deprecated This feature has been removed from the Web. Though some browsers may still support it, it is in the process of being dropped. Do not use it in old or new projects. Pages or Web apps using it may break at any time.
readonly		This command has been replaced with contentReadOnly. It takes the same values as contentReadOnly, but the meaning of true and false are inversed.
useCSS		This command has been replaced with styleWithCSS. It takes the same values as styleWithCSS, but the meaning of true and false are inversed.