Class ToolbarConfiguration
java.lang.Object
org.eclipse.nebula.widgets.richtext.toolbar.ToolbarConfiguration
Deprecated.
The toolbar configuration of the CKEditor toolbar. Contains the default toolbar configuration via
toolbar groups and gives the ability to dynamically add/remove custom buttons.
To customize the CKEditor buttons shown in the toolbar, you need to override
getToolbarGroupConfiguration()
and getRemoveButtonConfiguration()
- Since:
- 3.1
-
Field Summary
Modifier and TypeFieldDescriptionboolean
Deprecated.Configure whether to remove format combo box from the toolbar.boolean
Deprecated.Configure whether to remove the paste from word button from the toolbar.boolean
Deprecated.Configure whether to remove the paste text button from the toolbar.boolean
Deprecated.Configure whether to remove the styles combo box from the toolbar.boolean
Deprecated.Configure if the toolbar should be collapsible.boolean
Deprecated.Configure if the toolbar should be initially expanded. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDefaultToolbarButton
(String buttonName) Deprecated.Adds the CKEditor default button for the given name to the toolbar.protected String
Deprecated.Configure CKEditor toolbar default buttons.Deprecated.String[]
Deprecated.protected String
Deprecated.Configure CKEditor toolbar button groups.void
removeDefaultToolbarButton
(String buttonName) Deprecated.Removes the CKEditor default button for the given name from the toolbar.toString()
Deprecated.
-
Field Details
-
removePasteText
public boolean removePasteTextDeprecated.Configure whether to remove the paste text button from the toolbar. Default istrue
. -
removePasteFromWord
public boolean removePasteFromWordDeprecated.Configure whether to remove the paste from word button from the toolbar. Default istrue
. -
removeStyles
public boolean removeStylesDeprecated.Configure whether to remove the styles combo box from the toolbar. Default istrue
. -
removeFormat
public boolean removeFormatDeprecated.Configure whether to remove format combo box from the toolbar. Default istrue
. -
toolbarCollapsible
public boolean toolbarCollapsibleDeprecated.Configure if the toolbar should be collapsible. Default isfalse
. -
toolbarInitialExpanded
public boolean toolbarInitialExpandedDeprecated.Configure if the toolbar should be initially expanded. Is only interpreted iftoolbarCollapsible
is set totrue
. Default istrue
.
-
-
Constructor Details
-
ToolbarConfiguration
public ToolbarConfiguration()Deprecated.
-
-
Method Details
-
getToolbarGroupConfiguration
Deprecated.Configure CKEditor toolbar button groups. To customize the CKEditor buttons shown in the toolbar, you need to override this method. The returned string is a direct representation ofCKEDITOR.config.toolbarGroups
configuration property. It must start with "CKEDITOR.config.toolbarGroups" and end with a semicolon. The value is a JavaScript array as defined in CKEditor Documentation.Usage:
public class MyConfig extends ToolbarConfiguration { @Override protected String getToolbarGroupConfiguration() { return "CKEDITOR.config.toolbarGroups = [{\"name\":\"styles\"}];"; } }
- Returns:
- The toolbar group configuration for the CKEditor toolbar.
- See Also:
-
getRemoveButtonConfiguration
Deprecated.Configure CKEditor toolbar default buttons. To customize the CKEditor default buttons shown in the toolbar, you could override this method. The returned string is a direct representation ofCKEDITOR.config.removeButtons
configuration property. It must start with "CKEDITOR.config.removeButtons" and end with a semicolon. The value is a comma-separated list of default button names as defined in CKEditor Documentation.Usage:
public class MyConfig extends ToolbarConfiguration { @Override protected String getRemoveButtonConfiguration() { return "CKEDITOR.config.removeButtons = \"Subscript,Superscript\";"; } }
- Returns:
- The configuration which default buttons should be removed from the toolbar.
- See Also:
-
addDefaultToolbarButton
Deprecated.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:
buttonName
- The name of the CKEditor default button to add.
-
removeDefaultToolbarButton
Deprecated.Removes the CKEditor default button for the given name from the toolbar.- Parameters:
buttonName
- The name of the CKEditor default button to remove.
-
toString
Deprecated. -
getToolbarButtonConfigurations
Deprecated.- Since:
- 3.2
-
getRemovedButtons
Deprecated.- Since:
- 3.2
-
RichTextEditorConfiguration