info.magnolia.ui.vaadin.ckeditor

Class MagnoliaCKEditorTextField

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<String>

org.vaadin.alump.ckeditor.AbstractCKEditorTextField

org.vaadin.alump.ckeditor.CKEditorTextField

info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorTextField

All Implemented Interfaces:

com.vaadin.data.HasValue<String>, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, 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.LegacyComponent, MagnoliaCKEditorTextFieldEvents, Serializable, EventListener

public class MagnoliaCKEditorTextField
extends CKEditorTextField
implements MagnoliaCKEditorTextFieldEvents

Magnolia 6 - Vaadin 8 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/interfaces inherited from class org.vaadin.alump.ckeditor.AbstractCKEditorTextField

org.vaadin.alump.ckeditor.AbstractCKEditorTextField.SelectionChangeEvent, org.vaadin.alump.ckeditor.AbstractCKEditorTextField.SelectionChangeListener, org.vaadin.alump.ckeditor.AbstractCKEditorTextField.VaadinSaveListener

Nested classes/interfaces inherited from interface info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorTextFieldEvents

MagnoliaCKEditorTextFieldEvents.PluginListener

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.data.HasValue

com.vaadin.data.HasValue.ValueChangeEvent<V>, com.vaadin.data.HasValue.ValueChangeListener<V>

Field Summary

Fields inherited from class org.vaadin.alump.ckeditor.AbstractCKEditorTextField

vaadinSaveListenerList, value

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorTextFieldEvents

EVENT_CANCEL_LINK, EVENT_GET_MAGNOLIA_LINK, EVENT_SEND_MAGNOLIA_LINK

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
MagnoliaCKEditorTextField(MagnoliaCKEditorConfig config)

Method Summary

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

Methods inherited from class org.vaadin.alump.ckeditor.AbstractCKEditorTextField

addBlurListener, addFocusListener, addSelectionChangeListener, addVaadinSaveListener, beforeClientResponse, detach, doSetValue, focus, getValue, getVersion, insertHtml, insertText, isImmediate, isProtectedBody, isViewWithoutEditor, removeBlurListener, removeFocusListener, removeSelectionChangeListener, removeVaadinSaveListener, setConfig, setHeight, setImmediate, setProtectedBody, setViewWithoutEditor

Methods inherited from class com.vaadin.ui.AbstractField

addValueChangeListener, createValueChange, getCustomAttributes, getState, getState, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, readDesign, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue, setValue, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, 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, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorTextFieldEvents

firePluginEvent

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

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, 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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue

Constructor Detail

MagnoliaCKEditorTextField

public MagnoliaCKEditorTextField(MagnoliaCKEditorConfig config)

Method Detail

addListener

public void addListener(MagnoliaCKEditorTextFieldEvents.PluginListener listener)

Specified by:

addListener in interface MagnoliaCKEditorTextFieldEvents

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.alump.ckeditor.AbstractCKEditorTextField

firePluginEvent

public void firePluginEvent(String event,
                            String value)

Description copied from interface: MagnoliaCKEditorTextFieldEvents

Send event to CKEditor instance.

Specified by:

firePluginEvent in interface MagnoliaCKEditorTextFieldEvents

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

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.alump.ckeditor.AbstractCKEditorTextField

Throws:

com.vaadin.server.PaintException

setHeight

public void setHeight(float height,
                      com.vaadin.server.Sizeable.Unit unit)

Specified by:

setHeight in interface com.vaadin.server.Sizeable

Overrides:

setHeight in class com.vaadin.ui.AbstractComponent

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.vaadin.data.HasValue<String>