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

Extends CKEditorConfig by defining more coherent toolbar API and configuring custom plugins.

See Also:

Serialized Form

Nested Class Summary

static class

MagnoliaRichTextFieldConfig.ToolbarGroup Bean class for toolbar group.

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, 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, language, pasteFromWordNumberedHeadingToList, pasteFromWordPromptCleanup, pasteFromWordRemoveFontStyles, pasteFromWordRemoveStyles, protectedSource, removePlugins, resizeDir, resizeEnabled, resizeMaxHeight, resizeMaxWidth, resizeMinHeight, resizeMinWidth, shiftEnterMode, skin, startupFocus, startupMode, stylesSet, tabSpaces, templates_files, templates_replaceContent, toolbarCanCollapse, toolbarStartupExpanded, width, writerIndentationChars, writerRules

Constructor Summary

MagnoliaRichTextFieldConfig()

Method Summary

void	addListenedEvent(String eventName) Add CKEditor event name that server side will listen.
void	addPlugin(String pluginName, String source)
void	addToolbarLine(List<MagnoliaRichTextFieldConfig.ToolbarGroup> toolbars) Adds list of toolbar groups.

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

addCustomToolbarLine, addExtraConfig, addFontName, addProtectedSource, addTemplatesFiles, addToExtraPlugins, addToRemovePlugins, addWriterRules, appendJSONConfig, disableElementsPath, disableResizeEditor, disableSpellChecker, enableVaadinSavePlugin, getCkeditorDefaultFontNameList, getFontNameList, getInPageConfig, getProtectedSource, getWriterIndentationChars, getWriterRuleByTagName, getWriterRulesTagNames, hasProtectedSource, hasWriterIndentationChars, hasWriterRules, 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, setPasteFromWordNumberedHeadingToList, setPasteFromWordPromptCleanup, setPasteFromWordRemoveFontStyles, setPasteFromWordRemoveStyles, 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<MagnoliaRichTextFieldConfig.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')

addPlugin

public void addPlugin(String pluginName,
                      String source)