CKEditor 3.x/Developers Guide/Java/Integration - Revision history

Anna: Source code formatting changed

2011-08-03T08:06:05Z

Source code formatting changed

Anna: /* Common Tag Attributes */ Proof-reading of the new toolbar definition, source code formatting changed

2011-08-03T08:03:06Z

‎Common Tag Attributes: Proof-reading of the new toolbar definition, source code formatting changed

J.swiderski at 14:45, 2 August 2011

2011-08-02T14:45:33Z

J.swiderski at 14:37, 2 August 2011

2011-08-02T14:37:10Z

Wiktor: emoved note about maven2

2011-05-03T06:48:06Z

emoved note about maven2

Wiktor: Added system requirements

2011-05-02T21:35:00Z

Added system requirements

Wiktor: removed empty line

2011-05-02T18:24:14Z

removed empty line

Wiktor: Reorganized the docuemntation

2011-05-02T18:23:39Z

Reorganized the docuemntation

Show changes

Wiktor: updated information about manual installation

2011-05-02T15:27:10Z

updated information about manual installation

Wiktor at 15:22, 2 May 2011

2011-05-02T15:22:50Z

@@ Line 33: / Line 33: @@
 To start using <code><ckeditor></code> tags in your JSP page, you need to declare the CKEditor tag library inside it:
-<source lang="html4strict">
+<source lang="java">
 <%@ taglib uri="http://ckeditor.com" prefix="ckeditor" %>
 </source>
@@ Line 62: / Line 62: @@
 Next you have to add the CKEditor tag (<code><ckeditor:replace></code> in this case) to the page. It is recommended to add it at the end, just before the closing <code></body></code> tag:
-<source lang="html4strict">
+<source lang="java">
 <ckeditor:replace replace="editor1" basePath="/ckeditor/" />
 </source>
@@ Line 97: / Line 97: @@
 === Replacing All Textarea Elements ===
 The <code><ckeditor:replaceAll></code> tag replaces all <code>textarea</code> elements available in the document with editor instances. Optionally it can replace only the <code>textarea</code> elements that have a CSS class equal to the value of the CKEditor <code>className</code> attribute.
-<source lang="html4strict">
+<source lang="java">
 <ckeditor:replaceAll basePath="/ckeditor/" className="myclass"/>
 </source>
@@ Line 105: / Line 105: @@
 === Creating a CKEditor Instance ===
 The <code><ckeditor:editor></code> tag creates a CKEditor instance.
-<source lang="html4strict">
+<source lang="java">
 <ckeditor:editor textareaAttributes="<%=attr %>" basePath="/ckeditor/" editor="editor1" value="Type here" />
 </source>
@@ Line 114: / Line 114: @@
 * <code>value</code> &ndash; is the default <code>textarea</code> element value.
 * <code>textareaAttributes</code> &ndash; is a <code>java.util.Map</code> with textarea attribute names serving as map keys, and attribute values serving as map values. For example:
-<source lang="html4strict">
+<source lang="java">
 <%
 	Map<String, String> attr = new HashMap<String, String>();
@@ Line 275: / Line 275: @@
 To access this class on a JSP page you can use the following expression:
-<source lang="html4strict">
+<source lang="java">
 <ckeditor:replace replace="editor1" basePath="ckeditor/"
     config="<%= ConfigurationHelper.createConfig() %>"

@@ Line 134: / Line 134: @@
 Configuration options are stored in the <code>CKEditorConfig</code> object. They are added by using the <code>addConfigValue</code> method:
-<source lang="html4strict">
+<source lang="java">
 <%
 	CKEditorConfig settings = new CKEditorConfig();
@@ Line 143: / Line 143: @@
 The first parameter of this method is always the name of a configuration option in the form of a string. The second one is the value of this option for which a String, Boolean, Number, List, or Map object can be used. No matter what type is used, CKEditor will try to map each value to an acceptable form. For example, the code below:
-<source lang="html4strict">
+<source lang="java">
 <%
 	CKEditorConfig settings = new CKEditorConfig();
@@ Line 150: / Line 150: @@
 </source>
 is equal to:
-<source lang="html4strict">
+<source lang="java">
 <%
 	CKEditorConfig settings = new CKEditorConfig();
@@ Line 163: / Line 163: @@
 %>
 </source>
