info.magnolia.ui.vaadin.gwt.client.richtext

Class VMagnoliaRichTextField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

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

info.magnolia.ui.vaadin.gwt.client.richtext.VMagnoliaRichTextField

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.vaadin.client.Paintable, VMagnoliaRichTextEditor.Listener, org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditorService.CKEditorListener

public class VMagnoliaRichTextField
extends VCKEditorTextField
implements VMagnoliaRichTextEditor.Listener

Magnolia rich text field adds an ability to custom plugins to communicate with the server. This was not possible with the add-on out of the box.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
static String	VAR_EVENT_PREFIX
static String	VAR_EVENTNAMES
static String	VAR_FIRE_PLUGIN_EVENT
static String	VAR_FIRE_PLUGIN_EVENT_VALUE
static String	VAR_SERVERPLUGINS

Fields inherited from class org.vaadin.openesignforms.ckeditor.widgetset.client.ui.VCKEditorTextField

ATTR_FOCUS, ATTR_IMMEDIATE, ATTR_INPAGECONFIG, ATTR_INSERT_HTML, ATTR_INSERT_TEXT, ATTR_PROTECTED_BODY, ATTR_PROTECTED_SOURCE, ATTR_READONLY, ATTR_VIEW_WITHOUT_EDITOR, ATTR_WRITER_INDENTATIONCHARS, ATTR_WRITERRULES_JSRULE, ATTR_WRITERRULES_TAGNAME, CLASSNAME, clientToServer, paintableId, VAR_TEXT, VAR_VERSION

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
VMagnoliaRichTextField()

Method Summary

Methods

Modifier and Type	Method and Description
void	doResize()
protected org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditor	loadEditor(String inPageConfig) Expose loadEditor command to subclasses, so that they can perform additional logic before/after creating CKEditor instance on the page, e.g.
void	onChange() Override VCKEditorTextField's default behavior, defer update in case field is immediate.
void	onInstanceReady() Add plugin listeners when instance is ready.
void	onPluginEvent(String eventName, String data)
void	updateFromUIDL(com.vaadin.client.UIDL uidl, com.vaadin.client.ApplicationConnection client) Called whenever an update is received from the server

Methods inherited from class org.vaadin.openesignforms.ckeditor.widgetset.client.ui.VCKEditorTextField

getTabIndex, onBlur, onDataReady, onFocus, onModeChange, onSave, onUnload, setAccessKey, setFocus, setHeight, setTabIndex, setWidth

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Field Detail

VAR_EVENTNAMES

public static final String VAR_EVENTNAMES

See Also:

Constant Field Values

VAR_SERVERPLUGINS

public static final String VAR_SERVERPLUGINS

See Also:

Constant Field Values

VAR_EVENT_PREFIX

public static final String VAR_EVENT_PREFIX

See Also:

Constant Field Values

VAR_FIRE_PLUGIN_EVENT

public static final String VAR_FIRE_PLUGIN_EVENT

See Also:

Constant Field Values

VAR_FIRE_PLUGIN_EVENT_VALUE

public static final String VAR_FIRE_PLUGIN_EVENT_VALUE

See Also:

Constant Field Values

Constructor Detail

VMagnoliaRichTextField

public VMagnoliaRichTextField()

Method Detail

updateFromUIDL

public void updateFromUIDL(com.vaadin.client.UIDL uidl,
                  com.vaadin.client.ApplicationConnection client)

Description copied from class: VCKEditorTextField

Called whenever an update is received from the server

Specified by:

updateFromUIDL in interface com.vaadin.client.Paintable

Overrides:

updateFromUIDL in class VCKEditorTextField

loadEditor

protected org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditor loadEditor(String inPageConfig)

Description copied from class: VCKEditorTextField

Expose loadEditor command to subclasses, so that they can perform additional logic before/after creating CKEditor instance on the page, e.g. register external plugins.

This method is executed as a callback scheduled command when loading the CKEditor library has completed.

Overrides:

loadEditor in class VCKEditorTextField

onInstanceReady

public void onInstanceReady()

Add plugin listeners when instance is ready.

Specified by:

onInstanceReady in interface org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditorService.CKEditorListener

Overrides:

onInstanceReady in class VCKEditorTextField

onPluginEvent

public void onPluginEvent(String eventName,
                 String data)

Specified by:

onPluginEvent in interface VMagnoliaRichTextEditor.Listener

onChange

public void onChange()

Override VCKEditorTextField's default behavior, defer update in case field is immediate.

Specified by:

onChange in interface org.vaadin.openesignforms.ckeditor.widgetset.client.ui.CKEditorService.CKEditorListener

Overrides:

onChange in class VCKEditorTextField

doResize

public void doResize()

Overrides:

doResize in class VCKEditorTextField