CKEditorConfig (Vaadin 7 compatibility add-on wrappers (parent pom) 1.3.5 API)

java.lang.Object
- org.vaadin.openesignforms.ckeditor.CKEditorConfig

All Implemented Interfaces:

Serializable
```
public class CKEditorConfig
extends Object
implements Serializable
```
Configuration utility for using the CKEditorTextField. You can use this "config javascript builder" object for our tested/common options, or just set the options using a JavaScript/JSON string as you prefer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CKEditorConfig.RESIZE_DIR

Nested Classes
Modifier and Type	Class and Description
`static class`	`CKEditorConfig.RESIZE_DIR`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`allowedContent`
`protected Integer`	`baseFloatZIndex`
`protected String`	`bodyClass`
`static String`	`CKEDITOR_DEFAULT_FONT_NAMES` Sets the font_names config option, which is the registered style name
`static int`	`CKEDITOR_KEYSTROKE_ALT`
`static int`	`CKEDITOR_KEYSTROKE_CTRL`
`static int`	`CKEDITOR_KEYSTROKE_SHIFT`
`protected String[]`	`contentsCssFiles`
`protected LinkedList<String>`	`customToolbarLines`
`protected Boolean`	`disableNativeSpellChecker`
`protected Integer`	`enterMode`
`protected String`	`extraAllowedContent`
`protected LinkedList<String>`	`extraConfigLines`
`protected LinkedList<String>`	`extraPlugins`
`protected String`	`filebrowserBrowseUrl`
`protected String`	`filebrowserFlashBrowseLinkUrl`
`protected String`	`filebrowserFlashBrowseUrl`
`protected String`	`filebrowserFlashUploadUrl`
`protected String`	`filebrowserImageBrowseLinkUrl`
`protected String`	`filebrowserImageBrowseUrl`
`protected String`	`filebrowserImageUploadUrl`
`protected String`	`filebrowserImageWindowHeight`
`protected String`	`filebrowserImageWindowWidth`
`protected String`	`filebrowserLinkBrowseUrl`
`protected String`	`filebrowserUploadUrl`
`protected String`	`filebrowserWindowHeight`
`protected String`	`filebrowserWindowWidth`
`protected String`	`fontNames`
`protected Boolean`	`forceEnterMode`
`protected Boolean`	`forcePasteAsPlainText`
`protected Boolean`	`fullPage`
`protected String`	`height`
`protected String`	`inPageConfig`
`protected HashMap<Integer,String>`	`keystrokeMappings`
`protected String`	`language`
`protected Boolean`	`pasteFromWordPromptCleanup`
`protected Boolean`	`pasteFromWordRemoveFontStyles`
`protected LinkedList<String>`	`protectedSource`
`protected Boolean`	`readOnly`
`protected LinkedList<String>`	`removePlugins`
`protected String`	`resizeDir`
`protected Boolean`	`resizeEnabled`
`protected Integer`	`resizeMaxHeight`
`protected Integer`	`resizeMaxWidth`
`protected Integer`	`resizeMinHeight`
`protected Integer`	`resizeMinWidth`
`protected Integer`	`shiftEnterMode`
`protected String`	`skin`
`protected Boolean`	`startupFocus`
`protected String`	`startupMode`
`protected String`	`stylesSet`
`protected Integer`	`tabSpaces`
`protected LinkedList<String>`	`templates_files`
`protected Boolean`	`templates_replaceContent`
`protected Boolean`	`toolbarCanCollapse`
`protected Boolean`	`toolbarStartupExpanded`
`protected String`	`width`
`protected String`	`writerIndentationChars`
`protected HashMap<String,String>`	`writerRules`

Constructor Summary

Constructors
Constructor and Description

CKEditorConfig()

