org.xwiki.gwt.wysiwyg.client.plugin.separator
Class ToolBarSeparator

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.plugin.separator.AbstractSeparator
      org.xwiki.gwt.wysiwyg.client.plugin.separator.ToolBarSeparator

All Implemented Interfaces:

UIExtension

public class ToolBarSeparator
extends AbstractSeparator

User interface extension that provides ways of separating tool bar entries. We currently support a vertical bar separator and a new line separator.

Version:

$Id: ToolBarSeparator.java 26786 2010-02-07 16:46:17Z mflorea $

Field Summary

static java.lang.String	LINE_BREAK The string used in configurations to split the tool bar in multiple lines.
static java.lang.String	VERTICAL_BAR The string used in configurations to place a vertical bar on the tool bar.

Constructor Summary

ToolBarSeparator()
Creates a new tool bar separator.

Method Summary

java.lang.String[]	getFeatures() Examples of features are: bold, justifyright and macro.
com.google.gwt.user.client.ui.UIObject	getUIObject(java.lang.String feature) It can be a button, a menu item, a label or any other UIObject-derived instance.
com.google.gwt.user.client.ui.Widget	newLineBreak()
com.google.gwt.user.client.ui.Widget	newVerticalBar()

Methods inherited from class org.xwiki.gwt.wysiwyg.client.plugin.separator.AbstractSeparator

getRole, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

VERTICAL_BAR

public static final java.lang.String VERTICAL_BAR

The string used in configurations to place a vertical bar on the tool bar.

See Also:

Constant Field Values

LINE_BREAK

public static final java.lang.String LINE_BREAK

The string used in configurations to split the tool bar in multiple lines.

See Also:

Constant Field Values

Constructor Detail

ToolBarSeparator

public ToolBarSeparator()

Creates a new tool bar separator.

Method Detail

getFeatures

public java.lang.String[] getFeatures()

Examples of features are: bold, justifyright and macro.

Returns:

An array of supported features, depending on the underlying text area's capabilities.

See Also:

UIExtension.getFeatures()

getUIObject

public com.google.gwt.user.client.ui.UIObject getUIObject(java.lang.String feature)

It can be a button, a menu item, a label or any other UIObject-derived instance.

Parameters:

feature - One of the features provided by the editor's plug-ins and supported by the underlying text area.

Returns:

The user interface object that makes the specified feature accessible in the underlying extension point.

See Also:

UIExtension.getUIObject(String)

newVerticalBar

public com.google.gwt.user.client.ui.Widget newVerticalBar()

Returns:

a new vertical bar to separate the widgets placed on the tool bar.

newLineBreak

public com.google.gwt.user.client.ui.Widget newLineBreak()

Returns:

a new line break to split the tool bar in multiple lines.