Class RichTextEditorConfiguration
- java.lang.Object
-
- org.eclipse.nebula.widgets.richtext.RichTextEditorConfiguration
-
public class RichTextEditorConfiguration extends java.lang.ObjectConfiguration class that is used for general configurations of the CKEditor instance.- Since:
- 3.2
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDEFAULT_LANGUAGEKey for the default language configuration.static java.lang.StringLANGUAGEKey for the language configuration.static java.lang.StringREMOVE_BUTTONSKey for toolbar buttons that should not be rendered.static java.lang.StringTOOLBAR_CAN_COLLAPSEKey to configure whether the toolbar can be collapsed by the user.static java.lang.StringTOOLBAR_GROUPSKey for toolbar groups configuration.static java.lang.StringTOOLBAR_STARTUP_EXPANDEDKey to configure whether the toolbar must start expanded when the editor is loaded.
-
Constructor Summary
Constructors Constructor Description RichTextEditorConfiguration()Creates a new instance for general configurations that are added to the created CKEditor instance at initialization.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDefaultToolbarButton(java.lang.String... buttonNames)Adds the CKEditor default button for the given name to the toolbar.java.util.Map<java.lang.String,java.lang.Object>getAllOptions()java.lang.ObjectgetOption(java.lang.String key)Returns a configuration option set in thisRichTextEditorConfiguration.voidremoveDefaultToolbarButton(java.lang.String... buttonNames)Removes the CKEditor default button for the given name from the toolbar.voidsetDefaultLanguage(java.lang.String lang)voidsetDefaultLanguage(java.util.Locale locale)voidsetLanguage(java.lang.String lang)voidsetLanguage(java.util.Locale locale)voidsetOption(java.lang.String key, java.lang.Object value)Adds a new option to the configuration.voidsetRemoveFormat(boolean removeFormat)voidsetRemovePasteFromWord(boolean removePasteFromWord)voidsetRemovePasteText(boolean removePasteText)voidsetRemoveStyles(boolean removeStyles)voidsetToolbarCollapsible(boolean toolbarCollapsible)Configure if the toolbar should be collapsible.voidsetToolbarInitialExpanded(boolean toolbarInitialExpanded)Configure if the toolbar should be initially expanded.
-
-
-
Field Detail
-
DEFAULT_LANGUAGE
public static final java.lang.String DEFAULT_LANGUAGE
Key for the default language configuration.- See Also:
- Constant Field Values
-
LANGUAGE
public static final java.lang.String LANGUAGE
Key for the language configuration.- See Also:
- Constant Field Values
-
TOOLBAR_GROUPS
public static final java.lang.String TOOLBAR_GROUPS
Key for toolbar groups configuration.- See Also:
- Constant Field Values
-
REMOVE_BUTTONS
public static final java.lang.String REMOVE_BUTTONS
Key for toolbar buttons that should not be rendered.- See Also:
- Constant Field Values
-
TOOLBAR_CAN_COLLAPSE
public static final java.lang.String TOOLBAR_CAN_COLLAPSE
Key to configure whether the toolbar can be collapsed by the user.- See Also:
- Constant Field Values
-
TOOLBAR_STARTUP_EXPANDED
public static final java.lang.String TOOLBAR_STARTUP_EXPANDED
Key to configure whether the toolbar must start expanded when the editor is loaded.- See Also:
- Constant Field Values
-
-
Method Detail
-
setOption
public void setOption(java.lang.String key, java.lang.Object value)Adds a new option to the configuration.- Parameters:
key- The configuration option key.value- The configuration option value.- See Also:
- CKEDITOR.config
-
getOption
public java.lang.Object getOption(java.lang.String key)
Returns a configuration option set in thisRichTextEditorConfiguration.- Parameters:
key- The configuration option key for which the value is requested.- Returns:
- The configuration option value for the given key or
nullin case there is nothing configured for that key.
-
getAllOptions
public java.util.Map<java.lang.String,java.lang.Object> getAllOptions()
- Returns:
- An unmodifiable map that contains all configuration option values.
-
setLanguage
public void setLanguage(java.lang.String lang)
- Parameters:
lang- The user interface language localization to use. If left empty, the editor will automatically be localized to the user language. If the user language is not supported, the language specified in the defaultLanguage configuration setting is used.
-
setLanguage
public void setLanguage(java.util.Locale locale)
- Parameters:
locale- The user interface language localization to use. If left empty, the editor will automatically be localized to the user language. If the user language is not supported, the language specified in the defaultLanguage configuration setting is used.
-
setDefaultLanguage
public void setDefaultLanguage(java.lang.String lang)
- Parameters:
lang- The language to be used if the language setting is left empty and it is not possible to localize the editor to the user language.
-
setDefaultLanguage
public void setDefaultLanguage(java.util.Locale locale)
- Parameters:
locale- The language to be used if the language setting is left empty and it is not possible to localize the editor to the user language.
-
setRemovePasteText
public void setRemovePasteText(boolean removePasteText)
- Parameters:
removePasteText-trueto remove the paste text button from the toolbar.
-
setRemovePasteFromWord
public void setRemovePasteFromWord(boolean removePasteFromWord)
- Parameters:
removePasteFromWord-trueto remove the paste from word button from the toolbar.
-
setRemoveStyles
public void setRemoveStyles(boolean removeStyles)
- Parameters:
removeStyles-trueto remove the styles combo box from the toolbar.
-
setRemoveFormat
public void setRemoveFormat(boolean removeFormat)
- Parameters:
removeFormat-trueto remove format combo box from the toolbar.
-
addDefaultToolbarButton
public void addDefaultToolbarButton(java.lang.String... buttonNames)
Adds the CKEditor default button for the given name to the toolbar.Note: This works only for buttons that have been removed using
removeDefaultToolbarButton(String[])- Parameters:
buttonNames- The names of the CKEditor default button to add.
-
removeDefaultToolbarButton
public void removeDefaultToolbarButton(java.lang.String... buttonNames)
Removes the CKEditor default button for the given name from the toolbar.- Parameters:
buttonNames- The names of the CKEditor default button to remove.
-
setToolbarCollapsible
public void setToolbarCollapsible(boolean toolbarCollapsible)
Configure if the toolbar should be collapsible. Default isfalse.- Parameters:
toolbarCollapsible-trueif the toolbar should be collapsible,falseif not.
-
setToolbarInitialExpanded
public void setToolbarInitialExpanded(boolean toolbarInitialExpanded)
Configure if the toolbar should be initially expanded. Default istrue.- Parameters:
toolbarInitialExpanded-trueif the toolbar should be initially expanded,falseif not.
-
-