CKEditor for Java Integration Guide

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(emoved note about maven2)
Line 161: Line 161:
 
list.add(subList);
 
list.add(subList);
 
settings.addConfigValue("toolbar", list);
 
settings.addConfigValue("toolbar", list);
 +
%>
 +
</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.
 +
The below code:
 +
<source lang="html4strict">
 +
<%
 +
CKEditorConfig settings = new CKEditorConfig();
 +
settings.addConfigValue("toolbar","[{name: 'document', items: ['Source', '-', 'NewPage']},
 +
'/', {name: 'styles', items: ['Styles','Format']} ]");
 +
%>
 +
</source>
 +
is equal to:
 +
<source lang="html4strict">
 +
<%
 +
CKEditorConfig settings = new CKEditorConfig();
 +
List<Object> mainList = new ArrayList<Object>();
 +
HashMap<String, Object> toolbarSectionMap = new HashMap<String, Object>();
 +
List<String> subList = new ArrayList<String>();
 +
subList.add("Source");
 +
subList.add("-");
 +
subList.add("NewPage");
 +
toolbarSectionMap.put("name", "document");
 +
toolbarSectionMap.put("items", subList);
 +
mainList.add(toolbarSectionMap);
 +
mainList.add("/");
 +
toolbarSectionMap = new HashMap<String, Object>();
 +
subList = new ArrayList<String>();
 +
subList.add("Styles");
 +
subList.add("Format");
 +
toolbarSectionMap.put("name", "styles");
 +
toolbarSectionMap.put("items", subList);
 +
mainList.add(toolbarSectionMap);
 +
settings.addConfigValue("toolbar", mainList);
 
%>
 
%>
 
</source>
 
</source>

Revision as of 15:37, 2 August 2011

System Requirements

Please note that you need at least JRE 1.4 and Servlet 2.5/JSP 2.1 to use the integration.

Installation

Adding CKEditor to your application is a two-step process that entails:

  1. downloading standalone CKEditor and placing it in the web application directory,
  2. downloading and installing the server-side integration (CKEditor for Java).

Adding Client-Side CKEditor Sources

Go to the official CKEditor download site and grab the latest version of CKEditor. Place it in the directory of your web application.

Adding Tag Library (ckeditor-java-core)

When you want to add the CKEditor library, you can choose between using Maven and adding it manually.

Using Maven2

If your application uses Maven, you can add the following dependency to your pom.xml file: 

<dependency>
	<groupId>com.ckeditor</groupId>
	<artifactId>ckeditor-java-core</artifactId>
	<version>3.x.y</version>
</dependency>

Please note that 3.x.y denotes the artifact version, like <version>3.6</version>. Since CKEditor releases are added to the central Maven repository, the specified version should be downloaded automatically.

Without Maven

If you do not use Maven, you have to add the CKEditor jar library manually. Go to the CKEditor download site, download the ckeditor-java-core-3.x.y*.jar file, and put it in your /WEB-INF/lib directory.

* Please note that 3.x.y denotes the version of a CKEditor release.

Using the Tag on the Page

To start using <ckeditor> tags in your JSP page, you need to declare the CKEditor tag library inside it: 

<%@ taglib uri="http://ckeditor.com" prefix="ckeditor" %>

CKEditor replaces the HTML textarea element(s) with its instance(s). Unless you are using the <ckeditor:editor> tag (which will be described later), the first thing you need is a JSP page with an HTML textarea element.

Replacing Selected Textarea Element

For the purpose of this article let us assume that the page looks like this: 

<!DOCTYPE unspecified PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<%@page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%>
<html>
	<body>
		<form action="sample_posteddata.jsp" method="get">
			<p>
				<label for="editor1">Editor 1:</label>
				<textarea cols="80" id="editor1" name="editor1" rows="10"></textarea>
			</p>
			<p>
				<input type="submit" value="Submit" />
			</p>
		</form>
	</body>	
</html>

