com.xpn.xwiki.wysiwyg.client.plugin.internal
Class AbstractUIExtension

java.lang.Object
  com.xpn.xwiki.wysiwyg.client.plugin.internal.AbstractUIExtension

All Implemented Interfaces:

UIExtension

Direct Known Subclasses:

FocusWidgetUIExtension

public abstract class AbstractUIExtension
extends java.lang.Object
implements UIExtension

Abstract implementation of the UIExtension interface. This could serve as a base class for all kind of user interface extensions. It offers the possibility of adding and removing user interface features.

Constructor Summary

AbstractUIExtension(java.lang.String role)

Method Summary

com.google.gwt.user.client.ui.UIObject	addFeature(java.lang.String feature, com.google.gwt.user.client.ui.UIObject uiObject)
void	clearFeatures()
java.lang.String[]	getFeatures() Examples of features are: bold, justifyright and macro.
java.lang.String	getRole()
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.UIObject	removeFeature(java.lang.String feature)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xpn.xwiki.wysiwyg.client.plugin.UIExtension

isEnabled, setEnabled

Constructor Detail

AbstractUIExtension

public AbstractUIExtension(java.lang.String role)

Method Detail

getFeatures

public java.lang.String[] getFeatures()

Examples of features are: bold, justifyright and macro.

Specified by:

getFeatures in interface UIExtension

Returns:

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

See Also:

UIExtension.getFeatures()

getRole

public java.lang.String getRole()

Specified by:

getRole in interface UIExtension

Returns:

The extension point. It could be menu, toolbar, statusbar, contextmenu and so on.

See Also:

UIExtension.getRole()

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.

Specified by:

getUIObject in interface UIExtension

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)

addFeature

public com.google.gwt.user.client.ui.UIObject addFeature(java.lang.String feature,
                                                         com.google.gwt.user.client.ui.UIObject uiObject)

removeFeature

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

clearFeatures

public void clearFeatures()