info.magnolia.ui.vaadin.richtext

Class MagnoliaRichTextFieldConfig

java.lang.Object

org.vaadin.openesignforms.ckeditor.CKEditorConfig

info.magnolia.ui.vaadin.richtext.MagnoliaRichTextFieldConfig

All Implemented Interfaces:

Serializable

public class MagnoliaRichTextFieldConfig
extends org.vaadin.openesignforms.ckeditor.CKEditorConfig

Magnolia5 / Vaadin7 compatibility class. Extends CKEditorConfig by defining more coherent toolbar API and configuring custom plugins.

See Also:

Serialized Form

Nested Class Summary

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

org.vaadin.openesignforms.ckeditor.CKEditorConfig.RESIZE_DIR

Field Summary

Fields inherited from class org.vaadin.openesignforms.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
MagnoliaRichTextFieldConfig()

Method Summary

Modifier and Type	Method and Description
void	addExternalPlugin(String pluginName, String source)
void	addListenedEvent(String eventName) Add CKEditor event name that server side will listen.
void	addToolbarLine(List<MagnoliaCKEditorConfig.ToolbarGroup> toolbars) Adds list of toolbar groups.
Map<String,String>	getExternalPlugins()
String[]	getListenedEvents()

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

addCustomToolbarLine, addExtraConfig, addFontName, addKeystrokeMapping, addProtectedSource, addTemplatesFiles, addToExtraPlugins, addToRemovePlugins, addWriterRules, appendJSONConfig, disableElementsPath, disableResizeEditor, disableSpellChecker, enableCtrlSWithVaadinSavePlugin, enableVaadinSavePlugin, getCkeditorDefaultFontNameList, getFontNameList, getInPageConfig, getKeystrokeCommandByKeystroke, getKeystrokes, getProtectedSource, getWriterIndentationChars, getWriterRuleByTagName, getWriterRulesTagNames, hasKeystrokeMappings, hasProtectedSource, hasWriterIndentationChars, hasWriterRules, isReadOnly, setAllowedContent, setAllowedContentAll, setBaseFloatZIndex, 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, setResizeEnabled, 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

MagnoliaRichTextFieldConfig

public MagnoliaRichTextFieldConfig()

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()