org.eclipse.nebula.widgets.richtext.toolbar

Class ToolbarConfiguration

java.lang.Object

org.eclipse.nebula.widgets.richtext.toolbar.ToolbarConfiguration

public class ToolbarConfiguration
extends java.lang.Object

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

Fields

Modifier and Type	Field and Description
boolean	removeFormat Configure whether to remove format combo box from the toolbar.
boolean	removeStyles Configure whether to remove the styles combo box from the toolbar.
boolean	toolbarCollapsible Configure if the toolbar should be collapsible.
boolean	toolbarInitialExpanded Configure if the toolbar should be initially expanded.

Constructor Summary

Constructors

Constructor and Description
ToolbarConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addDefaultToolbarButton(java.lang.String buttonName) Adds the CKEditor default button for the given name to the toolbar.
protected java.lang.String	getRemoveButtonConfiguration() Configure CKEditor toolbar default buttons.
protected java.lang.String	getToolbarGroupConfiguration() Configure CKEditor toolbar button groups.
void	removeDefaultToolbarButton(java.lang.String buttonName) Removes the CKEditor default button for the given name from the toolbar.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

removeStyles

public boolean removeStyles

Configure whether to remove the styles combo box from the toolbar. Default is true.

removeFormat

public boolean removeFormat

Configure whether to remove format combo box from the toolbar. Default is true.

toolbarCollapsible

public boolean toolbarCollapsible

Configure if the toolbar should be collapsible. Default is false.

toolbarInitialExpanded

public boolean toolbarInitialExpanded

Configure if the toolbar should be initially expanded. Is only interpreted if toolbarCollapsible is set to true. Default is true.

Constructor Detail

ToolbarConfiguration

public ToolbarConfiguration()

Method Detail

getToolbarGroupConfiguration

protected java.lang.String getToolbarGroupConfiguration()

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 of CKEDITOR.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:

CKEditor Toolbar Configuration

getRemoveButtonConfiguration

protected java.lang.String getRemoveButtonConfiguration()

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 of CKEDITOR.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:

CKEditor Toolbar Configuration

addDefaultToolbarButton

public void addDefaultToolbarButton(java.lang.String buttonName)

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

public void removeDefaultToolbarButton(java.lang.String buttonName)

Removes the CKEditor default button for the given name from the toolbar.

Parameters:

buttonName - The name of the CKEditor default button to remove.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object