Tbeditor

since 8.0

CE
PE
EE

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

<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

[org.zkoss.zk.ui.event.InputEvent](https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/event/InputEvent.html)

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

onChanging

[org.zkoss.zk.ui.event.InputEvent](https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zk/ui/event/InputEvent.html)

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 getValuemethod in the InputEventclass to retrieve the temporary value.

Supported Children

*NONE