org.vaadin.openesignforms.ckeditor.widgetset.client.ui

Class CKEditorService

java.lang.Object

org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditorService

public class CKEditorService
extends Object

GWT wrapper for CKEDITOR for use by our Vaadin-based CKEditorService.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CKEditorService.CKEditorListener An interface for the VCKEditorTextField to get events from the CKEditor.

Constructor Summary

Constructors

Constructor and Description
CKEditorService()

Method Summary

Modifier and Type	Method and Description
static void	addStylesSet(String name, String jsStyles)
static void	addTemplates(String name, String jsDefinition)
static com.google.gwt.core.client.JavaScriptObject	convertJavaScriptStringToObject(String jsString)
static CKEditor	get(String id) Returns a javascript CKEDITOR.editor instance for given id.
static boolean	libraryReady()
static com.google.gwt.core.client.JavaScriptObject	loadEditor(String id, CKEditorService.CKEditorListener listener, String jsInPageConfig, int compWidth, int compHeight) Use this method to load editor to given identifier.
static void	loadLibrary(com.google.gwt.core.client.Scheduler.ScheduledCommand afterLoad)
static void	reduceBlurDelay()
static String	version()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CKEditorService

public CKEditorService()

Method Detail

loadLibrary

public static void loadLibrary(com.google.gwt.core.client.Scheduler.ScheduledCommand afterLoad)

libraryReady

public static boolean libraryReady()

loadEditor

public static com.google.gwt.core.client.JavaScriptObject loadEditor(String id,
                                                                     CKEditorService.CKEditorListener listener,
                                                                     String jsInPageConfig,
                                                                     int compWidth,
                                                                     int compHeight)

Use this method to load editor to given identifier.

Parameters:

id - the string DOM

'id' attribute value for the element you want to replace with CKEditor

listener - the CKEditorService.CKEditorListener will get notified when the editor instance is ready, changed, etc.

jsInPageConfig - the String possible custom "in page" configuration; note that this must be an expected JSON for the CKEDITOR in page config. sent "as is" without any real syntax or security testing, so be sure you know it's valid and not malicious, such as: {toolbar : 'Basic', language : 'en'}

version

public static String version()

reduceBlurDelay

public static void reduceBlurDelay()

get

public static CKEditor get(String id)

Returns a javascript CKEDITOR.editor instance for given id.

Parameters:

id - the String id of the editor instance

Returns:

the overlay for CKEDITOR.editor or null if not yet initialized

addStylesSet

public static void addStylesSet(String name,
                                String jsStyles)

addTemplates

public static void addTemplates(String name,
                                String jsDefinition)

convertJavaScriptStringToObject

public static com.google.gwt.core.client.JavaScriptObject convertJavaScriptStringToObject(String jsString)