Tbeditor"

From Documentation
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{ZKComponentReferencePageHeader}}
 
{{ZKComponentReferencePageHeader}}
  
= CKEditor =
+
= Tbeditor =
  
*Demonstration: [http://www.zkoss.org/zkdemo/input/wysiwyg_editor WYSIWYG Editor]
 
 
*Java API: N/A
 
*Java API: N/A
 
*JavaScript API: N/A
 
*JavaScript API: N/A
 
{{ZKAddon | link=http://sourceforge.net/projects/zk1/files/ZK%20CKEditor/ZK%205/}}
 
 
It is moved to google code after 3.5.2.0: [http://code.google.com/p/zkckeditor/ zkckeditor]
 
 
It is moved to github after 3.6.0.0: https://github.com/zkoss/zkckeditor
 
  
 
= Employment/Purpose =
 
= Employment/Purpose =
The component used to represent [http://ckeditor.com/ CKEditor]  
+
The component used to represent [http://alex-d.github.io/Trumbowyg/ Trumbowyg]  
 
 
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.
+
Tbeditor is a rich 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.
  
 
= Example =
 
= Example =
[[Image:ZKCompRef_CKEditor.png]]
+
[[Image:Zkcompref tbeditor.png|800px]]
 
 
<source lang="xml" >
 
<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>
 
</source>
 
 
 
[[Image:ZKCompRef_CKEditor2.png]]
 
 
 
'''It will turn on the save button when inside a form'''
 
 
 
<source lang="xml" >
 
<zk xmlns:n="http://www.zkoss.org/2005/zk/native">
 
<n:form>
 
<ckeditor width="850" />
 
</n:form>
 
</zk>
 
</source>
 
 
 
=Work with ZK6 MVVM=
 
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
 
 
<source lang="xml" >
 
<source lang="xml" >
<?xml version="1.0" encoding="UTF-8"?>
+
<tbeditor id="tb" value="this is a demo for &lt;b&gt;trumbowy&lt;/b&gt; editor!!" />
<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>
 
 
</source>
 
</source>
  
then add it into WEB-INF/zk.xml
+
= Customized Properties =
 +
Tbeditor provides a way for users to customize their own properties, check [http://alex-d.github.io/Trumbowyg/documentation.html official document] for the detail<ref>Not support all properties, for example, localization, custom skin, are not supported.</ref>.
 +
Here shows a simple example how to programmatic change the property.
  
<source lang="xml" >
+
<source lang="java">
<zk>
+
Map config = new HashMap();
<language-config>
+
config.put("btns", new String[] {"bold", "italic", "link"});
<addon-uri>/WEB-INF/ckez-bind-addon.xml</addon-uri>
+
config.put("closable", true);
</language-config>
+
tb.setConfig(config);
</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=
+
We create a map while key is property name with reasonable value.
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.
+
Note that we have to wrap the value into <code>JavaScriptValue</code> object if it's not String.  
{| width="100%"
 
|-
 
|[[File:ZKCompRef_CKEditor_filebrowser.png]]
 
| <source lang="xml" >
 
<zk>
 
    <ckeditor filebrowserImageBrowseUrl="img"/>
 
</zk>
 
</source>
 
|}
 
[[File:ZKCompRef_CKEditor_filebrowser2.png]]
 
[[File:ZKCompRef_CKEditor_filebrowser3.png]]
 
  
==Custom File browser==
+
<blockquote>
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 [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your custom file browser.
+
<references/>
 
+
</blockquote>
=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.
 
{| width="100%"
 
|-
 
|[[File:ZKCompRef_CKEditor_filebrowser.png]]
 
| <source lang="xml" >
 
<zk>
 
    <ckeditor filebrowserImageBrowseUrl="img" filebrowserImageUploadUrl="img"/>
 
</zk>
 
</source>
 
|}
 
[[File:ZKCompRef_CKEditor_fileupload.png]]
 
[[File: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 [http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_%28Uploader%29 CKEditor Developers Guide] to create your custom file upload handler.
 
  
 
=Supported Events=
 
=Supported Events=
  
{| border="1" | width="100%"
+
{| class='wikitable' | width="100%"
 
! <center>Name</center>
 
! <center>Name</center>
 
! <center>Event Type</center>
 
! <center>Event Type</center>
 
|-
 
|-
| <center><tt>onChange</tt></center>
+
| <center><code>onChange</code></center>
 
| <javadoc>org.zkoss.zk.ui.event.InputEvent</javadoc>
 
| <javadoc>org.zkoss.zk.ui.event.InputEvent</javadoc>
  
<tt>'''Description:''' </tt> Denotes the content of an input component has been modified by the user.
+
<code>'''Description:''' </code> Denotes the content of an input component has been modified by the user.
  
 
|-
 
|-
| <center><tt>onChanging</tt></center>
+
| <center><code>onChanging</code></center>
 
| <javadoc>org.zkoss.zk.ui.event.InputEvent</javadoc>
 
| <javadoc>org.zkoss.zk.ui.event.InputEvent</javadoc>
  
<tt>'''Description:''' </tt> 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 <tt>onChange</tt> is received. Thus, you have to invoke the <tt>getValue </tt>method in the <tt>InputEvent </tt>class to retrieve the temporary value.
+
<code>'''Description:''' </code> 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 <code>onChange</code> is received. Thus, you have to invoke the <code>getValue </code>method in the <code>InputEvent </code>class to retrieve the temporary value.
 
 
|-
 
| <center><tt>onSave</tt></center>
 
| <javadoc>org.zkoss.zk.ui.event.InputEvent</javadoc>
 
 
 
<tt>'''Description:''' </tt> Denotes the save button of the CKEditor component has been clicked by the user.
 
 
 
 
|}
 
|}
  
Line 183: Line 61:
 
=Use Cases=
 
=Use Cases=
  
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Description !! Example Location
 
! Version !! Description !! Example Location
 
|-
 
|-
Line 194: Line 72:
 
{{LastUpdated}}
 
{{LastUpdated}}
  
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-

Revision as of 04:03, 24 February 2022

Tbeditor

  • Java API: N/A
  • JavaScript API: N/A

Employment/Purpose

The component used to represent Trumbowyg

Tbeditor is a rich 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.

Example

Zkcompref tbeditor.png

<tbeditor id="tb" value="this is a demo for &lt;b&gt;trumbowy&lt;/b&gt; editor!!" />

Customized Properties

Tbeditor provides a way for users to customize their own properties, check official document for the detail[1]. Here shows a simple example how to programmatic change the property.

Map config = new HashMap();
config.put("btns", new String[] {"bold", "italic", "link"});
config.put("closable", true);
tb.setConfig(config);

We create a map while key is property name with reasonable value. Note that we have to wrap the value into JavaScriptValue object if it's not String.


  1. Not support all properties, for example, localization, custom skin, are not supported.

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.

Supported Children

*NONE

Use Cases

Version Description Example Location
     

Version History

Last Update : 2022/02/24


Version Date Content
     



Last Update : 2022/02/24

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