Tbeditor"

From Documentation
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
 
= Tbeditor =
 
= Tbeditor =
 
{{versionSince | 8.0.0}}
 
{{versionSince | 8.0.0}}
 +
{{ZK EE}}
  
 
*Java API: [https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Tbeditor.html Tbeditor]
 
*Java API: [https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zkmax/zul/Tbeditor.html Tbeditor]
Line 32: Line 33:
  
 
= Customized Properties =
 
= 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>.
+
Tbeditor provides a way for users to customize their own properties, check [http://alex-d.github.io/Trumbowyg/documentation.html official document] for the details. (Not all properties are supported, for example, localization, and custom skin, are not supported.)
Here shows a simple example how to programmatic change the property.
+
 
 +
Here is a simple example of how to programmatic change the property:
  
 
<source lang="java">
 
<source lang="java">
Line 39: Line 41:
 
config.put("btns", new String[] {"bold", "italic", "link"});
 
config.put("btns", new String[] {"bold", "italic", "link"});
 
config.put("closable", true);
 
config.put("closable", true);
tb.setConfig(config);
+
tbeditor.setConfig(config);
 
</source>
 
</source>
 
+
* Line 1: We create a map while a key is a property name with a supported value. Note that we have to wrap the value into <code>JavaScriptValue</code> object if it's not String.
We create a map while key is property name with reasonable value.
 
Note that we have to wrap the value into <code>JavaScriptValue</code> object if it's not String.  
 
 
 
<blockquote>
 
----
 
<references/>
 
</blockquote>
 
  
 
=Supported Events=
 
=Supported Events=

Latest revision as of 05:58, 22 December 2023

Tbeditor

Since 8.0.0

  • Available for ZK:
  • http://www.zkoss.org/product/zkhttp://www.zkoss.org/whyzk/zkeeVersion ee.png

Employment/Purpose

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.

The component wraps Trumbowyg

Bundled Versions

ZK Trumbowyg
9.6.0+ 2.7.2
8.5.0 2.6
8.0.0 2.0.0-beta.2

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 details. (Not all properties are supported, for example, localization, and custom skin, are not supported.)

Here is a simple example of how to programmatic change the property:

Map config = new HashMap();
config.put("btns", new String[] {"bold", "italic", "link"});
config.put("closable", true);
tbeditor.setConfig(config);
  • Line 1: We create a map while a key is a property name with a supported value. Note that we have to wrap the value into JavaScriptValue object if it's not String.

Supported Events

Name
Event Type
onChange
InputEvent

Denotes that the content of the component has been modified by a user

onChanging
InputEvent

Denotes that a 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



Last Update : 2023/12/22

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