Constructors
Constructor and Description
`CKEditorConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomToolbarLine(String toolbarLineJS)` If no custom toolbar is defined, it will use the Full toolbar by default (config.toolbar = 'Full').
`void`	`addExtraConfig(String extraConfigName, String extraConfigValue)` Allows you to add any CKEDITOR.config option line to the in page configuration.
`void`	`addFontName(String newFontNameSpec)`
`void`	`addKeystrokeMapping(int keystroke, String command)`
`void`	`addProtectedSource(String regex)` Add a protected source regular express to the list Typical values are regular expressions like: /<%.*%>/g If you don't start with a '/', a leading '/' and a trailing '/g' will be added automatically.
`void`	`addTemplatesFiles(String templateURL)` Add a new template url to the list of templates
`void`	`addToExtraPlugins(String pluginName)`
`void`	`addToRemovePlugins(String pluginName)`
`void`	`addWriterRules(String tagName, String jsRule)`
`protected StringBuilder`	`appendJSONConfig(StringBuilder configBuf, String oneOptions)`
`void`	`disableElementsPath()`
`void`	`disableResizeEditor()`
`void`	`disableSpellChecker()`
`void`	`enableCtrlSWithVaadinSavePlugin()` Enabled the vaadinsave plugin and sets the keystroke mapping for CTRL-S to trigger it.
`void`	`enableVaadinSavePlugin()` This enables the vaadinsave plugin.
`List<String>`	`getCkeditorDefaultFontNameList()`
`List<String>`	`getFontNameList()`
`String`	`getInPageConfig()`
`String`	`getKeystrokeCommandByKeystroke(Integer keystroke)`
`Set<Integer>`	`getKeystrokes()`
`List<String>`	`getProtectedSource()`
`String`	`getWriterIndentationChars()`
`String`	`getWriterRuleByTagName(String tagName)`
`Set<String>`	`getWriterRulesTagNames()`
`boolean`	`hasKeystrokeMappings()`
`boolean`	`hasProtectedSource()`
`boolean`	`hasWriterIndentationChars()`
`boolean`	`hasWriterRules()`
`boolean`	`isReadOnly()`
`void`	`setAllowedContent(String acfSpec)`
`void`	`setAllowedContentAll()`
`void`	`setBaseFloatZIndex(int zIndex)`
`void`	`setBodyClass(String bc)` Sets the body class for the HTML editor, so if you render the results in a body with a given class, you can give it here too so that the editor will show the same styles you may have in your contents css.
`void`	`setContentsCss(String... cssFiles)` Sets the file or list of files for the contents to be applied to the editor.
`void`	`setDisableNativeSpellChecker(boolean v)`
`void`	`setEnterMode(int enterMode)`
`void`	`setEnterMode(String enterMode)` Sets 'enterMode' such that "P" will be 1, "BR" will be 2 and "DIV" will be 3.
`void`	`setExtraAllowedContent(String acfSpec)`
`void`	`setFilebrowserBrowseUrl(String url)` Sets the filebrowserBrowseUrl config option, which is an URL that will list files a user can select from
`void`	`setFilebrowserFlashBrowseLinkUrl(String url)` Sets the filebrowserFlashBrowseLinkUrl config option, which is an URL that will allow for link browsing in the Flash property dialog
`void`	`setFilebrowserFlashBrowseUrl(String url)` Sets the filebrowserFlashBrowseUrl config option, which is an URL that will allow browsing for Flash
`void`	`setFilebrowserFlashUploadUrl(String url)` Sets the filebrowserFlashUploadUrl config option, which is an URL that will allow a Flash file to be uploaded
`void`	`setFilebrowserImageBrowseLinkUrl(String url)` Sets the filebrowserImageBrowseLinkUrl config option, which is an URL that will allow for link browsing in the Image property dialog
`void`	`setFilebrowserImageBrowseUrl(String url)` Sets the filebrowserImageBrowseUrl config option, which is an URL that will list images a user can select from
`void`	`setFilebrowserImageUploadUrl(String url)` Sets the filebrowserImageUploadUrl config option, which is an URL that will allow an image file to be uploaded
`void`	`setFilebrowserImageWindowHeight(String size)` Sets the filebrowserImageWindowHeight config option, which is a height size spec (like "600" for 600 pixels); CKEditor defaults to 70%
`void`	`setFilebrowserImageWindowWidth(String size)` Sets the filebrowserImageWindowWidth config option, which is a width size spec (like "600" for 600 pixels); CKEditor defaults to 80%
`void`	`setFilebrowserLinkBrowseUrl(String url)` Sets the filebrowserLinkBrowseUrl config option, which is an URL that will allow for link browsing
`void`	`setFilebrowserUploadUrl(String url)` Sets the filebrowserUploadUrl config option, which is an URL that will allow a file to be uploaded
`void`	`setFilebrowserWindowHeight(String size)` Sets the filebrowserWindowHeight config option, which is a height size spec (like "600" for 600 pixels); CKEditor defaults to 70%
`void`	`setFilebrowserWindowWidth(String size)` Sets the filebrowserWindowWidth config option, which is a width size spec (like "600" for 600 pixels); CKEditor defaults to 80%
`void`	`setFontNames(List<String> fontNamesSpec)`
`void`	`setFontNames(String fontNamesSpec)`
`void`	`setForceEnterMode(Boolean forceEnterMode)`
`void`	`setForcePasteAsPlainText(Boolean forcePasteAsPlainText)`
`void`	`setFullPage(Boolean fullPage)`
`void`	`setHeight(String cssSize)`
`void`	`setInPageConfig(String js)` You can use this to just set the JavaScript/JSON notation for setting the 'in page config' option when the editor is created.
`void`	`setLanguage(String language)`
`void`	`setPasteFromWordPromptCleanup(boolean v)`
`void`	`setPasteFromWordRemoveFontStyles(boolean v)`
`void`	`setReadOnly(boolean v)`
`void`	`setResizeDir(CKEditorConfig.RESIZE_DIR dir)`
`void`	`setResizeEnabled(boolean v)`
`void`	`setResizeMaxHeight(int pixels)`
`void`	`setResizeMaxWidth(int pixels)`
`void`	`setResizeMinHeight(int pixels)`
`void`	`setResizeMinWidth(int pixels)`
`void`	`setShiftEnterMode(int shiftEnterMode)`
`void`	`setShiftEnterMode(String shiftEnterMode)` Sets 'shiftEnterMode' such that "P" will be 1, "BR" will be 2 and "DIV" will be 3.
`void`	`setSkin(String newSkin)` Possible skins: moono The default skin for CKEditor 4.x kama The default skin for CKEditor 3.x office2003 v2
`void`	`setStartupFocus(boolean v)`
`void`	`setStartupModeSource()`
`void`	`setStartupModeWysiwyg()`
`void`	`setStylesSet(String styleSetSpec)` Sets the stylesSet config option, which is the registered style name
`void`	`setTabSpaces(int numSpaces)`
`void`	`setTemplatesReplaceContent(Boolean templatesReplaceContent)`
`void`	`setToolbarCanCollapse(boolean v)`
`void`	`setToolbarStartupExpanded(Boolean newToolbarStartupExpanded)`
`void`	`setupForOpenESignForms(String contextPath, String ckeditorContextIdInSession, String bodyCssClass, String... extraCssFiles)` Convenience method for the Open eSignForms project sponsors to set the plugins and configuration in a common way needed.
`void`	`setWidth(String cssSize)`
`void`	`setWriterIndentationChars(String v)`
`void`	`useCompactTags()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - inPageConfig
```
protected String inPageConfig
```
  - extraConfigLines
```
protected LinkedList<String> extraConfigLines
```
  - writerRules
```
protected HashMap<String,String> writerRules
```
  - writerIndentationChars
```
protected String writerIndentationChars
```
  - keystrokeMappings
```
protected HashMap<Integer,String> keystrokeMappings
```
  - extraPlugins
```
protected LinkedList<String> extraPlugins
```
  - removePlugins
```
protected LinkedList<String> removePlugins
```
  - customToolbarLines
```
protected LinkedList<String> customToolbarLines
```
  - toolbarCanCollapse
```
protected Boolean toolbarCanCollapse
```
  - disableNativeSpellChecker
```
protected Boolean disableNativeSpellChecker
```
  - resizeEnabled
```
protected Boolean resizeEnabled
```
  - resizeDir
```
protected String resizeDir
```
  - resizeMinWidth
```
protected Integer resizeMinWidth
```
  - resizeMaxWidth
```
protected Integer resizeMaxWidth
```
  - resizeMinHeight
```
protected Integer resizeMinHeight
```
  - resizeMaxHeight
```
protected Integer resizeMaxHeight
```
  - width
```
protected String width
```
  - height
```
protected String height
```
  - baseFloatZIndex
```
protected Integer baseFloatZIndex
```
  - tabSpaces
```
protected Integer tabSpaces
```
  - pasteFromWordRemoveFontStyles
```
protected Boolean pasteFromWordRemoveFontStyles
```
  - pasteFromWordPromptCleanup
```
protected Boolean pasteFromWordPromptCleanup
```
  - startupMode
```
protected String startupMode
```
  - startupFocus
```
protected Boolean startupFocus
```
  - readOnly
```
protected Boolean readOnly
```
  - contentsCssFiles
```
protected String[] contentsCssFiles
```
  - fontNames
```
protected String fontNames
```
  - stylesSet
```
protected String stylesSet
```
  - bodyClass
```
protected String bodyClass
```
  - skin
```
protected String skin
```
  - toolbarStartupExpanded
```
protected Boolean toolbarStartupExpanded
```
  - templates_files
```
protected LinkedList<String> templates_files
```
  - templates_replaceContent
```
protected Boolean templates_replaceContent
```
  - allowedContent
```
protected String allowedContent
```
  - extraAllowedContent
```
protected String extraAllowedContent
```
  - filebrowserBrowseUrl
```
protected String filebrowserBrowseUrl
```
  - filebrowserUploadUrl
```
protected String filebrowserUploadUrl
```
  - filebrowserWindowWidth
```
protected String filebrowserWindowWidth
```
  - filebrowserWindowHeight
```
protected String filebrowserWindowHeight
```
  - filebrowserImageBrowseUrl
```
protected String filebrowserImageBrowseUrl
```
  - filebrowserImageUploadUrl
```
protected String filebrowserImageUploadUrl
```
  - filebrowserImageWindowWidth
```
protected String filebrowserImageWindowWidth
```
  - filebrowserImageWindowHeight
```
protected String filebrowserImageWindowHeight
```
  - filebrowserImageBrowseLinkUrl
```
protected String filebrowserImageBrowseLinkUrl
```
  - filebrowserFlashBrowseUrl
```
protected String filebrowserFlashBrowseUrl
```
  - filebrowserFlashUploadUrl
```
protected String filebrowserFlashUploadUrl
```
  - filebrowserFlashBrowseLinkUrl
```
protected String filebrowserFlashBrowseLinkUrl
```
  - filebrowserLinkBrowseUrl
```
protected String filebrowserLinkBrowseUrl
```
  - enterMode
```
protected Integer enterMode
```
  - shiftEnterMode
```
protected Integer shiftEnterMode
```
  - forceEnterMode
```
protected Boolean forceEnterMode
```
  - forcePasteAsPlainText
```
protected Boolean forcePasteAsPlainText
```
  - fullPage
```
protected Boolean fullPage
```
  - language
```
protected String language
```
  - protectedSource
```
protected LinkedList<String> protectedSource
```
  - CKEDITOR_KEYSTROKE_ALT
```
public static int CKEDITOR_KEYSTROKE_ALT
```
  - CKEDITOR_KEYSTROKE_CTRL
```
public static int CKEDITOR_KEYSTROKE_CTRL
```
  - CKEDITOR_KEYSTROKE_SHIFT
```
public static int CKEDITOR_KEYSTROKE_SHIFT
```
  - CKEDITOR_DEFAULT_FONT_NAMES
```
public static final String CKEDITOR_DEFAULT_FONT_NAMES
```
    Sets the font_names config option, which is the registered style name
    
    See Also:
    
    for a string that shows the built-in fonts., to get a list of the fonts so you can insert easily if you want and then set with #setFontNames(List fontNamesSpec) or addFontName(String newFontName), Constant Field Values
- Constructor Detail
  - CKEditorConfig
```
public CKEditorConfig()
```
- Method Detail
  - getInPageConfig
```
public String getInPageConfig()
```
  - appendJSONConfig
```
protected StringBuilder appendJSONConfig(StringBuilder configBuf,
                                         String oneOptions)
