webgui/www/extras/yui/docs/YAHOO.widget.Editor.html
2008-03-25 16:13:25 +00:00

2030 lines
137 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: editor YAHOO.widget.Editor (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>editor&nbsp; <span class="subtitle">2.5.1</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_editor.html">editor</a>
&gt; YAHOO.widget.Editor
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.Editor</b>
<span class="extends">
- extends <a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
The Rich Text Editor is a UI control that replaces a standard HTML textarea; it allows for the rich formatting of text content, including common structural treatments like lists, formatting treatments like bold and italic text, and drag-and-drop inclusion and sizing of images. The Rich Text Editor's toolbar is extensible via a plugin architecture so that advanced implementations can achieve a high degree of customization.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Editor</strong>
<code>
(
el
,
attrs
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el
&lt;String/HTMLElement&gt;
</code>
The textarea element to turn into an editor.
</dd>
<dd>
<code>attrs
&lt;Object&gt;
</code>
Object liternal containing configuration parameters.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property__alwaysDisabled">_alwaysDisabled</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
The Toolbar items that should ALWAYS be disabled event if there is a selection present in the editor.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__alwaysEnabled">_alwaysEnabled</a>
<code>- private Object</code>
</h4>
<div class="detail">
<div class="description">
The Toolbar items that should ALWAYS be enabled event if there isn't a selection present in the editor.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property__disabled">_disabled</a>
<code>- private Array</code>
</h4>
<div class="detail">
<div class="description">
The Toolbar items that should be disabled if there is no selection present in the editor.
</div>
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property_CLASS_HIDDEN">CLASS_HIDDEN</a>
<code>- protected String</code>
</h4>
<div class="detail">
<div class="description">
CSS class applied to the body when the hiddenelements button is pressed.
</div>
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property_CLASS_LOCAL_FILE">CLASS_LOCAL_FILE</a>
<code>- protected String</code>
</h4>
<div class="detail">
<div class="description">
CSS class applied to an element when it's found to have a local url.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_BEFORE_EDITOR">STR_BEFORE_EDITOR</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The accessibility string for the element before the iFrame
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_CLOSE_WINDOW">STR_CLOSE_WINDOW</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The Title of the close button in the Editor Window
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_CLOSE_WINDOW_NOTE">STR_CLOSE_WINDOW_NOTE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
A note appearing in the Editor Window to tell the user that the Escape key will close the window
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_BORDER">STR_IMAGE_BORDER</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the image border.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_COPY">STR_IMAGE_COPY</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the image copy and paste message for Opera and Safari
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_ORIG_SIZE">STR_IMAGE_ORIG_SIZE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for Original Image Size
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_PADDING">STR_IMAGE_PADDING</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the image padding.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_PROP_TITLE">STR_IMAGE_PROP_TITLE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The title for the Image Property Editor Window
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_SIZE">STR_IMAGE_SIZE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for Image Size
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_TEXTFLOW">STR_IMAGE_TEXTFLOW</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the image text flow.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_TITLE">STR_IMAGE_TITLE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for Image Description
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_IMAGE_URL">STR_IMAGE_URL</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for Image URL
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_LINK_NEW_WINDOW">STR_LINK_NEW_WINDOW</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The string for the open in a new window label.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_LINK_PROP_REMOVE">STR_LINK_PROP_REMOVE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the Remove link from text link inside the property editor.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_LINK_PROP_TITLE">STR_LINK_PROP_TITLE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the Link Property Editor Window.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_LINK_TITLE">STR_LINK_TITLE</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The string for the link description.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_STR_LOCAL_FILE_WARNING">STR_LOCAL_FILE_WARNING</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The label string for the local file warning.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__alwaysDisabled">_alwaysDisabled</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__alwaysEnabled">_alwaysEnabled</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__baseHREF">_baseHREF</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__blankImageLoaded">_blankImageLoaded</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__contentTimer">_contentTimer</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__contentTimerCounter">_contentTimerCounter</a><span class="private">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property__defaultCSS">_defaultCSS</a><span class="">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__defaultToolbar">_defaultToolbar</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__disabled">_disabled</a><span class="private">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property__docType">_docType</a><span class="">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__fixNodesTimer">_fixNodesTimer</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__lastButton">_lastButton</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__lastImage">_lastImage</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__lastNodeChange">_lastNodeChange</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__lastNodeChangeEvent">_lastNodeChangeEvent</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__mask">_mask</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__nodeChangeTimer">_nodeChangeTimer</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__rendered">_rendered</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__selection">_selection</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__semantic">_semantic</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__showingHiddenElements">_showingHiddenElements</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property__tag2cmd">_tag2cmd</a><span class="private">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_afterElement">afterElement</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_beforeElement">beforeElement</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_browser">browser</a><span class="">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_CLASS_CONTAINER">CLASS_CONTAINER</a><span class="protected">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_CLASS_EDITABLE">CLASS_EDITABLE</a><span class="protected">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_CLASS_EDITABLE_CONT">CLASS_EDITABLE_CONT</a><span class="protected">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_CLASS_NOEDIT">CLASS_NOEDIT</a><span class="protected">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_CLASS_PREFIX">CLASS_PREFIX</a><span class="protected">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_currentElement">currentElement</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_currentEvent">currentEvent</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_currentFont">currentFont</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_currentWindow">currentWindow</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_dompath">dompath</a><span class="">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property_DOMReady">DOMReady</a><span class="private">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_EDITOR_PANEL_ID">EDITOR_PANEL_ID</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_editorDirty">editorDirty</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_el">el</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_invalidHTML">invalidHTML</a><span class="">,</span>
<a class="private" href="YAHOO.widget.SimpleEditor.html#property_operaEvent">operaEvent</a><span class="private">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_sel">sel</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_SEP_DOMPATH">SEP_DOMPATH</a><span class="">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_STOP_EXEC_COMMAND">STOP_EXEC_COMMAND</a><span class="protected">,</span>
<a class="protected" href="YAHOO.widget.SimpleEditor.html#property_STOP_NODE_CHANGE">STOP_NODE_CHANGE</a><span class="protected">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_STR_BEFORE_EDITOR">STR_BEFORE_EDITOR</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_STR_IMAGE_HERE">STR_IMAGE_HERE</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_STR_LEAVE_EDITOR">STR_LEAVE_EDITOR</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_STR_LINK_URL">STR_LINK_URL</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_STR_TITLE">STR_TITLE</a><span class="">,</span>
<a class="" href="YAHOO.widget.SimpleEditor.html#property_toolbar">toolbar</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS">DOM_EVENTS</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="method__cleanClassName">_cleanClassName</a></h4>
<div class="detail">
<code>
private
String
<strong>_cleanClassName</strong>
(
str
)
</code>
<div class="description">
Makes a useable classname from dynamic data, by dropping it to lowercase and replacing spaces with -'s.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>str &lt;String&gt;</code>
The classname to clean up
</dd>
</dl>
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__closeWindow">_closeWindow</a></h4>
<div class="detail">
<code>
private
void
<strong>_closeWindow</strong>
(
ev
)
</code>
<div class="description">
Close the currently open EditorWindow with the Escape key.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>ev &lt;Event&gt;</code>
The keypress Event that we are trapping
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__fixNodes">_fixNodes</a></h4>
<div class="detail">
<code>
private
void
<strong>_fixNodes</strong>
(
)
</code>
<div class="description">
Fix href and imgs as well as remove invalid HTML.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleCreateLinkWindowClose">_handleCreateLinkWindowClose</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleCreateLinkWindowClose</strong>
(
)
</code>
<div class="description">
Handles the closing of the Link Properties Window.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleInsertImageClick">_handleInsertImageClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleInsertImageClick</strong>
(
)
</code>
<div class="description">
Opens the Image Properties Window when the insert Image button is clicked or an Image is Double Clicked.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleInsertImageWindowClose">_handleInsertImageWindowClose</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleInsertImageWindowClose</strong>
(
)
</code>
<div class="description">
Handles the closing of the Image Properties Window.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__handleKeyDown">_handleKeyDown</a></h4>
<div class="detail">
<code>
private
void
<strong>_handleKeyDown</strong>
(
ev
)
</code>
<div class="description">
Override method that handles some new keydown events inside the iFrame document.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>ev &lt;Event&gt;</code>
The event we are working on.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__renderPanel">_renderPanel</a></h4>
<div class="detail">
<code>
private
<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
<strong>_renderPanel</strong>
(
)
</code>
<div class="description">
Renders the panel used for Editor Windows to the document so we can start using it..
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_closeWindow">closeWindow</a></h4>
<div class="detail">
<code>
void
<strong>closeWindow</strong>
(
)
</code>
<div class="description">
Close the currently open EditorWindow.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_heading">cmd_heading</a></h4>
<div class="detail">
<code>
void
<strong>cmd_heading</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('heading') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_hiddenelements">cmd_hiddenelements</a></h4>
<div class="detail">
<code>
void
<strong>cmd_hiddenelements</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('hiddenelements') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_indent">cmd_indent</a></h4>
<div class="detail">
<code>
void
<strong>cmd_indent</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('indent') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_outdent">cmd_outdent</a></h4>
<div class="detail">
<code>
void
<strong>cmd_outdent</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('outdent') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_removeformat">cmd_removeformat</a></h4>
<div class="detail">
<code>
void
<strong>cmd_removeformat</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('removeformat') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_script">cmd_script</a></h4>
<div class="detail">
<code>
void
<strong>cmd_script</strong>
(
action
,
value
)
</code>
<div class="description">
This is a combined execCommand override method. It is called from the cmd_superscript and cmd_subscript methods.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>action &lt;object&gt;</code>
action passed from the execCommand method
</dd>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_subscript">cmd_subscript</a></h4>
<div class="detail">
<code>
void
<strong>cmd_subscript</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('subscript') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_cmd_superscript">cmd_superscript</a></h4>
<div class="detail">
<code>
void
<strong>cmd_superscript</strong>
(
value
)
</code>
<div class="description">
This is an execCommand override method. It is called from execCommand when the execCommand('superscript') is used.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>value &lt;object&gt;</code>
Value passed from the execCommand method
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
)
</code>
<div class="description">
The Editor class' initialization method
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail">
<code>
void
<strong>initAttributes</strong>
(
attr
)
</code>
<div class="description">
Initializes all of the configuration attributes used to create
the editor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>attr &lt;Object&gt;</code>
Object literal specifying a set of
configuration attributes used to create the editor.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_moveWindow">moveWindow</a></h4>
<div class="detail">
<code>
void
<strong>moveWindow</strong>
(
force
)
</code>
<div class="description">
Realign the window with the currentElement and reposition the knob above the panel.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>force &lt;Boolean&gt;</code>
Boolean to tell it to move but not use any animation (Usually done the first time the window is loaded.)
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_openWindow">openWindow</a></h4>
<div class="detail">
<code>
void
<strong>openWindow</strong>
(
win
)
</code>
<div class="description">
Opens a new "window/panel"
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>win &lt;<a href="YAHOO.widget.EditorWindow.html">YAHOO.widget.EditorWindow</a>&gt;</code>
A <a href="YAHOO.widget.EditorWindow.html">YAHOO.widget.EditorWindow</a> instance
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representing the editor.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.widget.SimpleEditor.html#method__checkLoaded">_checkLoaded</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__cleanClassName">_cleanClassName</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method__cleanIncomingHTML">_cleanIncomingHTML</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__closeWindow">_closeWindow</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__createCurrentElement">_createCurrentElement</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__createIframe">_createIframe</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__disableEditor">_disableEditor</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__fixNodes">_fixNodes</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__focusWindow">_focusWindow</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getBlankImage">_getBlankImage</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getDoc">_getDoc</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getDomPath">_getDomPath</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getRange">_getRange</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getSelectedElement">_getSelectedElement</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getSelection">_getSelection</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__getWindow">_getWindow</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleAfterNodeChange">_handleAfterNodeChange</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleAlign">_handleAlign</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleAutoHeight">_handleAutoHeight</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleClick">_handleClick</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleColorPicker">_handleColorPicker</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleCreateLinkClick">_handleCreateLinkClick</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleCreateLinkWindowClose">_handleCreateLinkWindowClose</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleDoubleClick">_handleDoubleClick</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleFontSize">_handleFontSize</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleFormSubmit">_handleFormSubmit</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleInsertImageClick">_handleInsertImageClick</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleInsertImageWindowClose">_handleInsertImageWindowClose</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleKeyDown">_handleKeyDown</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleKeyPress">_handleKeyPress</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleKeyUp">_handleKeyUp</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleMouseDown">_handleMouseDown</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleMouseUp">_handleMouseUp</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__handleToolbarClick">_handleToolbarClick</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__hasParent">_hasParent</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__hasSelection">_hasSelection</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__initEditor">_initEditor</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__isElement">_isElement</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__isLocalFile">_isLocalFile</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__isNonEditable">_isNonEditable</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__listFix">_listFix</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__render">_render</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__renderPanel">_renderPanel</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__selectNode">_selectNode</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__setCurrentEvent">_setCurrentEvent</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__setDesignMode">_setDesignMode</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method__setEditorStyle">_setEditorStyle</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__setInitialContent">_setInitialContent</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__setMarkupType">_setMarkupType</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__setupAfterElement">_setupAfterElement</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__swapEl">_swapEl</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__toggleDesignMode">_toggleDesignMode</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__updateMenuChecked">_updateMenuChecked</a><span class="private">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#method__writeDomPath">_writeDomPath</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cleanHTML">cleanHTML</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_clearEditorDoc">clearEditorDoc</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_closeWindow">closeWindow</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_backcolor">cmd_backcolor</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_createlink">cmd_createlink</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_fontname">cmd_fontname</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_fontsize">cmd_fontsize</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_forecolor">cmd_forecolor</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_inserthtml">cmd_inserthtml</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_insertimage">cmd_insertimage</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_insertorderedlist">cmd_insertorderedlist</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_insertunorderedlist">cmd_insertunorderedlist</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_list">cmd_list</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_cmd_unlink">cmd_unlink</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_execCommand">execCommand</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_filter_all_rgb">filter_all_rgb</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_filter_internals">filter_internals</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_filter_invalid_lists">filter_invalid_lists</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_filter_rgb">filter_rgb</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_filter_safari">filter_safari</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_getEditorHTML">getEditorHTML</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_hide">hide</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_initAttributes">initAttributes</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_moveWindow">moveWindow</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_nodeChange">nodeChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_openWindow">openWindow</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_post_filter_linebreaks">post_filter_linebreaks</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_pre_filter_linebreaks">pre_filter_linebreaks</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_render">render</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_saveHTML">saveHTML</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_setEditorHTML">setEditorHTML</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_show">show</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.Element.html#method__registerHTMLAttr">_registerHTMLAttr</a><span class="private">,</span> <a class="" href="YAHOO.util.Element.html#method_addClass">addClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_addListener">addListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendChild">appendChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_fireQueue">fireQueue</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByClassName">getElementsByClassName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByTagName">getElementsByTagName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getStyle">getStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasChildNodes">hasChildNodes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasClass">hasClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_initAttributes">initAttributes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_insertBefore">insertBefore</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_on">on</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeChild">removeChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeClass">removeClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeListener">removeListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceChild">replaceChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceClass">replaceClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_setStyle">setStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_subscribe">subscribe</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeHiddencssChange">beforeHiddencssChange</a></h4>
<div class="detail">
<code>
<strong>beforeHiddencssChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'hiddencss' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeLocalFileWarningChange">beforeLocalFileWarningChange</a></h4>
<div class="detail">
<code>
<strong>beforeLocalFileWarningChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'localFileWarning' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the current attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_hiddencssChange">hiddencssChange</a></h4>
<div class="detail">
<code>
<strong>hiddencssChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'hiddencss' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_localFileWarningChange">localFileWarningChange</a></h4>
<div class="detail">
<code>
<strong>localFileWarningChange</strong>
(
eventInfo
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'localFileWarning' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>eventInfo &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.SimpleEditor.html#event_afterExecCommand">afterExecCommand</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_afterNodeChange">afterNodeChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_afterRender">afterRender</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_animateChange">animateChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeAnimateChange">beforeAnimateChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeBlankimageChange">beforeBlankimageChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeCssChange">beforeCssChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeDisabledChange">beforeDisabledChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeDompathChange">beforeDompathChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeExecCommand">beforeExecCommand</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeExtracssChange">beforeExtracssChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeFocusAtStartChange">beforeFocusAtStartChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeHandleSubmitChange">beforeHandleSubmitChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeHeightChange">beforeHeightChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeHtmlChange">beforeHtmlChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeMarkupChange">beforeMarkupChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeNodeChange">beforeNodeChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeRemoveLineBreaksChange">beforeRemoveLineBreaksChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeToolbarChange">beforeToolbarChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_beforeWidthChange">beforeWidthChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_blankimageChange">blankimageChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_cleanHTML">cleanHTML</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_cssChange">cssChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_disabledChange">disabledChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_dompathChange">dompathChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorContentLoaded">editorContentLoaded</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorDoubleClick">editorDoubleClick</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorKeyDown">editorKeyDown</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorKeyPress">editorKeyPress</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorKeyUp">editorKeyUp</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorMouseDown">editorMouseDown</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_editorMouseUp">editorMouseUp</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_extracssChange">extracssChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_focusAtStartChange">focusAtStartChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_handleSubmitChange">handleSubmitChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_heightChange">heightChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_htmlChange">htmlChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_markupChange">markupChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_removeLineBreaksChange">removeLineBreaksChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_toolbarChange">toolbarChange</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_toolbarLoaded">toolbarLoaded</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#event_widthChange">widthChange</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#event_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_available">available</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeAppendTo">beforeAppendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeElementChange">beforeElementChange</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_contentReady">contentReady</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_elementChange">elementChange</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_hiddencss">hiddencss</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
The CSS used to show/hide hidden elements on the page, these rules must be prefixed with the class provided in <code>this.CLASS_HIDDEN</code>
</div>
</div>
<div class="default">
Default Value: <code><pre>
.yui-hidden font, .yui-hidden strong, .yui-hidden b, .yui-hidden em, .yui-hidden i, .yui-hidden u, .yui-hidden div, .yui-hidden p, .yui-hidden span, .yui-hidden img, .yui-hidden ul, .yui-hidden ol, .yui-hidden li, .yui-hidden table {
border: 1px dotted #ccc;
}
.yui-hidden .yui-non {
border: none;
}
.yui-hidden img {
padding: 2px;
}</pre></code>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_localFileWarning">localFileWarning</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Should we throw the warning if we detect a file that is local to their machine?
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.SimpleEditor.html#config_allowNoEdit">allowNoEdit</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_animate">animate</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_autoHeight">autoHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_blankimage">blankimage</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#config_container">container</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_css">css</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_disabled">disabled</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_dompath">dompath</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#config_editor_wrapper">editor_wrapper</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_element_cont">element_cont</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_extracss">extracss</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_focusAtStart">focusAtStart</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_handleSubmit">handleSubmit</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_height">height</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_html">html</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#config_iframe">iframe</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_limitCommands">limitCommands</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_markup">markup</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_nodeChangeThreshold">nodeChangeThreshold</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_panel">panel</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_plainText">plainText</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_removeLineBreaks">removeLineBreaks</a><span class="">,</span> <a class="private" href="YAHOO.widget.SimpleEditor.html#config_textarea">textarea</a><span class="private">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_toolbar">toolbar</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_toolbar_cont">toolbar_cont</a><span class="">,</span> <a class="" href="YAHOO.widget.SimpleEditor.html#config_width">width</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#config_element">element</a><span class="">,</span>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class="selected"><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="YAHOO.widget.Editor.html">YAHOO.widget.Editor</a></li>
<li class=""><a href="YAHOO.widget.EditorInfo.html">YAHOO.widget.EditorInfo</a></li>
<li class=""><a href="YAHOO.widget.EditorWindow.html">YAHOO.widget.EditorWindow</a></li>
<li class=""><a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a></li>
<li class=""><a href="YAHOO.widget.Toolbar.html">YAHOO.widget.Toolbar</a></li>
<li class=""><a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a></li>
<li class=""><a href="YAHOO.widget.ToolbarButtonAdvanced.html">YAHOO.widget.ToolbarButtonAdvanced</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="editor.js.html">editor.js</a></li>
<li class=""><a href="simple-editor.js.html">simple-editor.js</a></li>
<li class=""><a href="toolbar-button.js.html">toolbar-button.js</a></li>
<li class=""><a href="toolbar.js.html">toolbar.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__alwaysDisabled">_alwaysDisabled</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__alwaysEnabled">_alwaysEnabled</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property__disabled">_disabled</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property_CLASS_HIDDEN">CLASS_HIDDEN</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property_CLASS_LOCAL_FILE">CLASS_LOCAL_FILE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_BEFORE_EDITOR">STR_BEFORE_EDITOR</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_CLOSE_WINDOW">STR_CLOSE_WINDOW</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_CLOSE_WINDOW_NOTE">STR_CLOSE_WINDOW_NOTE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_BORDER">STR_IMAGE_BORDER</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_COPY">STR_IMAGE_COPY</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_ORIG_SIZE">STR_IMAGE_ORIG_SIZE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_PADDING">STR_IMAGE_PADDING</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_PROP_TITLE">STR_IMAGE_PROP_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_SIZE">STR_IMAGE_SIZE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_TEXTFLOW">STR_IMAGE_TEXTFLOW</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_TITLE">STR_IMAGE_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_IMAGE_URL">STR_IMAGE_URL</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_LINK_NEW_WINDOW">STR_LINK_NEW_WINDOW</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_LINK_PROP_REMOVE">STR_LINK_PROP_REMOVE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_LINK_PROP_TITLE">STR_LINK_PROP_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_LINK_TITLE">STR_LINK_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_STR_LOCAL_FILE_WARNING">STR_LOCAL_FILE_WARNING</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>String</code>-->
<a href="#method__cleanClassName">_cleanClassName</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__closeWindow">_closeWindow</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__fixNodes">_fixNodes</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleCreateLinkWindowClose">_handleCreateLinkWindowClose</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleInsertImageClick">_handleInsertImageClick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleInsertImageWindowClose">_handleInsertImageWindowClose</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__handleKeyDown">_handleKeyDown</a>
</li>
<li class="private"><!--<code><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></code>-->
<a href="#method__renderPanel">_renderPanel</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_closeWindow">closeWindow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_heading">cmd_heading</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_hiddenelements">cmd_hiddenelements</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_indent">cmd_indent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_outdent">cmd_outdent</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_removeformat">cmd_removeformat</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_script">cmd_script</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_subscript">cmd_subscript</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_cmd_superscript">cmd_superscript</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initAttributes">initAttributes</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_moveWindow">moveWindow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_openWindow">openWindow</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeHiddencssChange">beforeHiddencssChange</a>
</li>
<li class="">
<a href="#event_beforeLocalFileWarningChange">beforeLocalFileWarningChange</a>
</li>
<li class="">
<a href="#event_hiddencssChange">hiddencssChange</a>
</li>
<li class="">
<a href="#event_localFileWarningChange">localFileWarningChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_hiddencss">hiddencss</a>
</li>
<li class="">
<a href="#config_localFileWarning">localFileWarning</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>