<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
<!--\r
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.\r
For licensing, see LICENSE.html or http://ckeditor.com/license\r
-->\r
<html xmlns="http://www.w3.org/1999/xhtml">\r
<head>\r
- <title>Sample - CKEditor</title>\r
- <meta content="text/html; charset=utf-8" http-equiv="content-type"/>\r
+ <title>API Usage — CKEditor Sample</title>\r
+ <meta content="text/html; charset=utf-8" http-equiv="content-type" />\r
<script type="text/javascript" src="../ckeditor.js"></script>\r
<script src="sample.js" type="text/javascript"></script>\r
- <link href="sample.css" rel="stylesheet" type="text/css"/>\r
- <script id="headscript" type="text/javascript">\r
+ <link href="sample.css" rel="stylesheet" type="text/css" />\r
+ <script type="text/javascript">\r
//<![CDATA[\r
\r
-// The instanceReady event is fired when an instance of CKEditor has finished\r
+// The instanceReady event is fired, when an instance of CKEditor has finished\r
// its initialization.\r
CKEDITOR.on( 'instanceReady', function( ev )\r
- {\r
- // Show the editor name and description in the browser status bar.\r
- document.getElementById('eMessage').innerHTML = '<p>Instance "' + ev.editor.name + '" loaded.<\/p>' ;\r
+{\r
+ // Show the editor name and description in the browser status bar.\r
+ document.getElementById( 'eMessage' ).innerHTML = '<p>Instance <code>' + ev.editor.name + '<\/code> loaded.<\/p>';\r
\r
- // Show this sample buttons.\r
- document.getElementById('eButtons').style.visibility = '' ;\r
- });\r
+ // Show this sample buttons.\r
+ document.getElementById( 'eButtons' ).style.display = 'block';\r
+});\r
\r
function InsertHTML()\r
{\r
// Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
- var value = document.getElementById( 'plainArea' ).value ;\r
+ var oEditor = CKEDITOR.instances.editor1;\r
+ var value = document.getElementById( 'htmlArea' ).value;\r
+\r
+ // Check the active editing mode.\r
+ if ( oEditor.mode == 'wysiwyg' )\r
+ {\r
+ // Insert HTML code.\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#insertHtml\r
+ oEditor.insertHtml( value );\r
+ }\r
+ else\r
+ alert( 'You must be in WYSIWYG mode!' );\r
+}\r
+\r
+function InsertText()\r
+{\r
+ // Get the editor instance that we want to interact with.\r
+ var oEditor = CKEDITOR.instances.editor1;\r
+ var value = document.getElementById( 'txtArea' ).value;\r
\r
// Check the active editing mode.\r
- if (oEditor.mode == 'wysiwyg' )\r
+ if ( oEditor.mode == 'wysiwyg' )\r
{\r
- // Insert the desired HTML.\r
- oEditor.insertHtml( value ) ;\r
+ // Insert as plain text.\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#insertText\r
+ oEditor.insertText( value );\r
}\r
else\r
- alert( 'You must be on WYSIWYG mode!' ) ;\r
+ alert( 'You must be in WYSIWYG mode!' );\r
}\r
\r
function SetContents()\r
{\r
// Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
- var value = document.getElementById( 'plainArea' ).value ;\r
+ var oEditor = CKEDITOR.instances.editor1;\r
+ var value = document.getElementById( 'htmlArea' ).value;\r
\r
- // Set the editor contents (replace the actual one).\r
- oEditor.setData( value ) ;\r
+ // Set editor contents (replace current contents).\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#setData\r
+ oEditor.setData( value );\r
}\r
\r
function GetContents()\r
{\r
- // Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
+ // Get the editor instance that you want to interact with.\r
+ var oEditor = CKEDITOR.instances.editor1;\r
\r
- // Get the editor contents\r
- alert( oEditor.getData() ) ;\r
+ // Get editor contents\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#getData\r
+ alert( oEditor.getData() );\r
}\r
\r
function ExecuteCommand( commandName )\r
{\r
// Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
+ var oEditor = CKEDITOR.instances.editor1;\r
\r
// Check the active editing mode.\r
- if (oEditor.mode == 'wysiwyg' )\r
+ if ( oEditor.mode == 'wysiwyg' )\r
{\r
// Execute the command.\r
- oEditor.execCommand( commandName ) ;\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#execCommand\r
+ oEditor.execCommand( commandName );\r
}\r
else\r
- alert( 'You must be on WYSIWYG mode!' ) ;\r
+ alert( 'You must be in WYSIWYG mode!' );\r
}\r
\r
function CheckDirty()\r
{\r
// Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
- alert( oEditor.checkDirty() ) ;\r
+ var oEditor = CKEDITOR.instances.editor1;\r
+ // Checks whether the current editor contents present changes when compared\r
+ // to the contents loaded into the editor at startup\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#checkDirty\r
+ alert( oEditor.checkDirty() );\r
}\r
\r
function ResetDirty()\r
{\r
// Get the editor instance that we want to interact with.\r
- var oEditor = CKEDITOR.instances.editor1 ;\r
- oEditor.resetDirty() ;\r
- alert( 'The "IsDirty" status has been reset' ) ;\r
+ var oEditor = CKEDITOR.instances.editor1;\r
+ // Resets the "dirty state" of the editor (see CheckDirty())\r
+ // http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html#resetDirty\r
+ oEditor.resetDirty();\r
+ alert( 'The "IsDirty" status has been reset' );\r
}\r
\r
//]]>\r
</script>\r
+\r
</head>\r
<body>\r
- <h1>\r
- CKEditor Sample\r
+ <h1 class="samples">\r
+ CKEditor Sample — Using CKEditor JavaScript API\r
</h1>\r
+ <div class="description">\r
+ <p>\r
+ This sample shows how to use the\r
+ <a class="samples" href="http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.editor.html">CKEditor JavaScript API</a>\r
+ to interact with the editor at runtime.\r
+ </p>\r
+ <p>\r
+ For details on how to create this setup check the source code of this sample page.\r
+ </p>\r
+ </div>\r
+\r
<!-- This <div> holds alert messages to be display in the sample page. -->\r
<div id="alerts">\r
<noscript>\r
</p>\r
</noscript>\r
</div>\r
- <!-- This <fieldset> holds the HTML that you will usually find in your\r
- pages. -->\r
<form action="sample_posteddata.php" method="post">\r
- <p>\r
- This sample shows how to use the CKeditor JavaScript API to interact with the editor\r
- at runtime.</p>\r
- <textarea cols="80" id="editor1" name="editor1" rows="10"><p>This is some <strong>sample text</strong>. You are using <a href="http://ckeditor.com/">CKEditor</a>.</p></textarea>\r
+ <textarea cols="100" id="editor1" name="editor1" rows="10"><p>This is some <strong>sample text</strong>. You are using <a href="http://ckeditor.com/">CKEditor</a>.</p></textarea>\r
+\r
<script type="text/javascript">\r
//<![CDATA[\r
// Replace the <textarea id="editor1"> with an CKEditor instance.\r
- var editor = CKEDITOR.replace( 'editor1');\r
+ var editor = CKEDITOR.replace( 'editor1' );\r
//]]>\r
</script>\r
- <div id="eMessage">\r
\r
+ <div id="eMessage">\r
</div>\r
- <div id="eButtons" style="visibility: hidden">\r
- <input onclick="InsertHTML();" type="button" value="Insert HTML"/>\r
- <input onclick="SetContents();" type="button" value="Set Editor Contents"/>\r
- <input onclick="GetContents();" type="button" value="Get Editor Contents (XHTML)"/>\r
- <br/>\r
- <textarea cols="80" id="plainArea" rows="3"><h2>Test</h2><p>This is some <a href="/Test1.html">sample</a> HTML</p></textarea>\r
- <br/>\r
- <br/>\r
- <input onclick="ExecuteCommand('bold');" type="button" value="Execute "bold" Command"/>\r
- <input onclick="ExecuteCommand('link');" type="button" value="Execute "link" Command"/>\r
- <br/>\r
- <br/>\r
- <input onclick="CheckDirty();" type="button" value="checkDirty()"/>\r
- <input onclick="ResetDirty();" type="button" value="resetDirty()"/>\r
+ <div id="eButtons" style="display: none">\r
+ <input onclick="InsertHTML();" type="button" value="Insert HTML" />\r
+ <input onclick="SetContents();" type="button" value="Set Editor Contents" />\r
+ <input onclick="GetContents();" type="button" value="Get Editor Contents (XHTML)" />\r
+ <br />\r
+ <textarea cols="100" id="htmlArea" rows="3"><h2>Test</h2><p>This is some <a href="/Test1.html">sample</a> HTML code.</p></textarea>\r
+ <br />\r
+ <br />\r
+ <input onclick="InsertText();" type="button" value="Insert Text" />\r
+ <br />\r
+ <textarea cols="100" id="txtArea" rows="3"> First line with some leading whitespaces.\r
+\r
+Second line of text preceded by two line breaks.</textarea>\r
+ <br />\r
+ <input onclick="ExecuteCommand('bold');" type="button" value="Execute "bold" Command" />\r
+ <input onclick="ExecuteCommand('link');" type="button" value="Execute "link" Command" />\r
+ <br />\r
+ <br />\r
+ <input onclick="CheckDirty();" type="button" value="checkDirty()" />\r
+ <input onclick="ResetDirty();" type="button" value="resetDirty()" />\r
</div>\r
- </form>\r
+ </form>\r
<div id="footer">\r
- <hr/>\r
+ <hr />\r
<p>\r
- CKEditor - The text editor for Internet - <a href="http://ckeditor.com/" shape="rect">http://ckeditor.com</a>\r
+ CKEditor - The text editor for the Internet - <a class="samples" href="http://ckeditor.com/">http://ckeditor.com</a>\r
</p>\r
<p id="copy">\r
- Copyright © 2003-2009, <a href="http://cksource.com/" shape="rect">CKSource</a> - Frederico Knabben. All rights reserved.\r
+ Copyright © 2003-2012, <a class="samples" href="http://cksource.com/">CKSource</a> - Frederico\r
+ Knabben. All rights reserved.\r
</p>\r
</div>\r
</body>\r
Got questions, comments, patches, etc.? Contact Jason Woofenden