```
  - setInPageConfig
```
public void setInPageConfig(String js)
```
    You can use this to just set the JavaScript/JSON notation for setting the 'in page config' option when the editor is created. If you don't use this, you can use all of the other builder routines that set options that are then used to generate the JSON notation to use
    
    Parameters:
    
    js - the String JSON 'config' for the new editor instance.
  - addExtraConfig
```
public void addExtraConfig(String extraConfigName,
                           String extraConfigValue)
```
    Allows you to add any CKEDITOR.config option line to the in page configuration. This is considered a hack, but may be necessary if you are setting an option not supported by the API of this class. We recommend that you request the API be changed when you find you need to use this, but it'll keep you going while you await the API-based scheme. The resulting will be to add a JSON line to the in-page config like: extraConfigName : extraConfigValue
    Parameters: extraConfigName - the String CKEDITOR.config name to set extraConfigValue - the String value
  hasWriterRules public boolean hasWriterRules() getWriterRulesTagNames public Set<String> getWriterRulesTagNames() getWriterRuleByTagName public String getWriterRuleByTagName(String tagName) addWriterRules public void addWriterRules(String tagName, String jsRule) hasKeystrokeMappings public boolean hasKeystrokeMappings() getKeystrokes public Set<Integer> getKeystrokes() getKeystrokeCommandByKeystroke public String getKeystrokeCommandByKeystroke(Integer keystroke) addKeystrokeMapping public void addKeystrokeMapping(int keystroke, String command) enableCtrlSWithVaadinSavePlugin public void enableCtrlSWithVaadinSavePlugin() Enabled the vaadinsave plugin and sets the keystroke mapping for CTRL-S to trigger it. See Also: enableVaadinSavePlugin(), addKeystrokeMapping(int, java.lang.String) useCompactTags public void useCompactTags() getWriterIndentationChars public String getWriterIndentationChars() hasWriterIndentationChars public boolean hasWriterIndentationChars() setWriterIndentationChars public void setWriterIndentationChars(String v) addToExtraPlugins public void addToExtraPlugins(String pluginName) enableVaadinSavePlugin public void enableVaadinSavePlugin() This enables the vaadinsave plugin. You will also need a custom toolbar with the entry 'VaadinSave' included to put it the specified position. If you'd also like CTRL-S to trigger, call enableCtrlSWithVaadinSavePlugin() instead. See Also: enableCtrlSWithVaadinSavePlugin() setupForOpenESignForms public void setupForOpenESignForms(String contextPath, String ckeditorContextIdInSession, String bodyCssClass, String... extraCssFiles) Convenience method for the Open eSignForms project sponsors to set the plugins and configuration in a common way needed. addToRemovePlugins public void addToRemovePlugins(String pluginName) disableElementsPath public void disableElementsPath() disableResizeEditor public void disableResizeEditor() disableSpellChecker public void disableSpellChecker() setDisableNativeSpellChecker public void setDisableNativeSpellChecker(boolean v) addCustomToolbarLine public void addCustomToolbarLine(String toolbarLineJS) If no custom toolbar is defined, it will use the Full toolbar by default (config.toolbar = 'Full'). The format of the toolbar configuration changed in CKEditor 3.6 (our library 1.3). Note that each line is generally one 'band' so that they all appear together. For example: { name: 'styles', items : ['Styles','Format','Font','FontSize','TextColor','BGColor','Maximize', 'ShowBlocks','-','About'] } Parameters: toolbarLineJS - setToolbarCanCollapse public void setToolbarCanCollapse(boolean v) setSkin public void setSkin(String newSkin) Possible skins: moono The default skin for CKEditor 4.x kama The default skin for CKEditor 3.x office2003 v2 Parameters: newSkin - the skin to set setToolbarStartupExpanded public void setToolbarStartupExpanded(Boolean newToolbarStartupExpanded) Parameters: newToolbarStartupExpanded - the toolbarStartupExpanded status setResizeEnabled public void setResizeEnabled(boolean v) setResizeDir public void setResizeDir(CKEditorConfig.RESIZE_DIR dir) setResizeMinWidth public void setResizeMinWidth(int pixels) setResizeMaxWidth public void setResizeMaxWidth(int pixels) setResizeMinHeight public void setResizeMinHeight(int pixels) setResizeMaxHeight public void setResizeMaxHeight(int pixels) setWidth public void setWidth(String cssSize) setHeight public void setHeight(String cssSize) setBaseFloatZIndex public void setBaseFloatZIndex(int zIndex) setTabSpaces public void setTabSpaces(int numSpaces) setPasteFromWordRemoveFontStyles public void setPasteFromWordRemoveFontStyles(boolean v) setPasteFromWordPromptCleanup public void setPasteFromWordPromptCleanup(boolean v) setStartupModeSource public void setStartupModeSource() setStartupModeWysiwyg public void setStartupModeWysiwyg() setStartupFocus public void setStartupFocus(boolean v) isReadOnly public boolean isReadOnly() setReadOnly public void setReadOnly(boolean v) setContentsCss public void setContentsCss(String... cssFiles) Sets the file or list of files for the contents to be applied to the editor. Used to set the styles that will be used in the page where the HTML will actually be rendered. Parameters: cssFiles - zero or more String file URL paths -- for same system, starting with context path is recommended: /myapp/path/to/cssfile.css setBodyClass public void setBodyClass(String bc) Sets the body class for the HTML editor, so if you render the results in a body with a given class, you can give it here too so that the editor will show the same styles you may have in your contents css. Parameters: bc - getCkeditorDefaultFontNameList public List<String> getCkeditorDefaultFontNameList() getFontNameList public List<String> getFontNameList() setFontNames public void setFontNames(List<String> fontNamesSpec) addFontName public void addFontName(String newFontNameSpec) setFontNames public void setFontNames(String fontNamesSpec) setStylesSet public void setStylesSet(String styleSetSpec) Sets the stylesSet config option, which is the registered style name Parameters: styleSetSpec - setFilebrowserBrowseUrl public void setFilebrowserBrowseUrl(String url) Sets the filebrowserBrowseUrl config option, which is an URL that will list files a user can select from Parameters: url - setFilebrowserUploadUrl public void setFilebrowserUploadUrl(String url) Sets the filebrowserUploadUrl config option, which is an URL that will allow a file to be uploaded Parameters: url - setFilebrowserWindowWidth public void setFilebrowserWindowWidth(String size) Sets the filebrowserWindowWidth config option, which is a width size spec (like "600" for 600 pixels); CKEditor defaults to 80% Parameters: url - setFilebrowserWindowHeight public void setFilebrowserWindowHeight(String size) Sets the filebrowserWindowHeight config option, which is a height size spec (like "600" for 600 pixels); CKEditor defaults to 70% Parameters: url - setFilebrowserImageBrowseUrl public void setFilebrowserImageBrowseUrl(String url) Sets the filebrowserImageBrowseUrl config option, which is an URL that will list images a user can select from Parameters: url - setFilebrowserImageUploadUrl public void setFilebrowserImageUploadUrl(String url) Sets the filebrowserImageUploadUrl config option, which is an URL that will allow an image file to be uploaded Parameters: url - setFilebrowserImageWindowWidth public void setFilebrowserImageWindowWidth(String size) Sets the filebrowserImageWindowWidth config option, which is a width size spec (like "600" for 600 pixels); CKEditor defaults to 80% Parameters: url - setFilebrowserImageWindowHeight public void setFilebrowserImageWindowHeight(String size) Sets the filebrowserImageWindowHeight config option, which is a height size spec (like "600" for 600 pixels); CKEditor defaults to 70% Parameters: url - setFilebrowserFlashBrowseUrl public void setFilebrowserFlashBrowseUrl(String url) Sets the filebrowserFlashBrowseUrl config option, which is an URL that will allow browsing for Flash Parameters: url - setFilebrowserFlashUploadUrl public void setFilebrowserFlashUploadUrl(String url) Sets the filebrowserFlashUploadUrl config option, which is an URL that will allow a Flash file to be uploaded Parameters: url - setFilebrowserLinkBrowseUrl public void setFilebrowserLinkBrowseUrl(String url) Sets the filebrowserLinkBrowseUrl config option, which is an URL that will allow for link browsing Parameters: url - setFilebrowserFlashBrowseLinkUrl public void setFilebrowserFlashBrowseLinkUrl(String url) Sets the filebrowserFlashBrowseLinkUrl config option, which is an URL that will allow for link browsing in the Flash property dialog Parameters: url - the filebrowserFlashBrowseLinkUrl to set setFilebrowserImageBrowseLinkUrl public void setFilebrowserImageBrowseLinkUrl(String url) Sets the filebrowserImageBrowseLinkUrl config option, which is an URL that will allow for link browsing in the Image property dialog Parameters: url - the filebrowserImageBrowseLinkUrl to set addTemplatesFiles public void addTemplatesFiles(String templateURL) Add a new template url to the list of templates Parameters: templateURL - setEnterMode public void setEnterMode(String enterMode) Sets 'enterMode' such that "P" will be 1, "BR" will be 2 and "DIV" will be 3. Any other value will set it to 1. Parameters: enterMode - string code See Also: to just set by integer value setEnterMode public void setEnterMode(int enterMode) setShiftEnterMode public void setShiftEnterMode(String shiftEnterMode) Sets 'shiftEnterMode' such that "P" will be 1, "BR" will be 2 and "DIV" will be 3. Any other value will set it to 1. Parameters: shiftEnterMode - string code See Also: to just set by integer value setShiftEnterMode public void setShiftEnterMode(int shiftEnterMode) setForceEnterMode public void setForceEnterMode(Boolean forceEnterMode) setForcePasteAsPlainText public void setForcePasteAsPlainText(Boolean forcePasteAsPlainText) setLanguage public void setLanguage(String language) setTemplatesReplaceContent public void setTemplatesReplaceContent(Boolean templatesReplaceContent) setFullPage public void setFullPage(Boolean fullPage) addProtectedSource public void addProtectedSource(String regex) Add a protected source regular express to the list Typical values are regular expressions like: /<%.*%>/g If you don't start with a '/', a leading '/' and a trailing '/g' will be added automatically. Parameters: regex - the String regular expression of the protected source hasProtectedSource public boolean hasProtectedSource() getProtectedSource public List<String> getProtectedSource() setAllowedContent public void setAllowedContent(String acfSpec) setAllowedContentAll public void setAllowedContentAll() setExtraAllowedContent public void setExtraAllowedContent(String acfSpec)

Class CKEditorConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inPageConfig

extraConfigLines

writerRules

writerIndentationChars

keystrokeMappings

extraPlugins

removePlugins

customToolbarLines

toolbarCanCollapse

disableNativeSpellChecker

resizeEnabled

resizeDir

resizeMinWidth

resizeMaxWidth

resizeMinHeight

resizeMaxHeight

width

height

baseFloatZIndex

tabSpaces

pasteFromWordRemoveFontStyles

pasteFromWordPromptCleanup

startupMode

startupFocus

readOnly

contentsCssFiles

fontNames

stylesSet

bodyClass

skin

toolbarStartupExpanded

templates_files

templates_replaceContent

allowedContent

extraAllowedContent

filebrowserBrowseUrl

filebrowserUploadUrl

filebrowserWindowWidth

filebrowserWindowHeight

filebrowserImageBrowseUrl

filebrowserImageUploadUrl

filebrowserImageWindowWidth

filebrowserImageWindowHeight

filebrowserImageBrowseLinkUrl

filebrowserFlashBrowseUrl

filebrowserFlashUploadUrl

filebrowserFlashBrowseLinkUrl

filebrowserLinkBrowseUrl

enterMode

shiftEnterMode

forceEnterMode

forcePasteAsPlainText

fullPage

language

protectedSource

CKEDITOR_KEYSTROKE_ALT

CKEDITOR_KEYSTROKE_CTRL

CKEDITOR_KEYSTROKE_SHIFT

CKEDITOR_DEFAULT_FONT_NAMES

Constructor Detail

CKEditorConfig

Method Detail

getInPageConfig

appendJSONConfig

setInPageConfig

addExtraConfig

hasWriterRules

getWriterRulesTagNames

getWriterRuleByTagName

addWriterRules

hasKeystrokeMappings

getKeystrokes

getKeystrokeCommandByKeystroke