CKEditor"

From Documentation
(18 intermediate revisions by 4 users not shown)
Line 7: Line 7:
 
*JavaScript API: N/A
 
*JavaScript API: N/A
  
{{ZKAddon | link=http://sourceforge.net/projects/zk1/files/ZK%20CKEditor/ZK%205/}}
+
{{ZKAddon | link=http://sourceforge.net/projects/zk1/files/ZK%20CKEditor/ZK%205/}} '''(deprecated)'''
  
It is moved to google code after 3.5.2.0: [http://code.google.com/p/zkckeditor/ zkckeditor]
+
It is moved to google code after 3.5.2.0: [http://code.google.com/p/zkckeditor/ zkckeditor] '''(deprecated)'''
 +
 
 +
It is moved to github after 3.6.0.0: https://github.com/zkoss/zkckeditor
 +
 
 +
= Maven =
 +
You need to include CKEditor jar in pom.xml before using it because it has a different group id from ZK other components.
 +
<source lang='xml'>
 +
<dependency>
 +
<groupId>org.zkoss.zkforge</groupId>
 +
<artifactId>ckez</artifactId>
 +
<version>${ckez.version}</version>
 +
</dependency>
 +
</source>
 +
 
 +
Check the latest version on [http://mavensync.zkoss.org/maven2/org/zkoss/zkforge/ckez/ CE repository].
  
 
= Employment/Purpose =
 
= Employment/Purpose =
Line 59: Line 73:
  
 
=Work with ZK6 MVVM=
 
=Work with ZK6 MVVM=
 +
{{Notice|text=Since Ckeditor '''3.6.0.1''', we have added data binding annotation into the lang-addon.xml file, so you no more need to add the settings below.}}
 +
 
  since 6.0.0
 
  since 6.0.0
  
Line 111: Line 127:
 
</zk>
 
</zk>
 
</source>
 
</source>
Since 3.6.0.1, server annotation has been added to the lang-addon.xml file, so you no more need to add the above settings to your zk.xml file.
 
  
 
=File browser=
 
=File browser=
ZK Ckeditor provide a default file browser for browse the files in a folder that user set, you can define a location of the folder and when you open a add image/flash dialog and click the "Browse Server", the ckeditor will open a new window, and list files in the file browser.
+
ZK CKEditor provides a default file browser for browsing the files in a folder that you specify. You can define a target folder in index.zul and when you open the add image/flash dialog and click "Browse Server", CKEditor will open a new window, and list all the files in the file browser.
 
{| width="100%"
 
{| width="100%"
 
|-
 
|-
Line 129: Line 144:
 
==Custom File browser==
 
==Custom File browser==
 
  since 3.6.0.2
 
  since 3.6.0.2
If you want to customize your own file browser, you can change the file browser page by call CKeditor.setFilebrowserImageUploadUrl(page_url) to change the location of the file browser page, and refer to [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your file browser page.
+
If you wish to customize your own file browser, you can change the location by calling CKeditor.setFilebrowserImageUploadUrl(page_url), and refer to [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your custom file browser.
  
 
=File upload=
 
=File upload=
 
  since 3.6.0.2
 
  since 3.6.0.2
ZK CKEditor provides a default file upload handler as illustrated in the screenshot below. You can define a target folder and when user uploads a file, it will save the file in the folder that you have specified.
+
ZK CKEditor provides a default file upload handler for uploading the files to the folder you specify. You can define a target folder in index.zul and when user uploads a file, it will save the file in the folder that you have specified.
 
{| width="100%"
 
{| width="100%"
 
|-
 
|-
Line 149: Line 164:
 
  since 3.6.0.2
 
  since 3.6.0.2
 
If you wish to customize your own file upload handler, you can change the location by calling CKeditor.setFileUploadHandlePage(page_url), and refer to [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your custom file upload handler.
 
If you wish to customize your own file upload handler, you can change the location by calling CKeditor.setFileUploadHandlePage(page_url), and refer to [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your custom file upload handler.
 +
 +
= Custom Configuration =
 +
 +
Prepare a javascript file for configuration like:
 +
 +
'''config.js'''
 +
<source lang='javascript'>
 +
CKEDITOR.editorConfig = function(config) {
 +
    //enable spell checker
 +
    config.disableNativeSpellChecker = false;
 +
    //Automatically enables "Spell Check As You Type" on editor startup
 +
    config.scayt_autoStartup = true;
 +
    //locale
 +
    config.language = 'de';
 +
};
 +
</source>
 +
 +
Please refer to http://docs.ckeditor.com/#!/api/CKEDITOR.config for complete configuration options.
 +
 +
Specify the configuration file at <tt>customConfigurationsPath</tt> attribute with the absolute path.
 +
<source lang='xml'>
 +
<ckeditor customConfigurationsPath="/config.js"/>
 +
</source>
 +
 +
== Custom Save Button ==
 +
You can implement a custom plugin to enable save button and fire onChange event to the server to save the editor's content. Please refer to [https://github.com/zkoss/zkbooks/tree/master/componentreference/src/main/webapp/input the source on the github].
  
 
=Supported Events=
 
=Supported Events=

Revision as of 01:42, 6 May 2019

CKEditor

Template:ZKAddon (deprecated)

It is moved to google code after 3.5.2.0: zkckeditor (deprecated)

It is moved to github after 3.6.0.0: https://github.com/zkoss/zkckeditor

Maven

You need to include CKEditor jar in pom.xml before using it because it has a different group id from ZK other components.

		<dependency>
			<groupId>org.zkoss.zkforge</groupId>
			<artifactId>ckez</artifactId>
			<version>${ckez.version}</version>
		</dependency>

Check the latest version on CE repository.

Employment/Purpose

The component used to represent CKEditor

CKEditor is a popular HTML on-line text editor developed by Frederico Caldeira Knabben.

CKEditor is a text editor to be used inside web pages. It's a WYSIWYG editor, which means that the text being edited on it looks as similar as possible to the results users have when publishing it.

It brings to the web common editing features found on desktop editing applications like Microsoft Word and OpenOffice.

Example

ZKCompRef CKEditor.png

<ckeditor width="850px">
<attribute name="value"><![CDATA[
<table width="200" cellspacing="1" cellpadding="1" border="1">
	<tbody>
		<tr style="background: #B7B313; color:white;">
			<td>First Name</td>
			<td>Last Name</td>
		</tr>
		<tr>
			<td>Jone</td>
			<td>Hayes</td>
		</tr>
		<tr>
			<td>Mary</td>
			<td>Bally</td>
		</tr>
	</tbody>
</table>
]]></attribute>
</ckeditor>

ZKCompRef CKEditor2.png

It will turn on the save button when inside a form

<zk xmlns:n="http://www.zkoss.org/2005/zk/native">
	<n:form>
		<ckeditor width="850" />
	</n:form>
</zk>

Work with ZK6 MVVM

Icon info.png Notice: Since Ckeditor 3.6.0.1, we have added data binding annotation into the lang-addon.xml file, so you no more need to add the settings below.

since 6.0.0

For work with ZK6 MVVM, it is required to create an addon xml and add the server annotation as follows:

WEB-INF/ckez-bind-addon.xml

<?xml version="1.0" encoding="UTF-8"?>
<language-addon>
	<!-- The name of this addon. It must be unique -->
	<addon-name>ckezbind</addon-name>
	<!-- Specifies what other addon this depends
	<depends></depends>
	-->
	<!-- Which language this addon will be added to -->
	<language-name>xul/html</language-name>

	<component>
		<component-name>ckeditor</component-name>
		<extends>ckeditor</extends>
		<annotation>
			<annotation-name>ZKBIND</annotation-name>
			<property-name>value</property-name>
			<attribute>
				<attribute-name>ACCESS</attribute-name>
				<attribute-value>both</attribute-value>
			</attribute>
			<attribute>
				<attribute-name>SAVE_EVENT</attribute-name>
				<attribute-value>onChange</attribute-value>
			</attribute>
			<attribute>
				<attribute-name>LOAD_REPLACEMENT</attribute-name>
				<attribute-value>value</attribute-value>
			</attribute>
			<attribute>
				<attribute-name>LOAD_TYPE</attribute-name>
				<attribute-value>java.lang.String</attribute-value>
			</attribute>
		</annotation>
	</component>
</language-addon>

then add it into WEB-INF/zk.xml

<zk>
	<language-config>
		<addon-uri>/WEB-INF/ckez-bind-addon.xml</addon-uri>
	</language-config>
</zk>

File browser

ZK CKEditor provides a default file browser for browsing the files in a folder that you specify. You can define a target folder in index.zul and when you open the add image/flash dialog and click "Browse Server", CKEditor will open a new window, and list all the files in the file browser.

File:ZKCompRef CKEditor filebrowser.png
<zk>
    <ckeditor filebrowserImageBrowseUrl="img"/>
</zk>

ZKCompRef CKEditor filebrowser2.png ZKCompRef CKEditor filebrowser3.png

Custom File browser

since 3.6.0.2

If you wish to customize your own file browser, you can change the location by calling CKeditor.setFilebrowserImageUploadUrl(page_url), and refer to CKEditor Developers Guide to create your custom file browser.

File upload

since 3.6.0.2

ZK CKEditor provides a default file upload handler for uploading the files to the folder you specify. You can define a target folder in index.zul and when user uploads a file, it will save the file in the folder that you have specified.

File:ZKCompRef CKEditor filebrowser.png
<zk>
    <ckeditor filebrowserImageBrowseUrl="img" filebrowserImageUploadUrl="img"/>
</zk>

ZKCompRef CKEditor fileupload.png ZKCompRef CKEditor fileupload2.png

Custom File upload handler

since 3.6.0.2

If you wish to customize your own file upload handler, you can change the location by calling CKeditor.setFileUploadHandlePage(page_url), and refer to CKEditor Developers Guide to create your custom file upload handler.

Custom Configuration

Prepare a javascript file for configuration like:

config.js

CKEDITOR.editorConfig = function(config) {
    //enable spell checker
    config.disableNativeSpellChecker = false;
    //Automatically enables "Spell Check As You Type" on editor startup
    config.scayt_autoStartup = true;
    //locale
    config.language = 'de';
};

Please refer to http://docs.ckeditor.com/#!/api/CKEDITOR.config for complete configuration options.

Specify the configuration file at customConfigurationsPath attribute with the absolute path.

<ckeditor customConfigurationsPath="/config.js"/>

Custom Save Button

You can implement a custom plugin to enable save button and fire onChange event to the server to save the editor's content. Please refer to the source on the github.

Supported Events

Name
Event Type
onChange
InputEvent

Description: Denotes the content of an input component has been modified by the user.

onChanging
InputEvent

Description: Denotes that user is changing the content of an input component. Notice that the component's content (at the server) won't be changed until onChange is received. Thus, you have to invoke the getValue method in the InputEvent class to retrieve the temporary value.

onSave
InputEvent

Description: Denotes the save button of the CKEditor component has been clicked by the user.

Supported Children

*NONE

Use Cases

Version Description Example Location
     

Version History

Last Update : 2019/05/06


Version Date Content
     



Last Update : 2019/05/06

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.