As seen in the code above, the action attribute of the form element contains the sample_posteddata.jsp value. This is a web.xml mapping that is used in the samples and points to a servlet that prints the contents of CKEditor, when the page is submitted.

Next you have to add the CKEditor tag (<ckeditor:replace> in this case) to the page. It is recommended to add it at the end, just before the closing </body> tag: 

<ckeditor:replace replace="editor1" basePath="/ckeditor/" />

Please note that the CKEditor tag above contains two attributes:

  • replace – points to the name or ID of the HTML textarea element that is to be replaced with a CKEditor instance.
  • basePath – contains the path to the main CKEditor directory.

For the purpose of this document it is assumed that CKEditor is available in the /ckeditor/ directory (http://example.com/ckeditor/).

Please note that other tag attributes are also available. Refer to the Common Tag Attributes section below for a full description.

Below is the full source code of our sample page: 

<!DOCTYPE unspecified PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<%@page pageEncoding="UTF-8" contentType="text/html; charset=UTF-8"%>
<%@ taglib uri="http://ckeditor.com" prefix="ckeditor" %>
<html>
	<body>
		<form action="sample_posteddata.jsp" method="get">
			<p>
				<label for="editor1">Editor 1:</label>
				<textarea cols="80" id="editor1" name="editor1" rows="10"></textarea>
			</p>
			<p>
				<input type="submit" value="Submit" />
			</p>
		</form>
	<ckeditor:replace replace="editor1" basePath="/ckeditor/" />
	</body>	
</html>

Replacing All Textarea Elements

The <ckeditor:replaceAll> tag replaces all textarea elements available in the document with editor instances. Optionally it can replace only the textarea elements that have a CSS class equal to the value of the CKEditor className attribute. 

<ckeditor:replaceAll basePath="/ckeditor/" className="myclass"/>

This tag changes all textarea elements with a CSS class of myclass to CKEditor instances.

Creating a CKEditor Instance

The <ckeditor:editor> tag creates a CKEditor instance. 

<ckeditor:editor textareaAttributes="<%=attr %>" basePath="/ckeditor/" editor="editor1" value="Type here" />

For this tag no HTML textarea element needs to be present on a page. It is created internally and immediately replaced with a CKEditor instance. The code above contains the following elements:

  • basePath – contains the path to the main CKEditor directory.
  • editor – is the name of the internal textarea element.
  • value – is the default textarea element value.
  • textareaAttributes – is a java.util.Map with textarea attribute names serving as map keys, and attribute values serving as map values. For example:
<% 
	Map<String, String> attr = new HashMap<String, String>();
	attr.put("rows", "8");
	attr.put("cols", "50");
%>

Common Tag Attributes

The list below presents some of the commonly used tag attributes.

basePath

basePath – contains the path to the main CKEditor directory.

If, for example, CKEditor is available under http://example.com/3rdparty/ckeditor/, the basePath attribute should be set to /3rdparty/ckeditor/.

config

config – this parameter contains the CKEditor configuration object. For the list of available options, please refer to the JavaScript API.

Configuration options are stored in the CKEditorConfig object. They are added by using the addConfigValue method: 

<% 
	CKEditorConfig settings = new CKEditorConfig();
	settings.addConfigValue("width","500");
%>
<ckeditor:replace replace="editor1" basePath="/ckeditor/" config="<%=settings %>" />

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: 

<% 
	CKEditorConfig settings = new CKEditorConfig();
	settings.addConfigValue("toolbar","[[ 'Source', '-', 'Bold', 'Italic' ]]");
%>

is equal to: 

<% 
	CKEditorConfig settings = new CKEditorConfig();
	List<List<String>> list = new ArrayList<List<String>>();
	List<String> subList = new ArrayList<String>();
	subList.add("Source");
	subList.add("-");
	subList.add("Bold");
	subList.add("Italic");
	list.add(subList);
	settings.addConfigValue("toolbar", list);
%>

Additional note about toolbar.
As of CKEditor 3.6, what is described 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. The below code: 

<%
	CKEditorConfig settings = new CKEditorConfig();
	settings.addConfigValue("toolbar","[{name: 'document', items: ['Source', '-', 'NewPage']},
	'/', {name: 'styles', items: ['Styles','Format']} ]");
%>

is equal to: 

<%
	CKEditorConfig settings = new CKEditorConfig();
	List<Object> mainList = new ArrayList<Object>();				
	HashMap<String, Object> toolbarSectionMap = new HashMap<String, Object>();
	List<String> subList = new ArrayList<String>();
	subList.add("Source");
	subList.add("-");
	subList.add("NewPage");	
	toolbarSectionMap.put("name", "document");	
	toolbarSectionMap.put("items", subList);	
	mainList.add(toolbarSectionMap);		
	mainList.add("/");
	toolbarSectionMap = new HashMap<String, Object>();
	subList = new ArrayList<String>();
	subList.add("Styles");				
	subList.add("Format");
	toolbarSectionMap.put("name", "styles");	
	toolbarSectionMap.put("items", subList);
	mainList.add(toolbarSectionMap);				
	settings.addConfigValue("toolbar", mainList);
%>

timestamp

timestamp – this parameter stores the value specific for a particular CKEditor release, which helps to avoid browser caching problems when a new client-side CKEditor version is uploaded to the server.

initialized

initialized – setting this parameter to true means that the ckeditor.js script from CKEditor is already included in the page and there is no need to add it again. Setting it to false, on the other hand, means that the ckeditor.js script should be added to the page.

events

events – this parameter stores the list of client-side event listeners and is of com.ckeditor.EventHandler type.

Example:

Firstly, an instance of the EventHandler has to be created. Then you can add events by using the addEvent 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. 

<% 
	EventHandler eventHandler = new EventHandler();
	eventHandler.addEvent("instanceReady","function (ev) { alert(\"Loaded: \" + ev.editor.name); }");
%>

In order to use the events on a page, the following expression can be added: 

<ckeditor:editor basePath="/ckeditor/" editor="editor1" events="<%=eventHandler %>"/>

globalEvents

globalEvents – this parameter stores the list of client-side event listeners that are used by all CKEditor instances and is of GlobalEventHandler type. 

<%
	GlobalEventHandler globalEventHandler = new GlobalEventHandler();
	globalEventHandler.addEvent("dialogDefinition","function (ev) { alert(\"Loading dialog window: \" + ev.data.name); }");
%>

Setting configuration options in a Java class

Instances of the configuration, events, and global events can be created either in a scriptlet, or in a separated Java class. Here is an example: 

package com.ckeditor.samples;

import java.util.ArrayList;
import java.util.List;

import com.ckeditor.CKEditorConfig;
import com.ckeditor.EventHandler;
import com.ckeditor.GlobalEventHandler;

public class ConfigurationHelper {

	
	public static CKEditorConfig createConfig() {
		CKEditorConfig config = new CKEditorConfig();
		List<List<String>> list = new ArrayList<List<String>>();
		List<String> subList = new ArrayList<String>();
		subList.add("Source");
		subList.add("-");
		subList.add("Bold");
		subList.add("Italic");
		list.add(subList);
		config.addConfigValue("toolbar", list);
		config.addConfigValue("width","500");
		return config;
	}
	
	public static EventHandler createEventHandlers() {
		EventHandler handler = new EventHandler();
		handler.addEvent("instanceReady","function (ev) { alert(\"Loaded: \" + ev.editor.name); }");
		return handler;
	}
	
	public static GlobalEventHandler createGlobalEventHandlers() {
		GlobalEventHandler handler = new GlobalEventHandler();
		handler.addEvent("dialogDefinition","function (ev) {  alert(\"Loading dialog window: \" + ev.data.name); }");
		return handler;
	}
}

To access this class on a JSP page you can use the following expression: 

<ckeditor:replace replace="editor1" basePath="ckeditor/"
   config="<%= ConfigurationHelper.createConfig() %>"
   events="<%= ConfigurationHelper.createEventHandlers() %>" />

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Developers_Guide/Java/Integration&oldid=6435"