com.xpn.xwiki.wysiwyg.client.plugin
Interface Plugin

All Known Implementing Classes:

AbstractPlugin, AttachmentPlugin, ColorPlugin, FontPlugin, FormatPlugin, ImagePlugin, IndentPlugin, JustifyPlugin, LinkPlugin, ListPlugin, MacroPlugin, MiscPlugin, SeparatorPlugin, StatefulPlugin, SymbolPlugin, SyncPlugin, TablePlugin, TextPlugin, UndoPlugin, VerticalAlignPlugin

public interface Plugin

A plug-in for the WYSIWYG editor.

Method Summary

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

Method Detail

init

void init(Wysiwyg wysiwyg,
          XRichTextArea 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:

wysiwyg - The WYSIWYG application context.

textArea - The text area of the editor.

config - The configuration.

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.