CkEditorWrapper.CKEditorConfigs (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.site.wicket.components.CkEditorWrapper.CKEditorConfigs

All Implemented Interfaces:: Serializable

Enclosing class:: CkEditorWrapper

public static final class CkEditorWrapper.CKEditorConfigs
extends Object
implements Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTRIB_AUTO_PARAGRAPH` autoParagraph : false Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode.
`static String`	`ATTRIB_BODY_ID` Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor.
`static String`	`ATTRIB_CSS` CSS(s) to import into the Editor
`static String`	`ATTRIB_CTX_MKUP_END` Deprecated. as it inserts it in the content can can lead to complications
`static String`	`ATTRIB_CTX_MKUP_START` Deprecated. as it inserts it in the content can can lead to complications
`static String`	`ATTRIB_CUSTOM_CONFIG` Suppose you copied the config.js file to a folder named custom in the root of your website.
`static String`	`ATTRIB_EDITOR_PAGE_HEADER` We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
`static String`	`ATTRIB_ENTER_MODE` For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
`static String`	`ATTRIB_FULLPAGE` by default false, if enabled/true then editor loads in Full page mode
`static String`	`ATTRIB_HEIGHT` Height of the Editor.
`static String`	`ATTRIB_RAW_CONFIG` A raw String that will be sent/appended to config
`static String`	`ATTRIB_TOOLBAR` Custom Toolbar Name It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
`static String`	`ATTRIB_WIDTH` Width of the Editor.

Constructor Summary

Constructors
Constructor and Description

CKEditorConfigs()

Constructors
Constructor and Description
`CKEditorConfigs()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAutoParagraph()` autoParagraph : false Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode.
`String`	`getBodyId()` Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor.
`List<String>`	`getContentsCss()` All the CSS path that should be imported into the editor
`String`	`getContextMarkupEnd()` Deprecated. as it inserts it in the content can can lead to complications
`String`	`getContextMarkupStart()` Deprecated. as it inserts it in the content can can lead to complications
`String`	`getCustomConfig()` Suppose you copied the config.js file to a folder named custom in the root of your website.
`String`	`getEditorPageHeader()` We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
`String`	`getEnterMode()` For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
`Object`	`getHeight()` pixels , for % specify %
`String`	`getRawConfig()` A raw String that will be sent/appended to config
`String`	`getToolbar()` Custom Toolbar Name It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
`Object`	`getWidth()` pixels , for % specify %
`boolean`	`isFullPage()`
`void`	`setAutoParagraph(String autoParagraph)` autoParagraph : false Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode.
`void`	`setBodyId(String bodyId)` Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor.
`void`	`setContentsCss(List<String> contentsCss)` All the CSS path that should be imported into the editor
`void`	`setContextMarkupEnd(String contextMarkupEnd)` Deprecated. as it inserts it in the content can can lead to complications
`void`	`setContextMarkupStart(String contextMarkupStart)` Deprecated. as it inserts it in the content can can lead to complications
`void`	`setCustomConfig(String customConfig)` Suppose you copied the config.js file to a folder named custom in the root of your website.
`void`	`setEditorPageHeader(String editorPageHeader)` We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
`void`	`setEnterMode(String enterMode)` For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
`void`	`setFullPage(boolean fullPage)`
`void`	`setHeight(Object height)` pixels , for % specify %
`void`	`setRawConfig(String rawConfig)` A raw String that will be sent/appended to config
`void`	`setToolbar(String toolbar)` Custom Toolbar Name It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
`void`	`setWidth(Object width)` pixels , for % specify %

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

- Field Detail
  - ATTRIB_CSS
```
public static final String ATTRIB_CSS
```
    CSS(s) to import into the Editor
    
    See Also:
    
    Constant Field Values
  - ATTRIB_FULLPAGE
```
public static final String ATTRIB_FULLPAGE
```
    by default false, if enabled/true then editor loads in Full page mode
    
    See Also:
    
    Constant Field Values
  - ATTRIB_BODY_ID
```
public static final String ATTRIB_BODY_ID
```
    Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor. Example: <body id='xxxId'> ... #xxx .img = {}. So now all img in xxxId will work due to the inserted Id
    
    See Also:
    
    Constant Field Values
  - ATTRIB_CTX_MKUP_START
```
@Deprecated
public static final String ATTRIB_CTX_MKUP_START
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Any content markup to prepend in the editor
    
    See Also:
    
    Constant Field Values
  - ATTRIB_CTX_MKUP_END
```
@Deprecated
public static final String ATTRIB_CTX_MKUP_END
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Any content markup to append in the editor
    
    See Also:
    
    Constant Field Values
  - ATTRIB_WIDTH
```
public static final String ATTRIB_WIDTH
```
    Width of the Editor. Must be Integer Type
    
    See Also:
    
    Constant Field Values
  - ATTRIB_HEIGHT
```
public static final String ATTRIB_HEIGHT
```
    Height of the Editor. Must be Integer Type
    
    See Also:
    
    Constant Field Values
  - ATTRIB_TOOLBAR
```
public static final String ATTRIB_TOOLBAR
```
    Custom Toolbar Name
    It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
    
    See Also:
    
    Constant Field Values
  - ATTRIB_EDITOR_PAGE_HEADER
```
public static final String ATTRIB_EDITOR_PAGE_HEADER
```
    We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
    
    See Also:
    
    Constant Field Values
  - ATTRIB_CUSTOM_CONFIG
```
public static final String ATTRIB_CUSTOM_CONFIG
```
    Suppose you copied the config.js file to a folder named custom in the root of your website. You also renamed the file to ckeditor_config.js. At that point it is enough to only set the customConfig configuration option when creating the editor instances to use the customized settings defined in the file. For example:
```
                CKEDITOR.replace( 'editor1', {
                    customConfig: '/custom/ckeditor_config.js'
                });
                
```
    See Also:
    
    Constant Field Values
  - ATTRIB_ENTER_MODE
```
public static final String ATTRIB_ENTER_MODE
```
    For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
    
    See Also:
    
    Constant Field Values
  - ATTRIB_AUTO_PARAGRAPH
```
public static final String ATTRIB_AUTO_PARAGRAPH
```
    autoParagraph : false
    Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode. Note: Changing the default value might introduce unpredictable usability issues.
    
    See Also:
    
    Constant Field Values
  - ATTRIB_RAW_CONFIG
```
public static final String ATTRIB_RAW_CONFIG
```
    A raw String that will be sent/appended to config
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CKEditorConfigs
```
public CKEditorConfigs()
```
- Method Detail
  - getContentsCss
```
public List<String> getContentsCss()
```
    All the CSS path that should be imported into the editor
  - setContentsCss
```
public void setContentsCss(List<String> contentsCss)
```
    All the CSS path that should be imported into the editor
  - getContextMarkupStart
```
@Deprecated
public String getContextMarkupStart()
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Sometimes the Content/part in the editor may miss some key CSS definitions. We may want to explicitly wrap the content in a start & end block of markup to simulate the styling so the content looks as similar as possible as in the real site (with the context markup)
    
    This markup is not part of the actual content, its just a decorator.
  - setContextMarkupStart
```
@Deprecated
public void setContextMarkupStart(String contextMarkupStart)
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Sometimes the Content/part in the editor may miss some key CSS definitions. We may want to explicitly wrap the content in a start & end block of markup to simulate the styling so the content looks as similar as possible as in the real site (with the context markup)
    
    This markup is not part of the actual content, its just a decorator.
  - getContextMarkupEnd
```
@Deprecated
public String getContextMarkupEnd()
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Sometimes the Content/part in the editor may miss some key CSS definitions. We may want to explicitly wrap the content in a start & end block of markup to simulate the styling so the content looks as similar as possible as in the real site (with the context markup)
    
    This markup is not part of the actual content, its just a decorator.
  - setContextMarkupEnd
```
@Deprecated
public void setContextMarkupEnd(String contextMarkupEnd)
```
    Deprecated. as it inserts it in the content can can lead to complications
    
    Sometimes the Content/part in the editor may miss some key CSS definitions. We may want to explicitly wrap the content in a start & end block of markup to simulate the styling so the content looks as similar as possible as in the real site (with the context markup)
    
    This markup is not part of the actual content, its just a decorator.
  - isFullPage
```
public boolean isFullPage()
```
  - setFullPage
```
public void setFullPage(boolean fullPage)
```
  - getBodyId
```
public String getBodyId()
```
    Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor. Example: <body id='xxxId'> ... #xxx .img = {}. So now all img in xxxId will work due to the inserted Id
  - setBodyId
```
public void setBodyId(String bodyId)
```
    Specify a Body Id, so that CSS elements that use the common id for content derive that via the inserted id within the editor. Example: <body id='xxxId'> ... #xxx .img = {}. So now all img in xxxId will work due to the inserted Id
  - getHeight
```
public Object getHeight()
```
    pixels , for % specify %
  - setHeight
```
public void setHeight(Object height)
```
    pixels , for % specify %
  - getWidth
```
public Object getWidth()
```
    pixels , for % specify %
  - setWidth
```
public void setWidth(Object width)
```
    pixels , for % specify %
  - getToolbar
```
public String getToolbar()
```
    Custom Toolbar Name
    It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
  - setToolbar
```
public void setToolbar(String toolbar)
```
    Custom Toolbar Name
    It is a toolbar name or an array of toolbars (strips), each one being also an array, containing a list of UI items.
  - getEditorPageHeader
```
public String getEditorPageHeader()
```
    We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
  - setEditorPageHeader
```
public void setEditorPageHeader(String editorPageHeader)
```
    We may want to insert some common scripts etc in the Header of the page itself where the CkEditor is being used.
  - getCustomConfig
```
public String getCustomConfig()
```
    Suppose you copied the config.js file to a folder named custom in the root of your website. You also renamed the file to ckeditor_config.js. At that point it is enough to only set the customConfig configuration option when creating the editor instances to use the customized settings defined in the file. For example:
```
                CKEDITOR.replace( 'editor1', {
                    customConfig: '/custom/ckeditor_config.js'
                });
                
```
  - setCustomConfig
```
public void setCustomConfig(String customConfig)
```
    Suppose you copied the config.js file to a folder named custom in the root of your website. You also renamed the file to ckeditor_config.js. At that point it is enough to only set the customConfig configuration option when creating the editor instances to use the customized settings defined in the file. For example:
```
                CKEDITOR.replace( 'editor1', {
                    customConfig: '/custom/ckeditor_config.js'
                });
                
```
  - getEnterMode
```
public String getEnterMode()
```
    For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
  - setEnterMode
```
public void setEnterMode(String enterMode)
```
    For example the following prevents content from being enclosed in <p> tags enterMode : CKEDITOR.ENTER_BR
  - getAutoParagraph
```
public String getAutoParagraph()
```
    autoParagraph : false
    Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode. Note: Changing the default value might introduce unpredictable usability issues.
  - setAutoParagraph
```
public void setAutoParagraph(String autoParagraph)
```
    autoParagraph : false
    Whether automatically create wrapping blocks around inline contents inside document body, this helps to ensure the integrality of the block enter mode. Note: Changing the default value might introduce unpredictable usability issues.
  - getRawConfig
```
public String getRawConfig()
```
    A raw String that will be sent/appended to config
  - setRawConfig
```
public void setRawConfig(String rawConfig)
```
    A raw String that will be sent/appended to config

Class CkEditorWrapper.CKEditorConfigs

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIB_CSS

ATTRIB_FULLPAGE

ATTRIB_BODY_ID

ATTRIB_CTX_MKUP_START

ATTRIB_CTX_MKUP_END

ATTRIB_WIDTH

ATTRIB_HEIGHT

ATTRIB_TOOLBAR

ATTRIB_EDITOR_PAGE_HEADER

ATTRIB_CUSTOM_CONFIG

ATTRIB_ENTER_MODE

ATTRIB_AUTO_PARAGRAPH

ATTRIB_RAW_CONFIG

Constructor Detail

CKEditorConfigs

Method Detail

getContentsCss

setContentsCss

getContextMarkupStart

setContextMarkupStart

getContextMarkupEnd

setContextMarkupEnd

isFullPage

setFullPage

getBodyId

setBodyId

getHeight

setHeight

getWidth

setWidth

getToolbar

setToolbar

getEditorPageHeader

setEditorPageHeader

getCustomConfig

setCustomConfig

getEnterMode

setEnterMode

getAutoParagraph

setAutoParagraph

getRawConfig

setRawConfig