6390 lines
159 KiB
HTML
6390 lines
159 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>
|
|
TinyMCE_Engine
|
|
</TITLE>
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
|
</HEAD>
|
|
<SCRIPT>
|
|
function asd()
|
|
{
|
|
parent.document.title="TinyMCE_Engine";
|
|
}
|
|
</SCRIPT>
|
|
<BODY BGCOLOR="white" onload="asd();">
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-TinyMCE_Engine.class.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B></B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="TinyMCE_Control.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="TinyMCE_Layer.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="TinyMCE_Engine.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
<HR>
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>Class TinyMCE_Engine</H2>
|
|
<PRE>Object
|
|
|
|
|
+--<b>TinyMCE_Engine</b>
|
|
</PRE>
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<!-- Class definition -->
|
|
<DT>class
|
|
<B>TinyMCE_Engine</B>
|
|
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<I>Defined in <a href='overview-summary-TinyMCE_Engine.class.js.html'>TinyMCE_Engine.class.js</a></I><BR/><BR/>
|
|
</P>
|
|
|
|
<HR>
|
|
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
<!-- This is one instance field summary -->
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#buttonMap">buttonMap</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#configs">configs</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#currentConfig">currentConfig</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#dialogCounter">dialogCounter</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#eventHandlers">eventHandlers</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#idCounter">idCounter</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#instances">instances</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isGecko">isGecko</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isLoaded">isLoaded</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isMac">isMac</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isMSIE">isMSIE</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isMSIE5">isMSIE5</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isMSIE5_0">isMSIE5_0</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isNS7">isNS7</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isNS71">isNS71</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isOpera">isOpera</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#isSafari">isSafari</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#loadedFiles">loadedFiles</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#loadedPlugins">loadedPlugins</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#majorVersion">majorVersion</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#menus">menus</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#minorVersion">minorVersion</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#plugins">plugins</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#releaseDate">releaseDate</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#switchClassCache">switchClassCache</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#themes">themes</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#windowArgs">windowArgs</A></B></CODE>
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="TinyMCE_Engine.html#TinyMCE_Engine()">TinyMCE_Engine</A>
|
|
</B>
|
|
()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Core engine class for TinyMCE, a instance of this class is available as a global called tinyMCE.
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#_getElementById">_getElementById</A></B>(<string> i<DOMDocument> d, d)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a element by id, this will also search the form names to match the id.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#_removeInternal">_removeInternal</A></B>(<DOMNode> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes any internal content inserted by regexps.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#accessibleEventHandler">accessibleEventHandler</A></B>(<DOMEvent> e)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Accessibility handler that gets executed when the user hits a key in a select element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addButtonMap">addButtonMap</A></B>(<string> m)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds a list of buttons available in the tiled button image used by the button_tile_map option.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addCSSClass">addCSSClass</A></B>(<HTMLElement> e, c, b)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds a CSS class to the specified element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addEvent">addEvent</A></B>(<HTMLElement> o, <string> n, <function> h)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds a event handler function to the specified object.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addEventHandlers">addEventHandlers</A></B>(<inst> inst)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds the handleEvent function to the specified editor instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addMCEControl">addMCEControl</A></B>(<HTMLElement> replace_element, <string> form_element_name, <DOMDocument> target_document)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds a TinyMCE editor control instance to a specific form element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addMenu">addMenu</A></B>(<string> n, <TinyMCE_Menu> m)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds a floating menu instance to TinyMCE.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addPlugin">addPlugin</A></B>(n, <TinyMCE_Plugin> p)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds the specified plugin to the list of loaded plugins, this will also setup the baseURL
|
|
property of the plugin.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addSelectAccessibility">addSelectAccessibility</A></B>(<DOMEvent> e, <HTMLElement> s, <DOMWindow> w)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds accessibility keydown handler to the specified select element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addTheme">addTheme</A></B>(&l<TinyMCE_Theme> t;string> n, t)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds the specified theme in to the list of loaded themes.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#addToLang">addToLang</A></B>(<string> prefix, <Array> ar)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds language items to the global language array.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#applyTemplate">applyTemplate</A></B>(<string> h, <Array> as)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Replaces language, args and settings variables in a HTML string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#callFunc">callFunc</A></B>(<<<Array> a href="TinyMCE_Control.html">TinyMCE_Control</a>> ins, <string> p, <string> n, <int> m, a)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Executes callback chain.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#cancelEvent">cancelEvent</A></B>(<DOMEvent> e)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Cancels the specified event, this will disable the event from be passed to other listeners in event chain.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#cleanupAnchors">cleanupAnchors</A></B>(<DOMDocument> doc)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Moves the contents of a anchor outside and after the anchor.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#cleanupEventStr">cleanupEventStr</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes MSIE 5.5 specific event wrapper function form a event string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#cleanupHTMLCode">cleanupHTMLCode</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Makes some preprocessing cleanup routines on the specified HTML string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#clearArray">clearArray</A></B>(a)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a cleared array, since some external libraries tend to extend the Array core object
|
|
arrays needs to be cleaned from these extended functions.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#closeWindow">closeWindow</A></B>(<DOMWindow> win)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Closes the specified window.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#compressStyle">compressStyle</A></B>(<Array> ar, <string> pr, <string> sf, <string> res)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Compresses larger styles into a smaller.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#confirmAdd">confirmAdd</A></B>(<DOMEvent> e, <Array> settings)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Displays a confirm dialog when a user clicks/focus a textarea that is to be converted into
|
|
a TinyMCE instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertAbsoluteURLToRelativeURL">convertAbsoluteURLToRelativeURL</A></B>(<string> base_url, <string> url_to_relative)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Converts an absolute path to relative path.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertAllRelativeURLs">convertAllRelativeURLs</A></B>(<HTMLElement> body)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Converts all img and a element URLs to absolute URLs.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertFontsToSpans">convertFontsToSpans</A></B>(<DOMDocument> doc)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Convers fonts to spans in the specified document.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertHexToRGB">convertHexToRGB</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a rgb(n,n,n) string from a hexadecimal value.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertRelativeToAbsoluteURL">convertRelativeToAbsoluteURL</A></B>(<string> base_url, <string> relative_url)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Converts an relative path to absolute path.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertRGBToHex">convertRGBToHex</A></B>(<string> s, <boolean> k)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a hexadecimal version of the specified rgb(1,2,3) string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertSpansToFonts">convertSpansToFonts</A></B>(<DOMDocument> doc)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Converts span elements to font elements in the specified document instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#convertURL">convertURL</A></B>(<string> url, <HTMLElement> node, <boolean> on_save)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Converts the specified URL based in TinyMCE configuration settings.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#debug">debug</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Debugs the specified message to a screen.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#dispatchCallback">dispatchCallback</A></B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Dispatches the specified callback on all options, plugins and themes.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#entityDecode">entityDecode</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
HTML entity decode a string, replaces < with <.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#evalFunc">evalFunc</A></B>(<string> f, <int> idx, <Array> a)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Evaluates the specified function and uses the array of arguments.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#execCommand">execCommand</A></B>(<string> command, <boolean> user_interface, <object> value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Executes a command on the selected or last selected TinyMCE editor control instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#execCommandCallback">execCommandCallback</A></B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Executes the specified execcommand callback on all options, plugins and themes.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#execInstanceCommand">execInstanceCommand</A></B>(<string> editor_id, <string> command, <boolean> user_interface, <object> value, <boolean> focus)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Executes a command on a specific editor instance by id.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#executeCallback">executeCallback</A></B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Executes the specified callback on all options, plugins and themes.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#explode">explode</A></B>(<string> d, <string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Splits a string by the specified delimiter and skips any empty items.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#extend">extend</A></B>(<Object> p, <Object> np)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Extends the specified prototype with new methods.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#fixGeckoBaseHREFBug">fixGeckoBaseHREFBug</A></B>(<boolean> m, <HTMLElement> e, <string> h)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Fixes a Gecko specific bug where href, src attribute values gets converted incorrectly
|
|
when inserted into editor.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> TinyMCE_ElementPosition</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getAbsPosition">getAbsPosition</A></B>(<HTMLNode> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the absolute x, y position of a node.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getAttrib">getAttrib</A></B>(<HTMLElement> elm, <string> name, <string> default_value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the attribute value of a element or the default value if it wasn't found.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getButtonHTML">getButtonHTML</A></B>(<string> id, <string> lang, <string> img, <string> cmd, <string> ui, <string> val)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the HTML code for a normal button control.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getContent">getContent</A></B>(<string> editor_id)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the HTML contents of the specified editor instance id.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getControlHTML">getControlHTML</A></B>(<string> c)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the HTML for the specified control this will loop through
|
|
the theme and all plugins inorder to find the control.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getCSSClasses">getCSSClasses</A></B>(<string> editor_id, <DOMDocument> doc)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a array of CSS classes that is available in a document.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getEditorId">getEditorId</A></B>(<string> form_element)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the editor instance id of a specific form element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getElementByAttributeValue">getElementByAttributeValue</A></B>(<HTMLElement> n, <string> e, <string> a, <string> v)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a element by a specific attribute and it's value.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getElementsByAttributeValue">getElementsByAttributeValue</A></B>(<HTMLElement> n, <string> e, <string> a, <string> v)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a element array by a specific attribute and it's value.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> <a href="TinyMCE_Control.html">TinyMCE_Control</a></CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getInstanceById">getInstanceById</A></B>(<string> editor_id)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a TinyMCE editor instance by the specified editor id or null if it wasn't found.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getLang">getLang</A></B>(<string> name, <string> default_value, <boolean> parse_entities, <Array> va)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a language variable value from the language packs.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getNodeTree">getNodeTree</A></B>(&l<int> t;HTMLNode> n, <Array> na, t, <string> nn)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a array of nodes selected retrived from the child nodes of the specified node.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getOuterHTML">getOuterHTML</A></B>(<HTMLElement> e)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the outer HTML of a element, this uses the outerHTML
|
|
property in MSIE and Opera and a workaround for Gecko.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getParam">getParam</A></B>(<string> name, <string> default_value, <boolean> strip_whitespace, <string> split_chr)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a specific configuration setting or the default value if it wasn't found.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getParentBlockElement">getParentBlockElement</A></B>(<HTMLNode> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the first block element parent of the specified node.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getParentElement">getParentElement</A></B>(<HTMLNode> node, <string> names, <string> attrib_name, <string> attrib_value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the parent element of the specified node based on the search criteria.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> DOMNode</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getParentNode">getParentNode</A></B>(<DOMNode> n, <function> f)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a node by the specified selector function.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getVisualAidClass">getVisualAidClass</A></B>(<string> class_name, <boolean> state)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the visual aid class string, this will add/remove the visual aid class.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#getWindowArg">getWindowArg</A></B>(<string> n, d)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns the window argument to be passed to TinyMCE popup.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#handleEvent">handleEvent</A></B>(<DOMEvent> e)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Event handler function that gets executed each time a event occurs in a TinyMCE editor control instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#handleVisualAid">handleVisualAid</A></B>(<HTMLElement> el, <boolean> deep, <boolean> state, <<a href="TinyMCE_Control.html">TinyMCE_Control</a>> inst, skip_dispatch)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Adds visual aid classes to all elements that need them recursive in the DOM tree.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#hasMenu">hasMenu</A></B>(<string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Checks if the specified menu by name is added to TinyMCE.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#hasPlugin">hasPlugin</A></B>(<string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns true/false if the specified plugin is loaded or not.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#hasTheme">hasTheme</A></B>(<string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns true/false if the specified theme is loaded or not.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#importCSS">importCSS</A></B>(<DOMDocument> doc, <string> css)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Imports a CSS file into a allready loaded document.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#importPluginLanguagePack">importPluginLanguagePack</A></B>(<string> name, <string> valid_languages)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Loads a plugin specific language pack.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#importThemeLanguagePack">importThemeLanguagePack</A></B>(<string> name)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Loads a theme specific language pack.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#init">init</A></B>(settings)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Initializes TinyMCE with the specific configuration settings.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#insertAfter">insertAfter</A></B>(<HTMLNode> n, <HTMLNode> r)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Inserts a node after the specific node.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#isBlockElement">isBlockElement</A></B>(<HTMLNode> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns true/false if the specified node is a block element or not.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#isInstance">isInstance</A></B>(<object> o)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns true/false if a specific object is a TinyMCE_Control instance or not.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#loadCSS">loadCSS</A></B>(<string> url)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Loads the specified CSS by writing the a link tag to the current page.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#loadPlugin">loadPlugin</A></B>(<string> n, <string> u)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Load plugin from external URL.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#loadScript">loadScript</A></B>(<string> url)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Loads the specified script by writing the a script tag to the current page.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#nextNode">nextNode</A></B>(<HTMLNode> e, <string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Finds any element after the current one by name.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#onLoad">onLoad</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Gets executed when the page loads or get intitialized.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#onMouseMove">onMouseMove</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Mouse move handler function, this will be executed each time
|
|
the mouse is moved within a editor instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#openWindow">openWindow</A></B>(<Array> template, <Array> args)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Opens a popup window based in the specified input data.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#parseStyle">parseStyle</A></B>(<string> str)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Parses the specified HTML style data.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> TinyMCE_URL_Item</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#parseURL">parseURL</A></B>(<string> url_str)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Parses a URL in to its diffrent components.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> HTMLElement</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#prevNode">prevNode</A></B>(<HTMLNode> e, <string> n)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Finds any previous element by name.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> boolean</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#queryInstanceCommandState">queryInstanceCommandState</A></B>(<string> editor_id, <string> command)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Queries a command state for a specific command on a specific editor instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> object</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#queryInstanceCommandValue">queryInstanceCommandValue</A></B>(<string> editor_id, <string> command)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Queries a command value for a specific command on a specific editor instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#regexpReplace">regexpReplace</A></B>(<string> in_str, <string> reg_exp, <string> replace_str, opts)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Regexp replaces the contents of a string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#removeCSSClass">removeCSSClass</A></B>(<HTMLElement> e, c)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes the specified CSS class from the element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#removeMCEControl">removeMCEControl</A></B>(<string> editor_id)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes a TinyMCE editor control instance by id.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#removeTinyMCEFormElements">removeTinyMCEFormElements</A></B>(<HTMLElement> form_obj)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes/disables TinyMCE built in form elements such as select boxes for font sizes etc.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#renameElement">renameElement</A></B>(<HTMLElement> e, <string> n, <DOMDocument> d)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Renames the specified element to the specified name.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#replaceVar">replaceVar</A></B>(<string> h, <string> r, <string> v)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Replaces a specific variable in the string with a nother string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#resetForm">resetForm</A></B>(<int> form_index)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Resets a forms TinyMCE instances based on form index.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> Array</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#selectNodes">selectNodes</A></B>(<DOMNode> n, <function> f, <Array> a)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Returns a array of nodes when the specified function matches a node.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#serializeStyle">serializeStyle</A></B>(<Array> ar)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Serializes the specified style item name/value array into a HTML string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#serializeURL">serializeURL</A></B>(<TinyMCE_URL_Item> up)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Serializes the specified URL object into a string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setAttrib">setAttrib</A></B>(<HTMLElement> element, <string> name, <string> value, <boolean> fix_value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the attribute value for a specific attribute.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setContent">setContent</A></B>(<string> h)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the HTML contents of the selected editor instance.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setInnerHTML">setInnerHTML</A></B>(<HTMLElement> e, <string> h)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the innerHTML property of a element, this function also
|
|
fixes a MSIE bug where the first comment is removed.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setOuterHTML">setOuterHTML</A></B>(<HTMLElement> e, <string> h)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the outer HTML of a element, this uses the outerHTML
|
|
property in MSIE and Opera and a workaround for Gecko.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setPluginBaseURL">setPluginBaseURL</A></B>(<string> n, <string> u)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the baseURL of the specified plugin, this is useful if the plugin is loaded from
|
|
a external location.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setStyleAttrib">setStyleAttrib</A></B>(<HTMLElement> elm, <string> name, <string> value)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets a style attribute item value.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setupContent">setupContent</A></B>(<string> editor_id)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Setups the contents of TinyMCE editor instance and fills it with contents.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#setWindowArg">setWindowArg</A></B>(<string> n, <string> v)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Sets the window argument to be passed to TinyMCE popup.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#storeAwayURLs">storeAwayURLs</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Stores away the src and href attribute values in separate mce_src and mce_href attributes.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#submitPatch">submitPatch</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Piggyback onsubmit event handler function, this will remove/hide the TinyMCE specific form elements
|
|
call triggerSave to fill the textarea with the correct contents then call the old piggy backed event handler.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#switchClass">switchClass</A></B>(<HTMLElement> ei, <string> c)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Switches the CSS class of the specified element.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#triggerNodeChange">triggerNodeChange</A></B>(<boolean> focus, <boolean> setup_content)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Triggers a nodeChange event to every theme and plugin.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#triggerSave">triggerSave</A></B>(<boolean> skip_cleanup, <boolean> skip_callback)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Moves the contents from a TinyMCE editor control instance to the hidden textarea
|
|
that got replaced with TinyMCE.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#trim">trim</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Removes all prefix, suffix whitespace of a string.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#unloadHandler">unloadHandler</A></B>()
|
|
</CODE>
|
|
<BR>
|
|
|
|
Unload document event handler function.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> void</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#updateContent">updateContent</A></B>(<string> form_element_name)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Moves the contents from the hidden textarea to the editor that gets inserted.
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
<FONT SIZE="-1">
|
|
<CODE> string</CODE>
|
|
</FONT>
|
|
</TD>
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="#xmlEncode">xmlEncode</A></B>(<string> s)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Encodes the string to raw XML entities.
|
|
</TD>
|
|
</TR>
|
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
<P>
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<A NAME="buttonMap"><!-- --></A>
|
|
<H3>buttonMap</H3>
|
|
<PRE>Object <B>buttonMap</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="configs"><!-- --></A>
|
|
<H3>configs</H3>
|
|
<PRE>Object <B>configs</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="currentConfig"><!-- --></A>
|
|
<H3>currentConfig</H3>
|
|
<PRE>Object <B>currentConfig</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="dialogCounter"><!-- --></A>
|
|
<H3>dialogCounter</H3>
|
|
<PRE>Object <B>dialogCounter</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="eventHandlers"><!-- --></A>
|
|
<H3>eventHandlers</H3>
|
|
<PRE>Object <B>eventHandlers</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="idCounter"><!-- --></A>
|
|
<H3>idCounter</H3>
|
|
<PRE>Object <B>idCounter</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="instances"><!-- --></A>
|
|
<H3>instances</H3>
|
|
<PRE>Object <B>instances</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isGecko"><!-- --></A>
|
|
<H3>isGecko</H3>
|
|
<PRE>Object <B>isGecko</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isLoaded"><!-- --></A>
|
|
<H3>isLoaded</H3>
|
|
<PRE>Object <B>isLoaded</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isMac"><!-- --></A>
|
|
<H3>isMac</H3>
|
|
<PRE>Object <B>isMac</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isMSIE"><!-- --></A>
|
|
<H3>isMSIE</H3>
|
|
<PRE>Object <B>isMSIE</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isMSIE5"><!-- --></A>
|
|
<H3>isMSIE5</H3>
|
|
<PRE>Object <B>isMSIE5</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isMSIE5_0"><!-- --></A>
|
|
<H3>isMSIE5_0</H3>
|
|
<PRE>Object <B>isMSIE5_0</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isNS7"><!-- --></A>
|
|
<H3>isNS7</H3>
|
|
<PRE>Object <B>isNS7</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isNS71"><!-- --></A>
|
|
<H3>isNS71</H3>
|
|
<PRE>Object <B>isNS71</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isOpera"><!-- --></A>
|
|
<H3>isOpera</H3>
|
|
<PRE>Object <B>isOpera</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="isSafari"><!-- --></A>
|
|
<H3>isSafari</H3>
|
|
<PRE>Object <B>isSafari</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="loadedFiles"><!-- --></A>
|
|
<H3>loadedFiles</H3>
|
|
<PRE>Object <B>loadedFiles</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="loadedPlugins"><!-- --></A>
|
|
<H3>loadedPlugins</H3>
|
|
<PRE>Object <B>loadedPlugins</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="majorVersion"><!-- --></A>
|
|
<H3>majorVersion</H3>
|
|
<PRE>Object <B>majorVersion</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="menus"><!-- --></A>
|
|
<H3>menus</H3>
|
|
<PRE>Object <B>menus</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="minorVersion"><!-- --></A>
|
|
<H3>minorVersion</H3>
|
|
<PRE>Object <B>minorVersion</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="plugins"><!-- --></A>
|
|
<H3>plugins</H3>
|
|
<PRE>Object <B>plugins</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="releaseDate"><!-- --></A>
|
|
<H3>releaseDate</H3>
|
|
<PRE>Object <B>releaseDate</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="switchClassCache"><!-- --></A>
|
|
<H3>switchClassCache</H3>
|
|
<PRE>Object <B>switchClassCache</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="themes"><!-- --></A>
|
|
<H3>themes</H3>
|
|
<PRE>Object <B>themes</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="windowArgs"><!-- --></A>
|
|
<H3>windowArgs</H3>
|
|
<PRE>Object <B>windowArgs</B></PRE>
|
|
<UL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
|
|
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1>
|
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="TinyMCE_Engine()"><!-- --></A><H3>
|
|
TinyMCE_Engine</H3>
|
|
<PRE><B>TinyMCE_Engine</B>()</PRE>
|
|
|
|
|
|
<UL>
|
|
Core engine class for TinyMCE, a instance of this class is available as a global called tinyMCE.
|
|
</UL>
|
|
|
|
|
|
|
|
</UL>
|
|
|
|
|
|
<!-- Constructor return value(s) -->
|
|
|
|
<!-- End constructor return value(s) -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
|
|
|
<HR/>
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
|
|
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- One single method detail entry -->
|
|
|
|
<A NAME="_getElementById"><!-- --></A>
|
|
<H3>_getElementById</H3>
|
|
<PRE>HTMLElement <B>_getElementById</B>(<string> i<DOMDocument> d, d)</PRE>
|
|
|
|
<UL>Returns a element by id, this will also search the form names to match the id.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>id</CODE> - Id of element.
|
|
</UL>
|
|
|
|
<UL><CODE>d</CODE> - Optional document.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML element that matches the id.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="_removeInternal"><!-- --></A>
|
|
<H3>_removeInternal</H3>
|
|
<PRE>void <B>_removeInternal</B>(<DOMNode> n)</PRE>
|
|
|
|
<UL>Removes any internal content inserted by regexps.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Node to remove internal content from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="accessibleEventHandler"><!-- --></A>
|
|
<H3>accessibleEventHandler</H3>
|
|
<PRE>Object <B>accessibleEventHandler</B>(<DOMEvent> e)</PRE>
|
|
|
|
<UL>Accessibility handler that gets executed when the user hits a key in a select element.
|
|
This handler trams the enter/return or space key and then executes the onchange event handler.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - DOM event object instance.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addButtonMap"><!-- --></A>
|
|
<H3>addButtonMap</H3>
|
|
<PRE>void <B>addButtonMap</B>(<string> m)</PRE>
|
|
|
|
<UL>Adds a list of buttons available in the tiled button image used by the button_tile_map option.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>m</CODE> - Comma separated list of buttons that are available in tiled image.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addCSSClass"><!-- --></A>
|
|
<H3>addCSSClass</H3>
|
|
<PRE>string <B>addCSSClass</B>(<HTMLElement> e, c, b)</PRE>
|
|
|
|
<UL>Adds a CSS class to the specified element. It will remove any previous item with the same name
|
|
so adding a class that already exists will move it to the end.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML element to add CSS class to.
|
|
</UL>
|
|
|
|
<UL><CODE>string</CODE> - ] c CSS class to add to HTML element.
|
|
</UL>
|
|
|
|
<UL><CODE>boolean</CODE> - ] b Optional parameter, if set to true, class will be added to the beginning.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Returns the new class attribute value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addEvent"><!-- --></A>
|
|
<H3>addEvent</H3>
|
|
<PRE>void <B>addEvent</B>(<HTMLElement> o, <string> n, <function> h)</PRE>
|
|
|
|
<UL>Adds a event handler function to the specified object.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>o</CODE> - Object to add event handler to.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Event name to listen to for example "click".
|
|
</UL>
|
|
|
|
<UL><CODE>h</CODE> - Function handler to execute when event occurs.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addEventHandlers"><!-- --></A>
|
|
<H3>addEventHandlers</H3>
|
|
<PRE>void <B>addEventHandlers</B>(<inst> inst)</PRE>
|
|
|
|
<UL>Adds the handleEvent function to the specified editor instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>inst</CODE> - Editor control instance to add event handler to.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addMCEControl"><!-- --></A>
|
|
<H3>addMCEControl</H3>
|
|
<PRE>void <B>addMCEControl</B>(<HTMLElement> replace_element, <string> form_element_name, <DOMDocument> target_document)</PRE>
|
|
|
|
<UL>Adds a TinyMCE editor control instance to a specific form element.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>replace_element</CODE> - HTML element object to replace.
|
|
</UL>
|
|
|
|
<UL><CODE>form_element_name</CODE> - HTML form element name,
|
|
</UL>
|
|
|
|
<UL><CODE>target_document</CODE> - Target document that holds the element.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addMenu"><!-- --></A>
|
|
<H3>addMenu</H3>
|
|
<PRE>void <B>addMenu</B>(<string> n, <TinyMCE_Menu> m)</PRE>
|
|
|
|
<UL>Adds a floating menu instance to TinyMCE.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - TinyMCE menu id.
|
|
</UL>
|
|
|
|
<UL><CODE>m</CODE> - TinyMCE menu instance.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addPlugin"><!-- --></A>
|
|
<H3>addPlugin</H3>
|
|
<PRE>void <B>addPlugin</B>(n, <TinyMCE_Plugin> p)</PRE>
|
|
|
|
<UL>Adds the specified plugin to the list of loaded plugins, this will also setup the baseURL
|
|
property of the plugin.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>p</CODE> - Plugin instance to add.
|
|
</UL>
|
|
|
|
<UL><CODE>Plugin</CODE> - name/id.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addSelectAccessibility"><!-- --></A>
|
|
<H3>addSelectAccessibility</H3>
|
|
<PRE>Object <B>addSelectAccessibility</B>(<DOMEvent> e, <HTMLElement> s, <DOMWindow> w)</PRE>
|
|
|
|
<UL>Adds accessibility keydown handler to the specified select element.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - Event that gets passed when the element is focused.
|
|
</UL>
|
|
|
|
<UL><CODE>s</CODE> - Select element that the keydown handler gets added to.
|
|
</UL>
|
|
|
|
<UL><CODE>w</CODE> - DOM window reference to add.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addTheme"><!-- --></A>
|
|
<H3>addTheme</H3>
|
|
<PRE>void <B>addTheme</B>(&l<TinyMCE_Theme> t;string> n, t)</PRE>
|
|
|
|
<UL>Adds the specified theme in to the list of loaded themes.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Theme name/id to add the object reference to.
|
|
</UL>
|
|
|
|
<UL><CODE>t</CODE> - Theme instance to add to the loaded list.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="addToLang"><!-- --></A>
|
|
<H3>addToLang</H3>
|
|
<PRE>void <B>addToLang</B>(<string> prefix, <Array> ar)</PRE>
|
|
|
|
<UL>Adds language items to the global language array.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>prefix</CODE> - Prefix string to add infront of every array item before adding it.
|
|
</UL>
|
|
|
|
<UL><CODE>ar</CODE> - Language item array to add to global language array.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="applyTemplate"><!-- --></A>
|
|
<H3>applyTemplate</H3>
|
|
<PRE>string <B>applyTemplate</B>(<string> h, <Array> as)</PRE>
|
|
|
|
<UL>Replaces language, args and settings variables in a HTML string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>h</CODE> - HTML string to replace language variables in.
|
|
</UL>
|
|
|
|
<UL><CODE>as</CODE> - Optional arguments array to take variables from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML string with replaced varliables.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="callFunc"><!-- --></A>
|
|
<H3>callFunc</H3>
|
|
<PRE>boolean <B>callFunc</B>(<<<Array> a href="TinyMCE_Control.html">TinyMCE_Control</a>> ins, <string> p, <string> n, <int> m, a)</PRE>
|
|
|
|
<UL>Executes callback chain. Callback TinyMCE_Engine.prototype.order = Option; Plugins, Themes.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>ins</CODE> - TinyMCE editor control instance to execute callback on.
|
|
</UL>
|
|
|
|
<UL><CODE>p</CODE> - TinyMCE callback parameter name.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Function name to execute.
|
|
</UL>
|
|
|
|
<UL><CODE>m</CODE> - Execution mode value, 0 = no chain, 1 = event chain, 2 = execcommand chain.
|
|
</UL>
|
|
|
|
<UL><CODE>a</CODE> - Array with function arguments.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true - if the callback was executed, false if it wasn't.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="cancelEvent"><!-- --></A>
|
|
<H3>cancelEvent</H3>
|
|
<PRE>void <B>cancelEvent</B>(<DOMEvent> e)</PRE>
|
|
|
|
<UL>Cancels the specified event, this will disable the event from be passed to other listeners in event chain.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - Event to cancel.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="cleanupAnchors"><!-- --></A>
|
|
<H3>cleanupAnchors</H3>
|
|
<PRE>void <B>cleanupAnchors</B>(<DOMDocument> doc)</PRE>
|
|
|
|
<UL>Moves the contents of a anchor outside and after the anchor. Only if the anchor doesn't
|
|
have a href.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>doc</CODE> - DOM document instance to fix anchors in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="cleanupEventStr"><!-- --></A>
|
|
<H3>cleanupEventStr</H3>
|
|
<PRE>string <B>cleanupEventStr</B>(<string> s)</PRE>
|
|
|
|
<UL>Removes MSIE 5.5 specific event wrapper function form a event string.
|
|
This will also remove the event blocker if it's added in front of the event.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - String to replace event data in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Replaced string value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="cleanupHTMLCode"><!-- --></A>
|
|
<H3>cleanupHTMLCode</H3>
|
|
<PRE>string <B>cleanupHTMLCode</B>(<string> s)</PRE>
|
|
|
|
<UL>Makes some preprocessing cleanup routines on the specified HTML string.
|
|
This includes forcing some tags to be open so MSIE doesn't fail. Forcing other to close and
|
|
padding paragraphs with non breaking spaces. This function is used when the editor gets
|
|
initialized with content.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - HTML string to cleanup.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Cleaned HTML string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="clearArray"><!-- --></A>
|
|
<H3>clearArray</H3>
|
|
<PRE>Array <B>clearArray</B>(a)</PRE>
|
|
|
|
<UL>Returns a cleared array, since some external libraries tend to extend the Array core object
|
|
arrays needs to be cleaned from these extended functions. So this function simply sets any
|
|
named properties back to null.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>Name</CODE> - /Value array to clear.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Cleared name/value array.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="closeWindow"><!-- --></A>
|
|
<H3>closeWindow</H3>
|
|
<PRE>void <B>closeWindow</B>(<DOMWindow> win)</PRE>
|
|
|
|
<UL>Closes the specified window. This function is deprecated and should be replaced with
|
|
tinyMCEPopup.close();.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>win</CODE> - Window reference to close.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I></I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="compressStyle"><!-- --></A>
|
|
<H3>compressStyle</H3>
|
|
<PRE>void <B>compressStyle</B>(<Array> ar, <string> pr, <string> sf, <string> res)</PRE>
|
|
|
|
<UL>Compresses larger styles into a smaller. Since MSIE automaticly converts
|
|
border: 1px solid red to border-left: 1px solid red, border-righ: 1px solid red and so forth.'
|
|
This will bundle them together again if the information is the same in each item.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>ar</CODE> - Style name/value array with items.
|
|
</UL>
|
|
|
|
<UL><CODE>pr</CODE> - Style item prefix to bundle for example border.
|
|
</UL>
|
|
|
|
<UL><CODE>sf</CODE> - Style item suffix to bunlde for example -width or -width.
|
|
</UL>
|
|
|
|
<UL><CODE>res</CODE> - Result name, for example border-width.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="confirmAdd"><!-- --></A>
|
|
<H3>confirmAdd</H3>
|
|
<PRE>void <B>confirmAdd</B>(<DOMEvent> e, <Array> settings)</PRE>
|
|
|
|
<UL>Displays a confirm dialog when a user clicks/focus a textarea that is to be converted into
|
|
a TinyMCE instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - DOM event instance.
|
|
</UL>
|
|
|
|
<UL><CODE>settings</CODE> - Name/Value array of initialization settings.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertAbsoluteURLToRelativeURL"><!-- --></A>
|
|
<H3>convertAbsoluteURLToRelativeURL</H3>
|
|
<PRE>string <B>convertAbsoluteURLToRelativeURL</B>(<string> base_url, <string> url_to_relative)</PRE>
|
|
|
|
<UL>Converts an absolute path to relative path.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>base_url</CODE> - URL to make as a base path, URLs will be converted relative from this point.
|
|
</UL>
|
|
|
|
<UL><CODE>url_to_relative</CODE> - URL to convert into a relative URL.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Relative URL based in input.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertAllRelativeURLs"><!-- --></A>
|
|
<H3>convertAllRelativeURLs</H3>
|
|
<PRE>void <B>convertAllRelativeURLs</B>(<HTMLElement> body)</PRE>
|
|
|
|
<UL>Converts all img and a element URLs to absolute URLs. This will use the mce_src or mce_href attribute values
|
|
if they are provided. This function is used when the editor is initialized.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>body</CODE> - HTML element to convert all URLs in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertFontsToSpans"><!-- --></A>
|
|
<H3>convertFontsToSpans</H3>
|
|
<PRE>void <B>convertFontsToSpans</B>(<DOMDocument> doc)</PRE>
|
|
|
|
<UL>Convers fonts to spans in the specified document.
|
|
Todo: Move this function into a XHTML plugin or simmilar.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>doc</CODE> - Document instance to convert fonts in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertHexToRGB"><!-- --></A>
|
|
<H3>convertHexToRGB</H3>
|
|
<PRE>string <B>convertHexToRGB</B>(<string> s)</PRE>
|
|
|
|
<UL>Returns a rgb(n,n,n) string from a hexadecimal value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - Hexadecimal string to parse.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
rgb(n,n,n) string from a hexadecimal value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertRelativeToAbsoluteURL"><!-- --></A>
|
|
<H3>convertRelativeToAbsoluteURL</H3>
|
|
<PRE>string <B>convertRelativeToAbsoluteURL</B>(<string> base_url, <string> relative_url)</PRE>
|
|
|
|
<UL>Converts an relative path to absolute path.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>base_url</CODE> - URL to make as a base path, URLs will be converted absolute from this point.
|
|
</UL>
|
|
|
|
<UL><CODE>relative_url</CODE> - URL to convert into a absolute URL.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Absolute URL based in input.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertRGBToHex"><!-- --></A>
|
|
<H3>convertRGBToHex</H3>
|
|
<PRE>string <B>convertRGBToHex</B>(<string> s, <boolean> k)</PRE>
|
|
|
|
<UL>Returns a hexadecimal version of the specified rgb(1,2,3) string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - RGB string to parse, if this doesn't isn't a rgb(n,n,n) it will passthrough the string.
|
|
</UL>
|
|
|
|
<UL><CODE>k</CODE> - Keep before/after contents. If enabled contents before after the rgb(n,n,n) will be intact.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Hexadecimal version of the specified rgb(1,2,3) string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertSpansToFonts"><!-- --></A>
|
|
<H3>convertSpansToFonts</H3>
|
|
<PRE>void <B>convertSpansToFonts</B>(<DOMDocument> doc)</PRE>
|
|
|
|
<UL>Converts span elements to font elements in the specified document instance.
|
|
Todo: Move this function into a XHTML plugin or simmilar.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>doc</CODE> - Document instance to convert spans in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="convertURL"><!-- --></A>
|
|
<H3>convertURL</H3>
|
|
<PRE>string <B>convertURL</B>(<string> url, <HTMLElement> node, <boolean> on_save)</PRE>
|
|
|
|
<UL>Converts the specified URL based in TinyMCE configuration settings.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>url</CODE> - URL to convert based on config.
|
|
</UL>
|
|
|
|
<UL><CODE>node</CODE> - HTML element that holds the URL.
|
|
</UL>
|
|
|
|
<UL><CODE>on_save</CODE> - Is this convertion the final output URL.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Converted URL string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="debug"><!-- --></A>
|
|
<H3>debug</H3>
|
|
<PRE>void <B>debug</B>()</PRE>
|
|
|
|
<UL>Debugs the specified message to a screen.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>Numerous</CODE> - arguments that will be outputed.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="dispatchCallback"><!-- --></A>
|
|
<H3>dispatchCallback</H3>
|
|
<PRE>Object <B>dispatchCallback</B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)</PRE>
|
|
|
|
<UL>Dispatches the specified callback on all options, plugins and themes. This will not
|
|
chain them, so all functions callbacks will be executed regardless if the return true/false.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>i</CODE> - TinyMCE editor control instance to execute callback on.
|
|
</UL>
|
|
|
|
<UL><CODE>p</CODE> - TinyMCE callback parameter to execute.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Function name to execute.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if they where dispatched.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="entityDecode"><!-- --></A>
|
|
<H3>entityDecode</H3>
|
|
<PRE>string <B>entityDecode</B>(<string> s)</PRE>
|
|
|
|
<UL>HTML entity decode a string, replaces < with <.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - Entity string to decode into normal string.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Entity decoded string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="evalFunc"><!-- --></A>
|
|
<H3>evalFunc</H3>
|
|
<PRE>object <B>evalFunc</B>(<string> f, <int> idx, <Array> a)</PRE>
|
|
|
|
<UL>Evaluates the specified function and uses the array of arguments.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>f</CODE> - Function reference to execute.
|
|
</UL>
|
|
|
|
<UL><CODE>idx</CODE> - Index in array to start grabbing arguments from.
|
|
</UL>
|
|
|
|
<UL><CODE>a</CODE> - Array of function arguments.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Value returned from the evaluated function.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="execCommand"><!-- --></A>
|
|
<H3>execCommand</H3>
|
|
<PRE>void <B>execCommand</B>(<string> command, <boolean> user_interface, <object> value)</PRE>
|
|
|
|
<UL>Executes a command on the selected or last selected TinyMCE editor control instance. This function also handles
|
|
some non instance specific commands like mceAddControl, mceRemoveControl, mceHelp or mceFocus.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>command</CODE> - Command name to execute, for example mceLink or Bold.
|
|
</UL>
|
|
|
|
<UL><CODE>user_interface</CODE> - True/false state if a UI (dialog) should be presented or not.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - Optional command value, this can be anything.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="execCommandCallback"><!-- --></A>
|
|
<H3>execCommandCallback</H3>
|
|
<PRE>Object <B>execCommandCallback</B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)</PRE>
|
|
|
|
<UL>Executes the specified execcommand callback on all options, plugins and themes. This will
|
|
chain them, so callback chain will be broken if one function returns true.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>i</CODE> - TinyMCE editor control instance to execute callback on.
|
|
</UL>
|
|
|
|
<UL><CODE>p</CODE> - TinyMCE callback parameter to execute.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Function name to execute.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if a callback was executed.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="execInstanceCommand"><!-- --></A>
|
|
<H3>execInstanceCommand</H3>
|
|
<PRE>void <B>execInstanceCommand</B>(<string> editor_id, <string> command, <boolean> user_interface, <object> value, <boolean> focus)</PRE>
|
|
|
|
<UL>Executes a command on a specific editor instance by id.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - TinyMCE editor control instance id to perform comman on.
|
|
</UL>
|
|
|
|
<UL><CODE>command</CODE> - Command name to execute, for example mceLink or Bold.
|
|
</UL>
|
|
|
|
<UL><CODE>user_interface</CODE> - True/false state if a UI (dialog) should be presented or not.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - Optional command value, this can be anything.
|
|
</UL>
|
|
|
|
<UL><CODE>focus</CODE> - True/false if the editor instance should be focused first.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="executeCallback"><!-- --></A>
|
|
<H3>executeCallback</H3>
|
|
<PRE>Object <B>executeCallback</B>(<<a href="TinyMCE_Control.html">TinyMCE_Control</a>> i, <string> p, <string> n)</PRE>
|
|
|
|
<UL>Executes the specified callback on all options, plugins and themes. This will
|
|
chain them, so callback chain will be broken if one function returns false.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>i</CODE> - TinyMCE editor control instance to execute callback on.
|
|
</UL>
|
|
|
|
<UL><CODE>p</CODE> - TinyMCE callback parameter to execute.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Function name to execute.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if a callback was executed.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="explode"><!-- --></A>
|
|
<H3>explode</H3>
|
|
<PRE>Array <B>explode</B>(<string> d, <string> s)</PRE>
|
|
|
|
<UL>Splits a string by the specified delimiter and skips any empty items.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>d</CODE> - Delimiter to split by.
|
|
</UL>
|
|
|
|
<UL><CODE>s</CODE> - String to split.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Array with chunks from string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="extend"><!-- --></A>
|
|
<H3>extend</H3>
|
|
<PRE>Object <B>extend</B>(<Object> p, <Object> np)</PRE>
|
|
|
|
<UL>Extends the specified prototype with new methods.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>p</CODE> - Prototype to extend with new methods.
|
|
</UL>
|
|
|
|
<UL><CODE>np</CODE> - New prototype to extend the other one with.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Extended prototype array.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="fixGeckoBaseHREFBug"><!-- --></A>
|
|
<H3>fixGeckoBaseHREFBug</H3>
|
|
<PRE>string <B>fixGeckoBaseHREFBug</B>(<boolean> m, <HTMLElement> e, <string> h)</PRE>
|
|
|
|
<UL>Fixes a Gecko specific bug where href, src attribute values gets converted incorrectly
|
|
when inserted into editor. This function will replace all src, href with mce_tsrc and mce_thref
|
|
to keep the values from chaging when they get inserted.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>m</CODE> - Mode state, true is to replace the src, href attributes to mce_tsrc and mce_thref.
|
|
</UL>
|
|
|
|
<UL><CODE>e</CODE> - HTML element to replace them in. (Will be used if m is 0)
|
|
</UL>
|
|
|
|
<UL><CODE>h</CODE> - HTML code to replace them in. (Will be used if m is 1)
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Converted string or the specified HTML value depending on mode.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getAbsPosition"><!-- --></A>
|
|
<H3>getAbsPosition</H3>
|
|
<PRE>TinyMCE_ElementPosition <B>getAbsPosition</B>(<HTMLNode> n)</PRE>
|
|
|
|
<UL>Returns the absolute x, y position of a node. The position will be returned in a object with
|
|
two properties absLeft and absTop.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - HTML element to get x, y position from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Absolute position of the specified element.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getAttrib"><!-- --></A>
|
|
<H3>getAttrib</H3>
|
|
<PRE>string <B>getAttrib</B>(<HTMLElement> elm, <string> name, <string> default_value)</PRE>
|
|
|
|
<UL>Returns the attribute value of a element or the default value if it wasn't found.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>elm</CODE> - HTML element to get attribute from.
|
|
</UL>
|
|
|
|
<UL><CODE>name</CODE> - Attribute name to retrive.
|
|
</UL>
|
|
|
|
<UL><CODE>default_value</CODE> - Optional default value to return, this value defaults to a empty string.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Attribute value or default value if it wasn't found in element.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getButtonHTML"><!-- --></A>
|
|
<H3>getButtonHTML</H3>
|
|
<PRE>string <B>getButtonHTML</B>(<string> id, <string> lang, <string> img, <string> cmd, <string> ui, <string> val)</PRE>
|
|
|
|
<UL>Returns the HTML code for a normal button control.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>id</CODE> - Button control id, this will be the suffix for the element id, the prefix is the editor id.
|
|
</UL>
|
|
|
|
<UL><CODE>lang</CODE> - Language variable key name to insert as the title/alt of the button image.
|
|
</UL>
|
|
|
|
<UL><CODE>img</CODE> - Image URL to insert, {$themeurl} and {$pluginurl} will be replaced.
|
|
</UL>
|
|
|
|
<UL><CODE>cmd</CODE> - Command to execute when the user clicks the button.
|
|
</UL>
|
|
|
|
<UL><CODE>ui</CODE> - Optional user interface boolean for command.
|
|
</UL>
|
|
|
|
<UL><CODE>val</CODE> - Optional value for command.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML code for a normal button based in input information.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getContent"><!-- --></A>
|
|
<H3>getContent</H3>
|
|
<PRE>string <B>getContent</B>(<string> editor_id)</PRE>
|
|
|
|
<UL>Returns the HTML contents of the specified editor instance id.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Editor instance id to retrive HTML code from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML contents of editor id or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getControlHTML"><!-- --></A>
|
|
<H3>getControlHTML</H3>
|
|
<PRE>string <B>getControlHTML</B>(<string> c)</PRE>
|
|
|
|
<UL>Returns the HTML for the specified control this will loop through
|
|
the theme and all plugins inorder to find the control. The callback for each
|
|
theme and plugin is called getControlHTML.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>c</CODE> - Control name/id to get HTML code for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML code for the specified control or empty string if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getCSSClasses"><!-- --></A>
|
|
<H3>getCSSClasses</H3>
|
|
<PRE>Array <B>getCSSClasses</B>(<string> editor_id, <DOMDocument> doc)</PRE>
|
|
|
|
<UL>Returns a array of CSS classes that is available in a document.
|
|
TinyMCE_Engine.prototype.Todo = Fix;this one, it's so ugly. :)</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Editor id to get CSS classes from.
|
|
</UL>
|
|
|
|
<UL><CODE>doc</CODE> - DOM document to get the CSS classes from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Array of CSS classes that is available in a document.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getEditorId"><!-- --></A>
|
|
<H3>getEditorId</H3>
|
|
<PRE>string <B>getEditorId</B>(<string> form_element)</PRE>
|
|
|
|
<UL>Returns the editor instance id of a specific form element.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>form_element</CODE> - Form element name to get instance id for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
TinyMCE editor instance id or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getElementByAttributeValue"><!-- --></A>
|
|
<H3>getElementByAttributeValue</H3>
|
|
<PRE>HTMLElement <B>getElementByAttributeValue</B>(<HTMLElement> n, <string> e, <string> a, <string> v)</PRE>
|
|
|
|
<UL>Returns a element by a specific attribute and it's value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Element to search in.
|
|
</UL>
|
|
|
|
<UL><CODE>e</CODE> - Element name to search for.
|
|
</UL>
|
|
|
|
<UL><CODE>a</CODE> - Attribute name to search for.
|
|
</UL>
|
|
|
|
<UL><CODE>v</CODE> - Attribute value to search for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML element that matched the criterias or null on failure.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getElementsByAttributeValue"><!-- --></A>
|
|
<H3>getElementsByAttributeValue</H3>
|
|
<PRE>Array <B>getElementsByAttributeValue</B>(<HTMLElement> n, <string> e, <string> a, <string> v)</PRE>
|
|
|
|
<UL>Returns a element array by a specific attribute and it's value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Element to search in.
|
|
</UL>
|
|
|
|
<UL><CODE>e</CODE> - Element name to search for.
|
|
</UL>
|
|
|
|
<UL><CODE>a</CODE> - Attribute name to search for.
|
|
</UL>
|
|
|
|
<UL><CODE>v</CODE> - Attribute value to search for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML element array that matched the criterias or null on failure.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getInstanceById"><!-- --></A>
|
|
<H3>getInstanceById</H3>
|
|
<PRE><a href="TinyMCE_Control.html">TinyMCE_Control</a> <B>getInstanceById</B>(<string> editor_id)</PRE>
|
|
|
|
<UL>Returns a TinyMCE editor instance by the specified editor id or null if it wasn't found.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Editor id to get instance for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
TinyMCE editor control instance or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getLang"><!-- --></A>
|
|
<H3>getLang</H3>
|
|
<PRE>object <B>getLang</B>(<string> name, <string> default_value, <boolean> parse_entities, <Array> va)</PRE>
|
|
|
|
<UL>Returns a language variable value from the language packs.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - Name of the key to retrive.
|
|
</UL>
|
|
|
|
<UL><CODE>default_value</CODE> - Optional default value to return if it wasn't found.
|
|
</UL>
|
|
|
|
<UL><CODE>parse_entities</CODE> - Is HTML entities to be resolved or not.
|
|
</UL>
|
|
|
|
<UL><CODE>va</CODE> - Optional name/value array of variables to replace in language string.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Language string value could be a number if it's a relative dimenstion.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getNodeTree"><!-- --></A>
|
|
<H3>getNodeTree</H3>
|
|
<PRE>Array <B>getNodeTree</B>(&l<int> t;HTMLNode> n, <Array> na, t, <string> nn)</PRE>
|
|
|
|
<UL>Returns a array of nodes selected retrived from the child nodes of the specified node.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Node to get children from.
|
|
</UL>
|
|
|
|
<UL><CODE>na</CODE> - Array to fill with children.
|
|
</UL>
|
|
|
|
<UL><CODE>t</CODE> - Node type to get.
|
|
</UL>
|
|
|
|
<UL><CODE>nn</CODE> - Node name of items to retrive.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Node array.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getOuterHTML"><!-- --></A>
|
|
<H3>getOuterHTML</H3>
|
|
<PRE>string <B>getOuterHTML</B>(<HTMLElement> e)</PRE>
|
|
|
|
<UL>Returns the outer HTML of a element, this uses the outerHTML
|
|
property in MSIE and Opera and a workaround for Gecko.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML element to get outerHTML from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML content string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getParam"><!-- --></A>
|
|
<H3>getParam</H3>
|
|
<PRE>object <B>getParam</B>(<string> name, <string> default_value, <boolean> strip_whitespace, <string> split_chr)</PRE>
|
|
|
|
<UL>Returns a specific configuration setting or the default value if it wasn't found.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - Configuration setting to get.
|
|
</UL>
|
|
|
|
<UL><CODE>default_value</CODE> - Default value to return if it wasn't found.
|
|
</UL>
|
|
|
|
<UL><CODE>strip_whitespace</CODE> - Optional remove all whitespace.
|
|
</UL>
|
|
|
|
<UL><CODE>split_chr</CODE> - Split char/regex/string.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Number, string or other object based in parameter and default_value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getParentBlockElement"><!-- --></A>
|
|
<H3>getParentBlockElement</H3>
|
|
<PRE>HTMLElement <B>getParentBlockElement</B>(<HTMLNode> n)</PRE>
|
|
|
|
<UL>Returns the first block element parent of the specified node.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Node get parent block element for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
First block element parent of the specified node or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getParentElement"><!-- --></A>
|
|
<H3>getParentElement</H3>
|
|
<PRE>HTMLElement <B>getParentElement</B>(<HTMLNode> node, <string> names, <string> attrib_name, <string> attrib_value)</PRE>
|
|
|
|
<UL>Returns the parent element of the specified node based on the search criteria.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>node</CODE> - Node to get parent element of.
|
|
</UL>
|
|
|
|
<UL><CODE>names</CODE> - Comma separated list of element names to get.
|
|
</UL>
|
|
|
|
<UL><CODE>attrib_name</CODE> - Optional attribute name to match.
|
|
</UL>
|
|
|
|
<UL><CODE>attrib_value</CODE> - Optional attribute value to match.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTMLElement or null based on search criteras.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getParentNode"><!-- --></A>
|
|
<H3>getParentNode</H3>
|
|
<PRE>DOMNode <B>getParentNode</B>(<DOMNode> n, <function> f)</PRE>
|
|
|
|
<UL>Returns a node by the specified selector function. This function will
|
|
loop through all parent nodes and call the specified function for each node.
|
|
If the function then returns true it will stop the execution and return that node.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - HTML node to search parents on.
|
|
</UL>
|
|
|
|
<UL><CODE>f</CODE> - Selection function to execute on each node.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
DOMNode or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getVisualAidClass"><!-- --></A>
|
|
<H3>getVisualAidClass</H3>
|
|
<PRE>string <B>getVisualAidClass</B>(<string> class_name, <boolean> state)</PRE>
|
|
|
|
<UL>Returns the visual aid class string, this will add/remove the visual aid class.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>class_name</CODE> - Class name value to add/remove visual aid classes from.
|
|
</UL>
|
|
|
|
<UL><CODE>state</CODE> - true/false if the classes should be added or removed.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
New class value containing the visual aid classes or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="getWindowArg"><!-- --></A>
|
|
<H3>getWindowArg</H3>
|
|
<PRE>Object <B>getWindowArg</B>(<string> n, d)</PRE>
|
|
|
|
<UL>Returns the window argument to be passed to TinyMCE popup.
|
|
TinyMCE_Engine.prototype.Use = tinyMCEPopup;.getWindowArg instead.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Window argument name.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Argument value or default value if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I></I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="handleEvent"><!-- --></A>
|
|
<H3>handleEvent</H3>
|
|
<PRE>boolean <B>handleEvent</B>(<DOMEvent> e)</PRE>
|
|
|
|
<UL>Event handler function that gets executed each time a event occurs in a TinyMCE editor control instance.
|
|
TinyMCE_Engine.prototype.Todo = Fix;the return statements so they return true or false.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - DOM event object reference.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true - if the event is to be chained, false - if the event chain is to be canceled.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="handleVisualAid"><!-- --></A>
|
|
<H3>handleVisualAid</H3>
|
|
<PRE>void <B>handleVisualAid</B>(<HTMLElement> el, <boolean> deep, <boolean> state, <<a href="TinyMCE_Control.html">TinyMCE_Control</a>> inst, skip_dispatch)</PRE>
|
|
|
|
<UL>Adds visual aid classes to all elements that need them recursive in the DOM tree.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>el</CODE> - HTML element to add visual aid classes to.
|
|
</UL>
|
|
|
|
<UL><CODE>deep</CODE> - Should they be added to all children aswell.
|
|
</UL>
|
|
|
|
<UL><CODE>state</CODE> - Should they be added or removed.
|
|
</UL>
|
|
|
|
<UL><CODE>inst</CODE> - TinyMCE editor control instance to add/remove them to/from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="hasMenu"><!-- --></A>
|
|
<H3>hasMenu</H3>
|
|
<PRE>boolean <B>hasMenu</B>(<string> n)</PRE>
|
|
|
|
<UL>Checks if the specified menu by name is added to TinyMCE.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - TinyMCE menu id.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if it exists or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="hasPlugin"><!-- --></A>
|
|
<H3>hasPlugin</H3>
|
|
<PRE>boolean <B>hasPlugin</B>(<string> n)</PRE>
|
|
|
|
<UL>Returns true/false if the specified plugin is loaded or not.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Plugin name to look for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if the specified plugin is loaded or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="hasTheme"><!-- --></A>
|
|
<H3>hasTheme</H3>
|
|
<PRE>boolean <B>hasTheme</B>(<string> n)</PRE>
|
|
|
|
<UL>Returns true/false if the specified theme is loaded or not.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Theme name/id to check for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if the specified theme is loaded or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="importCSS"><!-- --></A>
|
|
<H3>importCSS</H3>
|
|
<PRE>void <B>importCSS</B>(<DOMDocument> doc, <string> css)</PRE>
|
|
|
|
<UL>Imports a CSS file into a allready loaded document. This will add a link element
|
|
to the head element of the document.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>doc</CODE> - DOM Document to load CSS into.
|
|
</UL>
|
|
|
|
<UL><CODE>css</CODE> - CSS File URL to load or comma separated list of files.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="importPluginLanguagePack"><!-- --></A>
|
|
<H3>importPluginLanguagePack</H3>
|
|
<PRE>void <B>importPluginLanguagePack</B>(<string> name, <string> valid_languages)</PRE>
|
|
|
|
<UL>Loads a plugin specific language pack.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - Plugin name/id to load language pack for.
|
|
</UL>
|
|
|
|
<UL><CODE>valid_languages</CODE> - Comma separated list of valid languages for the plugin.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="importThemeLanguagePack"><!-- --></A>
|
|
<H3>importThemeLanguagePack</H3>
|
|
<PRE>void <B>importThemeLanguagePack</B>(<string> name)</PRE>
|
|
|
|
<UL>Loads a theme specific language pack.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>name</CODE> - Optional name of the theme to load language pack from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="init"><!-- --></A>
|
|
<H3>init</H3>
|
|
<PRE>void <B>init</B>(settings)</PRE>
|
|
|
|
<UL>Initializes TinyMCE with the specific configuration settings. This method
|
|
may be called multiple times when multiple instances with diffrent settings is to be created.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>Name</CODE> - /Value array of initialization settings.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="insertAfter"><!-- --></A>
|
|
<H3>insertAfter</H3>
|
|
<PRE>void <B>insertAfter</B>(<HTMLNode> n, <HTMLNode> r)</PRE>
|
|
|
|
<UL>Inserts a node after the specific node.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - New node to insert.
|
|
</UL>
|
|
|
|
<UL><CODE>r</CODE> - Reference node to insert after.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="isBlockElement"><!-- --></A>
|
|
<H3>isBlockElement</H3>
|
|
<PRE>boolean <B>isBlockElement</B>(<HTMLNode> n)</PRE>
|
|
|
|
<UL>Returns true/false if the specified node is a block element or not.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Node to verify.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if the specified node is a block element or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="isInstance"><!-- --></A>
|
|
<H3>isInstance</H3>
|
|
<PRE>boolean <B>isInstance</B>(<object> o)</PRE>
|
|
|
|
<UL>Returns true/false if a specific object is a TinyMCE_Control instance or not.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>o</CODE> - Object to check.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true/false if it's a control or not.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="loadCSS"><!-- --></A>
|
|
<H3>loadCSS</H3>
|
|
<PRE>void <B>loadCSS</B>(<string> url)</PRE>
|
|
|
|
<UL>Loads the specified CSS by writing the a link tag to the current page.
|
|
This will also check if the file has been loaded before. This function should only be used
|
|
when the page is loading.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>url</CODE> - CSS file URL to load or comma separated list of files.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="loadPlugin"><!-- --></A>
|
|
<H3>loadPlugin</H3>
|
|
<PRE>void <B>loadPlugin</B>(<string> n, <string> u)</PRE>
|
|
|
|
<UL>Load plugin from external URL.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Plugin name for example \"emotions\".
|
|
</UL>
|
|
|
|
<UL><CODE>u</CODE> - URL of plugin directory to load.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="loadScript"><!-- --></A>
|
|
<H3>loadScript</H3>
|
|
<PRE>void <B>loadScript</B>(<string> url)</PRE>
|
|
|
|
<UL>Loads the specified script by writing the a script tag to the current page.
|
|
This will also check if the file has been loaded before. This function should only be used
|
|
when the page is loading.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>url</CODE> - Script URL to load.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="nextNode"><!-- --></A>
|
|
<H3>nextNode</H3>
|
|
<PRE>HTMLElement <B>nextNode</B>(<HTMLNode> e, <string> n)</PRE>
|
|
|
|
<UL>Finds any element after the current one by name. This will loop through the siblings
|
|
inorder to find the specified element by name. If the element wasn't found
|
|
it will return a null value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML node to search from.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Comma separated list of element names to search for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML Element or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="onLoad"><!-- --></A>
|
|
<H3>onLoad</H3>
|
|
<PRE>boolean <B>onLoad</B>()</PRE>
|
|
|
|
<UL>Gets executed when the page loads or get intitialized. This function will then convert all textareas/divs that
|
|
is to be converted into TinyMCE editor controls.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
true - if the event is to be chained, false - if the event chain is to be canceled.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="onMouseMove"><!-- --></A>
|
|
<H3>onMouseMove</H3>
|
|
<PRE>void <B>onMouseMove</B>()</PRE>
|
|
|
|
<UL>Mouse move handler function, this will be executed each time
|
|
the mouse is moved within a editor instance. This function stores away the current selection in MSIE
|
|
this will then be used when a undo/redo level is added.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="openWindow"><!-- --></A>
|
|
<H3>openWindow</H3>
|
|
<PRE>void <B>openWindow</B>(<Array> template, <Array> args)</PRE>
|
|
|
|
<UL>Opens a popup window based in the specified input data. This function
|
|
is used for all popup windows in TinyMCE.
|
|
|
|
These are the current template TinyMCE_Engine.prototype.keys = file; width, height, close_previous.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>template</CODE> - Popup template data such as with, height etc.
|
|
</UL>
|
|
|
|
<UL><CODE>args</CODE> - Popup arguments that is to be passed to the popup such as custom data.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="parseStyle"><!-- --></A>
|
|
<H3>parseStyle</H3>
|
|
<PRE>Array <B>parseStyle</B>(<string> str)</PRE>
|
|
|
|
<UL>Parses the specified HTML style data. This will parse for example
|
|
"border-left: 1px; background-color: red" into an key/value array.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>str</CODE> - Style data to parse.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Name/Value array of style items.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="parseURL"><!-- --></A>
|
|
<H3>parseURL</H3>
|
|
<PRE>TinyMCE_URL_Item <B>parseURL</B>(<string> url_str)</PRE>
|
|
|
|
<UL>Parses a URL in to its diffrent components.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>url_str</CODE> - URL string to parse into a URL object.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
URL object based on input string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="prevNode"><!-- --></A>
|
|
<H3>prevNode</H3>
|
|
<PRE>HTMLElement <B>prevNode</B>(<HTMLNode> e, <string> n)</PRE>
|
|
|
|
<UL>Finds any previous element by name. This will loop through the siblings
|
|
inorder to find the specified element by name. If the element wasn't found
|
|
it will return a null value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML node to search from.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - Comma separated list of element names to search for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML Element or null if it wasn't found.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="queryInstanceCommandState"><!-- --></A>
|
|
<H3>queryInstanceCommandState</H3>
|
|
<PRE>boolean <B>queryInstanceCommandState</B>(<string> editor_id, <string> command)</PRE>
|
|
|
|
<UL>Queries a command state for a specific command on a specific editor instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Editor id to query command state on.
|
|
</UL>
|
|
|
|
<UL><CODE>command</CODE> - Command to query for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Command state passed from browser.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="queryInstanceCommandValue"><!-- --></A>
|
|
<H3>queryInstanceCommandValue</H3>
|
|
<PRE>object <B>queryInstanceCommandValue</B>(<string> editor_id, <string> command)</PRE>
|
|
|
|
<UL>Queries a command value for a specific command on a specific editor instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Editor id to query command value on.
|
|
</UL>
|
|
|
|
<UL><CODE>command</CODE> - Command to query for.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Command value passed from browser.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="regexpReplace"><!-- --></A>
|
|
<H3>regexpReplace</H3>
|
|
<PRE>string <B>regexpReplace</B>(<string> in_str, <string> reg_exp, <string> replace_str, opts)</PRE>
|
|
|
|
<UL>Regexp replaces the contents of a string. Use normal replace instead.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>in_str</CODE> - String to replace in.
|
|
</UL>
|
|
|
|
<UL><CODE>in_str</CODE> - Optional regexp options like "gi".
|
|
</UL>
|
|
|
|
<UL><CODE>reg_exp</CODE> - Regexp to replace.
|
|
</UL>
|
|
|
|
<UL><CODE>replace_str</CODE> - String to replace with.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Replaced string value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I></I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="removeCSSClass"><!-- --></A>
|
|
<H3>removeCSSClass</H3>
|
|
<PRE>string <B>removeCSSClass</B>(<HTMLElement> e, c)</PRE>
|
|
|
|
<UL>Removes the specified CSS class from the element.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML element to remove CSS class to.
|
|
</UL>
|
|
|
|
<UL><CODE>string</CODE> - ] c CSS class to remove to HTML element.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Returns the new class attribute value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="removeMCEControl"><!-- --></A>
|
|
<H3>removeMCEControl</H3>
|
|
<PRE>void <B>removeMCEControl</B>(<string> editor_id)</PRE>
|
|
|
|
<UL>Removes a TinyMCE editor control instance by id.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - Id of editor instance to remove.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="removeTinyMCEFormElements"><!-- --></A>
|
|
<H3>removeTinyMCEFormElements</H3>
|
|
<PRE>void <B>removeTinyMCEFormElements</B>(<HTMLElement> form_obj)</PRE>
|
|
|
|
<UL>Removes/disables TinyMCE built in form elements such as select boxes for font sizes etc.
|
|
These are disabled when the user submits a form so they don't get picked up by the backend script
|
|
that intercepts the contents.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>form_obj</CODE> - Form object to loop through for TinyMCE specific form elements.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="renameElement"><!-- --></A>
|
|
<H3>renameElement</H3>
|
|
<PRE>void <B>renameElement</B>(<HTMLElement> e, <string> n, <DOMDocument> d)</PRE>
|
|
|
|
<UL>Renames the specified element to the specified name.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - Element to rename.
|
|
</UL>
|
|
|
|
<UL><CODE>n</CODE> - New name of the element.
|
|
</UL>
|
|
|
|
<UL><CODE>d</CODE> - Optional document reference.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="replaceVar"><!-- --></A>
|
|
<H3>replaceVar</H3>
|
|
<PRE>string <B>replaceVar</B>(<string> h, <string> r, <string> v)</PRE>
|
|
|
|
<UL>Replaces a specific variable in the string with a nother string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>h</CODE> - String to search in for the variable.
|
|
</UL>
|
|
|
|
<UL><CODE>r</CODE> - Variable name to search for.
|
|
</UL>
|
|
|
|
<UL><CODE>v</CODE> - Value to insert where a variable is found.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
String with replaced variable.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="resetForm"><!-- --></A>
|
|
<H3>resetForm</H3>
|
|
<PRE>void <B>resetForm</B>(<int> form_index)</PRE>
|
|
|
|
<UL>Resets a forms TinyMCE instances based on form index.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>form_index</CODE> - Form index to reset.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="selectNodes"><!-- --></A>
|
|
<H3>selectNodes</H3>
|
|
<PRE>Array <B>selectNodes</B>(<DOMNode> n, <function> f, <Array> a)</PRE>
|
|
|
|
<UL>Returns a array of nodes when the specified function matches a node.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Node to select children from.
|
|
</UL>
|
|
|
|
<UL><CODE>f</CODE> - Function that returns true/false if the node is to be added or not.
|
|
</UL>
|
|
|
|
<UL><CODE>a</CODE> - Optional array to fill with nodes.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Array with selected nodes.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="serializeStyle"><!-- --></A>
|
|
<H3>serializeStyle</H3>
|
|
<PRE>string <B>serializeStyle</B>(<Array> ar)</PRE>
|
|
|
|
<UL>Serializes the specified style item name/value array into a HTML string. This function
|
|
will force HEX colors in Firefox and convert the URL items of a style correctly.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>ar</CODE> - Name/Value array of items to serialize.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Serialized HTML string containing the items.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="serializeURL"><!-- --></A>
|
|
<H3>serializeURL</H3>
|
|
<PRE>string <B>serializeURL</B>(<TinyMCE_URL_Item> up)</PRE>
|
|
|
|
<UL>Serializes the specified URL object into a string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>up</CODE> - URL object to serialize.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Serialized URL object.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setAttrib"><!-- --></A>
|
|
<H3>setAttrib</H3>
|
|
<PRE>void <B>setAttrib</B>(<HTMLElement> element, <string> name, <string> value, <boolean> fix_value)</PRE>
|
|
|
|
<UL>Sets the attribute value for a specific attribute.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>element</CODE> - HTML element to set attribute on.
|
|
</UL>
|
|
|
|
<UL><CODE>name</CODE> - Attribute name to set.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - Attribute value to set.
|
|
</UL>
|
|
|
|
<UL><CODE>fix_value</CODE> - Optional fix value state, if true only number data will be accepted.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setContent"><!-- --></A>
|
|
<H3>setContent</H3>
|
|
<PRE>void <B>setContent</B>(<string> h)</PRE>
|
|
|
|
<UL>Sets the HTML contents of the selected editor instance.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>h</CODE> - HTML contents to set in the selected instance.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I></I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setInnerHTML"><!-- --></A>
|
|
<H3>setInnerHTML</H3>
|
|
<PRE>void <B>setInnerHTML</B>(<HTMLElement> e, <string> h)</PRE>
|
|
|
|
<UL>Sets the innerHTML property of a element, this function also
|
|
fixes a MSIE bug where the first comment is removed.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - Element to insert HTML in.
|
|
</UL>
|
|
|
|
<UL><CODE>h</CODE> - HTML code to insert into innerHTML.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setOuterHTML"><!-- --></A>
|
|
<H3>setOuterHTML</H3>
|
|
<PRE>void <B>setOuterHTML</B>(<HTMLElement> e, <string> h)</PRE>
|
|
|
|
<UL>Sets the outer HTML of a element, this uses the outerHTML
|
|
property in MSIE and Opera and a workaround for Gecko.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>e</CODE> - HTML element to set outerHTML on.
|
|
</UL>
|
|
|
|
<UL><CODE>h</CODE> - HTML string to set in property.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setPluginBaseURL"><!-- --></A>
|
|
<H3>setPluginBaseURL</H3>
|
|
<PRE>void <B>setPluginBaseURL</B>(<string> n, <string> u)</PRE>
|
|
|
|
<UL>Sets the baseURL of the specified plugin, this is useful if the plugin is loaded from
|
|
a external location.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Plugin name/id to set base URL on. This have to be added before.
|
|
</UL>
|
|
|
|
<UL><CODE>u</CODE> - Base URL of plugin, this string should be the URL prefix for the plugin without a trailing slash.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setStyleAttrib"><!-- --></A>
|
|
<H3>setStyleAttrib</H3>
|
|
<PRE>void <B>setStyleAttrib</B>(<HTMLElement> elm, <string> name, <string> value)</PRE>
|
|
|
|
<UL>Sets a style attribute item value.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>elm</CODE> - HTML element to set style attribute item on.
|
|
</UL>
|
|
|
|
<UL><CODE>name</CODE> - Style item name to set.
|
|
</UL>
|
|
|
|
<UL><CODE>value</CODE> - Style item value to set.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setupContent"><!-- --></A>
|
|
<H3>setupContent</H3>
|
|
<PRE>void <B>setupContent</B>(<string> editor_id)</PRE>
|
|
|
|
<UL>Setups the contents of TinyMCE editor instance and fills it with contents.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>editor_id</CODE> - TinyMCE editor instance control id to fill.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="setWindowArg"><!-- --></A>
|
|
<H3>setWindowArg</H3>
|
|
<PRE>void <B>setWindowArg</B>(<string> n, <string> v)</PRE>
|
|
|
|
<UL>Sets the window argument to be passed to TinyMCE popup.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>n</CODE> - Window argument name.
|
|
</UL>
|
|
|
|
<UL><CODE>v</CODE> - Window argument value.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="storeAwayURLs"><!-- --></A>
|
|
<H3>storeAwayURLs</H3>
|
|
<PRE>string <B>storeAwayURLs</B>(<string> s)</PRE>
|
|
|
|
<UL>Stores away the src and href attribute values in separate mce_src and mce_href attributes.
|
|
This is needed since both MSIE and Gecko messes with these attributes. The old
|
|
src and href will be intact, this simply adds them to a separate attribute.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - HTML string to replace src and href attributes in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
HTML string with replaced src and href attributes.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="submitPatch"><!-- --></A>
|
|
<H3>submitPatch</H3>
|
|
<PRE>void <B>submitPatch</B>()</PRE>
|
|
|
|
<UL>Piggyback onsubmit event handler function, this will remove/hide the TinyMCE specific form elements
|
|
call triggerSave to fill the textarea with the correct contents then call the old piggy backed event handler.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="switchClass"><!-- --></A>
|
|
<H3>switchClass</H3>
|
|
<PRE>void <B>switchClass</B>(<HTMLElement> ei, <string> c)</PRE>
|
|
|
|
<UL>Switches the CSS class of the specified element. This method also caches the
|
|
elements in a lookup table for performance. This should only be used for TinyMCE main UI controls
|
|
like buttons or select elements.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>ei</CODE> - Element to set CSS class on.
|
|
</UL>
|
|
|
|
<UL><CODE>c</CODE> - CSS class to set.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="triggerNodeChange"><!-- --></A>
|
|
<H3>triggerNodeChange</H3>
|
|
<PRE>void <B>triggerNodeChange</B>(<boolean> focus, <boolean> setup_content)</PRE>
|
|
|
|
<UL>Triggers a nodeChange event to every theme and plugin. This will be executed when the cursor moves or
|
|
when a command that modifies the editor contents is executed.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>focus</CODE> - Optional state if the last selected editor instance is to be focused or not.
|
|
</UL>
|
|
|
|
<UL><CODE>setup_content</CODE> - Optional state if it's called from setup content function or not.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="triggerSave"><!-- --></A>
|
|
<H3>triggerSave</H3>
|
|
<PRE>void <B>triggerSave</B>(<boolean> skip_cleanup, <boolean> skip_callback)</PRE>
|
|
|
|
<UL>Moves the contents from a TinyMCE editor control instance to the hidden textarea
|
|
that got replaced with TinyMCE. This is executed automaticly on for example form submit.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>skip_cleanup</CODE> - Optional Skip cleanup, simply move the contents as fast as possible.
|
|
</UL>
|
|
|
|
<UL><CODE>skip_callback</CODE> - Optional Skip callback, don't call the save_callback function.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="trim"><!-- --></A>
|
|
<H3>trim</H3>
|
|
<PRE>string <B>trim</B>(<string> s)</PRE>
|
|
|
|
<UL>Removes all prefix, suffix whitespace of a string.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - String to replace whitespace in.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
Replaced string value.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="unloadHandler"><!-- --></A>
|
|
<H3>unloadHandler</H3>
|
|
<PRE>void <B>unloadHandler</B>()</PRE>
|
|
|
|
<UL>Unload document event handler function. This function will be executed when the
|
|
page is unloaded, this will automaticly move the current editor contents to the textarea element this enables
|
|
the editor to restore it's state when the user presses the back button in the browser.
|
|
This will execute the triggerSave function.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="updateContent"><!-- --></A>
|
|
<H3>updateContent</H3>
|
|
<PRE>void <B>updateContent</B>(<string> form_element_name)</PRE>
|
|
|
|
<UL>Moves the contents from the hidden textarea to the editor that gets inserted.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>form_element_name</CODE> - Form element name to move contents from.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<UL>
|
|
<B>Deprecated</B> <I></I><BR/><BR/>
|
|
</UL>
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
<A NAME="xmlEncode"><!-- --></A>
|
|
<H3>xmlEncode</H3>
|
|
<PRE>string <B>xmlEncode</B>(<string> s)</PRE>
|
|
|
|
<UL>Encodes the string to raw XML entities. This will only convert the most common ones.
|
|
For real entity encoding use the xmlEncode method of the Cleanup class.</UL>
|
|
|
|
|
|
<!-- METHOD PARAMETERS START -->
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>s</CODE> - String to encode.
|
|
</UL>
|
|
|
|
</UL>
|
|
|
|
<!-- METHOD PARAMETERS END -->
|
|
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
XML Encoded string.
|
|
</UL>
|
|
</UL>
|
|
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
<HR>
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-TinyMCE_Engine.class.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B></B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="TinyMCE_Control.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="TinyMCE_Layer.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="TinyMCE_Engine.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<FONT SIZE="-1">
|
|
|
|
</FONT>
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Fri Apr 14 21:59:23 2006</div>
|
|
</BODY>
|
|
</HTML>
|