info.magnolia.ui.vaadin.ckeditor

Class MagnoliaCKEditorConfig

java.lang.Object

org.vaadin.alump.ckeditor.CKEditorConfig

info.magnolia.ui.vaadin.ckeditor.MagnoliaCKEditorConfig

All Implemented Interfaces:

Serializable

public class MagnoliaCKEditorConfig
extends org.vaadin.alump.ckeditor.CKEditorConfig

Magnolia 6 - Vaadin 8 extension of CKEditorConfig in order to define a more coherent toolbar API and configure custom plugins.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MagnoliaCKEditorConfig.ToolbarGroup Represents a CKEditor toolbar.

Nested classes/interfaces inherited from class org.vaadin.alump.ckeditor.CKEditorConfig

org.vaadin.alump.ckeditor.CKEditorConfig.RESIZE_DIR

Field Summary

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

allowedContent, baseFloatZIndex, bodyClass, CKEDITOR_DEFAULT_FONT_NAMES, CKEDITOR_KEYSTROKE_ALT, CKEDITOR_KEYSTROKE_CTRL, CKEDITOR_KEYSTROKE_SHIFT, contentsCssFiles, customToolbarLines, disableNativeSpellChecker, enterMode, extraAllowedContent, extraConfigLines, extraPlugins, filebrowserBrowseUrl, filebrowserFlashBrowseLinkUrl, filebrowserFlashBrowseUrl, filebrowserFlashUploadUrl, filebrowserImageBrowseLinkUrl, filebrowserImageBrowseUrl, filebrowserImageUploadUrl, filebrowserImageWindowHeight, filebrowserImageWindowWidth, filebrowserLinkBrowseUrl, filebrowserUploadUrl, filebrowserWindowHeight, filebrowserWindowWidth, fontNames, forceEnterMode, forcePasteAsPlainText, fullPage, height, inPageConfig, keystrokeMappings, language, pasteFromWordPromptCleanup, pasteFromWordRemoveFontStyles, protectedSource, readOnly, removePlugins, resizeDir, resizeEnabled, resizeMaxHeight, resizeMaxWidth, resizeMinHeight, resizeMinWidth, shiftEnterMode, skin, startupFocus, startupMode, stylesSet, tabSpaces, templates_files, templates_replaceContent, toolbarCanCollapse, toolbarStartupExpanded, width, writerIndentationChars, writerRules

Constructor Summary

Constructors

Constructor and Description
MagnoliaCKEditorConfig()

Method Summary

Modifier and Type	Method and Description
void	addExternalPlugin(String pluginName, String source)
void	addExtraConfig(String extraConfigName, String extraConfigValue)
void	addListenedEvent(String eventName) Add CKEditor event name that server side will listen.
void	addToExtraPlugins(String pluginName)
void	addToolbarLine(List<MagnoliaCKEditorConfig.ToolbarGroup> toolbars) Adds list of toolbar groups.
void	addToRemovePlugins(String pluginName)
static List<MagnoliaCKEditorConfig.ToolbarGroup>	defaultToolbar()
Map<String,String>	getExternalPlugins()
String[]	getListenedEvents()
void	setBaseFloatZIndex(int zIndex)
void	setResizeEnabled(boolean enabled)

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

addCustomToolbarLine, addFontName, addKeystrokeMapping, addProtectedSource, addTemplatesFiles, addWriterRules, appendJSONConfig, disableElementsPath, disableResizeEditor, disableSpellChecker, enableCtrlSWithVaadinSavePlugin, enableVaadinSavePlugin, getCkeditorDefaultFontNameList, getFontNameList, getInPageConfig, getKeystrokeCommandByKeystroke, getKeystrokes, getProtectedSource, getWriterIndentationChars, getWriterRuleByTagName, getWriterRulesTagNames, hasKeystrokeMappings, hasProtectedSource, hasWriterIndentationChars, hasWriterRules, isReadOnly, setAllowedContent, setAllowedContentAll, setBodyClass, setContentsCss, setDisableNativeSpellChecker, setEnterMode, setEnterMode, setExtraAllowedContent, setFilebrowserBrowseUrl, setFilebrowserFlashBrowseLinkUrl, setFilebrowserFlashBrowseUrl, setFilebrowserFlashUploadUrl, setFilebrowserImageBrowseLinkUrl, setFilebrowserImageBrowseUrl, setFilebrowserImageUploadUrl, setFilebrowserImageWindowHeight, setFilebrowserImageWindowWidth, setFilebrowserLinkBrowseUrl, setFilebrowserUploadUrl, setFilebrowserWindowHeight, setFilebrowserWindowWidth, setFontNames, setFontNames, setForceEnterMode, setForcePasteAsPlainText, setFullPage, setHeight, setInPageConfig, setLanguage, setPasteFromWordPromptCleanup, setPasteFromWordRemoveFontStyles, setReadOnly, setResizeDir, setResizeMaxHeight, setResizeMaxWidth, setResizeMinHeight, setResizeMinWidth, setShiftEnterMode, setShiftEnterMode, setSkin, setStartupFocus, setStartupModeSource, setStartupModeWysiwyg, setStylesSet, setTabSpaces, setTemplatesReplaceContent, setToolbarCanCollapse, setToolbarStartupExpanded, setupForOpenESignForms, setWidth, setWriterIndentationChars, useCompactTags

Methods inherited from class java.lang.Object

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

Constructor Detail

MagnoliaCKEditorConfig

public MagnoliaCKEditorConfig()

Method Detail

addToolbarLine

public void addToolbarLine(List<MagnoliaCKEditorConfig.ToolbarGroup> toolbars)

Adds list of toolbar groups. Groups are placed in one row if space allows.

addListenedEvent

public void addListenedEvent(String eventName)

Add CKEditor event name that server side will listen. Only event names added to configuration will be listened.

Parameters:

eventName - This must match in client side. e.g: editor.fire('eventName')

getListenedEvents

public String[] getListenedEvents()

addExternalPlugin

public void addExternalPlugin(String pluginName,
                              String source)

getExternalPlugins

public Map<String,String> getExternalPlugins()

addExtraConfig

public void addExtraConfig(String extraConfigName,
                           String extraConfigValue)

Overrides:

addExtraConfig in class org.vaadin.alump.ckeditor.CKEditorConfig

addToRemovePlugins

public void addToRemovePlugins(String pluginName)

Overrides:

addToRemovePlugins in class org.vaadin.alump.ckeditor.CKEditorConfig

addToExtraPlugins

public void addToExtraPlugins(String pluginName)

Overrides:

addToExtraPlugins in class org.vaadin.alump.ckeditor.CKEditorConfig

setBaseFloatZIndex

public void setBaseFloatZIndex(int zIndex)

Overrides:

setBaseFloatZIndex in class org.vaadin.alump.ckeditor.CKEditorConfig

setResizeEnabled

public void setResizeEnabled(boolean enabled)

Overrides:

setResizeEnabled in class org.vaadin.alump.ckeditor.CKEditorConfig

defaultToolbar

public static List<MagnoliaCKEditorConfig.ToolbarGroup> defaultToolbar()