org.xwiki.gwt.wysiwyg.client.plugin
Interface Plugin

All Known Implementing Classes:

org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin, org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractStatefulPlugin, ColorPlugin, EmbedPlugin, FontPlugin, FormatPlugin, HistoryPlugin, IELinePlugin, IESubmitPlugin, ImagePlugin, ImportPlugin, IndentPlugin, JustifyPlugin, LinePlugin, LinkPlugin, ListPlugin, MacroPlugin, MozillaColorPlugin, MozillaLinePlugin, SeparatorPlugin, StylePlugin, SubmitPlugin, SymbolPlugin, SyncPlugin, TablePlugin, TextPlugin, VerticalAlignPlugin

public interface Plugin

A plug-in for the WYSIWYG editor.

Version:

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

Method Summary

void	destroy() Notifies the plug-in to release its resources before being unloaded from the WYSIWYG editor.
UIExtension[]	getUIExtensions()
void	init(RichTextArea textArea, Config config) Initialize the plug-in.

Method Detail

init

void init(RichTextArea textArea,
          Config config)

Initialize the plug-in. Plug-ins need to know the text area in order to provide only those feature that are supported.

Parameters:

textArea - the text area of the editor

config - the configuration object

getUIExtensions

UIExtension[] getUIExtensions()

Returns:

all the user interface extensions that are provided by this plug-in

destroy

void destroy()

Notifies the plug-in to release its resources before being unloaded from the WYSIWYG editor.