com.xpn.xwiki.wysiwyg.client.plugin.separator
Class ToolBarSeparator

java.lang.Object
  extended by com.xpn.xwiki.wysiwyg.client.plugin.separator.AbstractSeparator
      extended by com.xpn.xwiki.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.


Field Summary
static java.lang.String LINE_BREAK
           
static java.lang.String VERTICAL_BAR
           
 
Constructor Summary
ToolBarSeparator()
           
 
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 com.xpn.xwiki.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
See Also:
Constant Field Values

LINE_BREAK

public static final java.lang.String LINE_BREAK
See Also:
Constant Field Values
Constructor Detail

ToolBarSeparator

public ToolBarSeparator()
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()

newLineBreak

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


Copyright © 2004-2008 XWiki. All Rights Reserved.