info.magnolia.ui.vaadin.ckeditor

Interface MagnoliaCKEditorTextFieldEvents

All Known Implementing Classes:

MagnoliaCKEditorTextField, MagnoliaRichTextField

public interface MagnoliaCKEditorTextFieldEvents

Magnolia/CKEditor text field events interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MagnoliaCKEditorTextFieldEvents.PluginListener Event handler listener for plugin connectivity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_CANCEL_LINK Event is transmitted from server to client when a link dialog has been canceled or an exception has occurred.
static String	EVENT_GET_MAGNOLIA_LINK Event is transmitted from client to server when a user requests a link dialog.
static String	EVENT_SEND_MAGNOLIA_LINK Event is transmitted from server to client when a link has been selected.

Method Summary

Modifier and Type	Method and Description
void	addListener(MagnoliaCKEditorTextFieldEvents.PluginListener listener)
default void	firePluginEvent(String event) Send event to CKEditor instance.
void	firePluginEvent(String event, String value) Send event to CKEditor instance.

Field Detail

EVENT_SEND_MAGNOLIA_LINK

static final String EVENT_SEND_MAGNOLIA_LINK

Event is transmitted from server to client when a link has been selected.

See Also:

Constant Field Values

EVENT_CANCEL_LINK

static final String EVENT_CANCEL_LINK

Event is transmitted from server to client when a link dialog has been canceled or an exception has occurred. In case of exception the event will carry the error message.

See Also:

Constant Field Values

EVENT_GET_MAGNOLIA_LINK

static final String EVENT_GET_MAGNOLIA_LINK

Event is transmitted from client to server when a user requests a link dialog. Event carries an optional link that should be treated as default link value.

See Also:

Constant Field Values

Method Detail

firePluginEvent

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

default void firePluginEvent(String event)

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

addListener

void addListener(MagnoliaCKEditorTextFieldEvents.PluginListener listener)