info.magnolia.ui.vaadin.richtext

Class MagnoliaRichTextField

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<String>

org.vaadin.openesignforms.ckeditor.CKEditorTextField

info.magnolia.ui.vaadin.richtext.MagnoliaRichTextField

All Implemented Interfaces:

com.vaadin.data.Buffered, com.vaadin.data.BufferedValidatable, com.vaadin.data.Property<String>, com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer, com.vaadin.data.Validatable, com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Field<String>, com.vaadin.ui.LegacyComponent, Serializable, EventListener

public class MagnoliaRichTextField
extends org.vaadin.openesignforms.ckeditor.CKEditorTextField

Extended CKEditorTextField for custom made Magnolia plugins. By default CKEditor wrapper for Vaadin does not allow custom events between CKEditor plugins and server.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MagnoliaRichTextField.PluginListener Event handler listener for plugin connectivity.

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

com.vaadin.ui.AbstractField.FocusShortcut, com.vaadin.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

com.vaadin.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

com.vaadin.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.data.Property

com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyException, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.Transactional<T>, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer

Field Summary

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
MagnoliaRichTextField()
MagnoliaRichTextField(MagnoliaRichTextFieldConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(MagnoliaRichTextField.PluginListener listener)
void	changeVariables(Object source, Map<String,Object> variables)
void	firePluginEvent(String event) Send event to CKEditor instance.
void	firePluginEvent(String event, String value) Send event to CKEditor instance.
boolean	isEmpty()
void	paintContent(com.vaadin.server.PaintTarget target)

Methods inherited from class org.vaadin.openesignforms.ckeditor.CKEditorTextField

addBlurListener, addFocusListener, addListener, addListener, detach, focus, getType, getVersion, insertHtml, insertText, isProtectedBody, isViewWithoutEditor, removeBlurListener, removeFocusListener, removeListener, removeListener, setConfig, setHeight, setProtectedBody, setValue, setViewWithoutEditor

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, beforeClientResponse, clear, commit, discard, fireReadOnlyStatusChange, fireValueChange, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getCustomAttributes, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getState, getState, getTabIndex, getValidators, getValue, isBuffered, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readDesign, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInternalValue, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, shouldHideErrors, toString, validate, validate, valueChange, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isVisible, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.ui.Component.Focusable

getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, readDesign, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Constructor Detail

MagnoliaRichTextField

public MagnoliaRichTextField()

MagnoliaRichTextField

public MagnoliaRichTextField(MagnoliaRichTextFieldConfig config)

Method Detail

addListener

public void addListener(MagnoliaRichTextField.PluginListener listener)

changeVariables

public void changeVariables(Object source,
                   Map<String,Object> variables)

Specified by:

changeVariables in interface com.vaadin.server.VariableOwner

Overrides:

changeVariables in class org.vaadin.openesignforms.ckeditor.CKEditorTextField

firePluginEvent

public void firePluginEvent(String event,
                   String value)

Send event to CKEditor instance.

Parameters:

event - Event name that plugin can attach with: editor.on('event', function(e) {...});

value - Additional event data. Plugin can access this by e.data

firePluginEvent

public void firePluginEvent(String event)

Send event to CKEditor instance. Only event. No additional event data.

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Overrides:

paintContent in class org.vaadin.openesignforms.ckeditor.CKEditorTextField

Throws:

com.vaadin.server.PaintException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.vaadin.ui.Field<String>

Overrides:

isEmpty in class com.vaadin.ui.AbstractField<String>