-Additional note about toolbar.<br/>
+==== New CKEditor 3.6 Toolbar Syntax ====
-As of CKEditor 3.6, what is described [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Toolbar here], toolbar can be divided into sections. Each section has its own name and a set of items. The new definition can also be expressed in two ways.
+As of CKEditor 3.6, toolbar buttons can be [[CKEditor_3.x/Developers_Guide/Toolbar#Toolbar_Button_Groups|organized into groups]]. Each group has its own name and a set of buttons that it includes. The new definition can also be expressed in two ways.
-The below code:
-<source lang="html4strict">
+The code below:
 <%
 	CKEditorConfig settings = new CKEditorConfig();
@@ Line 174: / Line 175: @@
 </source>
 is equal to:
-<source lang="html4strict">
+<source lang="java">
 <%
 	CKEditorConfig settings = new CKEditorConfig();
@@ Line 209: / Line 210: @@
 ==== Example: ====
 Firstly, an instance of the <code>EventHandler</code> has to be created. Then you can add events by using the <code>addEvent</code> method, where the first parameter is the CKEditor event keyword and the second one is the JavaScript function in the form of a concatenated string.
-<source lang="html4strict">
+<source lang="java">
 <%
 	EventHandler eventHandler = new EventHandler();
@@ Line 217: / Line 218: @@
 In order to use the events on a page, the following expression can be added:
-<source lang="html4strict">
+<source lang="java">
 <ckeditor:editor basePath="/ckeditor/" editor="editor1" events="<%=eventHandler %>"/>
 </source>
@@ Line 223: / Line 224: @@
 === <code>globalEvents</code> ===
 <code>globalEvents</code> &ndash; this parameter stores the list of client-side event listeners that are used by all CKEditor instances and is of <code>GlobalEventHandler</code> type.
-<source lang="html4strict">
+<source lang="java">
 <%
 	GlobalEventHandler globalEventHandler = new GlobalEventHandler();

@@ Line 164: / Line 164: @@
 </source>
 Additional note about toolbar.<br/>
-As of CKEditor 3.6, what is described [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Toolbar here], toolbar can be divided into sections. Each section has its own name and a set of items. It can be also expressed in two ways.
+As of CKEditor 3.6, what is described [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Toolbar here], toolbar can be divided into sections. Each section has its own name and a set of items. The new definition can also be expressed in two ways.
 The below code:
 <source lang="html4strict">

@@ Line 161: / Line 161: @@
 	list.add(subList);
 	settings.addConfigValue("toolbar", list);
 %>
 </source>

@@ Line 14: / Line 14: @@
 === Using Maven2 ===
 If your application uses Maven, you can add the following dependency to your <code>pom.xml</code> file:
 <source lang="xml">

← Older revision		Revision as of 21:35, 2 May 2011
Line 1:		Line 1:
		+	== System Requirements ==
		+	Please note that you need at least <strong> JRE 1.4 and Servlet 2.5/JSP 2.1</strong> to use the integration.
		+
	= Installation =		= Installation =
	Adding CKEditor to your application is a two-step process that entails:		Adding CKEditor to your application is a two-step process that entails:

@@ Line 1: / Line 1: @@
 = Installation =
 Adding CKEditor to your application is a two-step process that entails:
@@ Line 246: / Line 245: @@
     events="<%= ConfigurationHelper.createEventHandlers() %>" />
 </source>

@@ Line 11: / Line 11: @@
 === Using Maven2 ===
-<note>The following method is not yet available, please follow the manual installation.
+<note>The following method is not yet available, please follow the manual installation procedure.
 </note>
 If your application uses Maven, you can add the following dependency to your <code>pom.xml</code> file:
 <source lang="xml">
@@ Line 26: / Line 27: @@
 === Without Maven ===
-If you do not use Maven, you have to add the CKEditor <code>jar</code> library manually. Go to the CKEditor download site, download the <code>ckeditor-java-core-''*ver''.jar</code> file, and put it in your <code>/WEB-INF/lib</code> directory.
+If you do not use Maven, you have to add the CKEditor <code>jar</code> library manually. Go to the CKEditor download site, download the <code>ckeditor-java-core-''3.x.y*''.jar</code> file, and put it in your <code>/WEB-INF/lib</code> directory.
 == Using the Tag on the Page ==
 CKEditor replaces the HTML <code>textarea</code> element(s) with its instance(s). Unless you are using the <code><ckeditor:editor></code> tag (which will be described later), the first thing you need is a JSP page with an HTML <code>textarea</code> element.