org.xwiki.gwt.wysiwyg.client.plugin.format
Class FormatPlugin

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin
      org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractStatefulPlugin
          org.xwiki.gwt.wysiwyg.client.plugin.format.FormatPlugin

All Implemented Interfaces:

com.google.gwt.event.dom.client.ChangeHandler, com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.shared.EventHandler, CommandListener, Updatable, Plugin

public class FormatPlugin
extends org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractStatefulPlugin
implements com.google.gwt.event.dom.client.ChangeHandler, com.google.gwt.event.dom.client.ClickHandler

RichTextArea plug-in for formatting text. It can be used to format text as heading 1 to 5. It installs a select on the tool bar and updates its status depending on the current cursor position.

Version:

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

Constructor Summary

FormatPlugin()

Method Summary

void	destroy() Notifies the plug-in to release its resources before being unloaded from the WYSIWYG editor.
void	init(RichTextArea textArea, Config config) Initialize the plug-in.
void	onChange(com.google.gwt.event.dom.client.ChangeEvent event)
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)
void	update()

Methods inherited from class org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractStatefulPlugin

canUpdate, onBeforeCommand, onCommand, onKeyUp, onMouseUp, registerTextAreaHandlers

Methods inherited from class org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin

getConfig, getTextArea, getUIExtensionList, getUIExtensions, saveRegistration, saveRegistrations

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatPlugin

public FormatPlugin()

Method Detail

init

public 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.

Specified by:

init in interface Plugin

Overrides:

init in class org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin

Parameters:

textArea - the text area of the editor

config - the configuration object

See Also:

AbstractStatefullPlugin#init(RichTextArea, Config)

destroy

public void destroy()

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

Specified by:

destroy in interface Plugin

Overrides:

destroy in class org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractStatefulPlugin

See Also:

AbstractStatefullPlugin#destroy()

onClick

public void onClick(com.google.gwt.event.dom.client.ClickEvent event)

Specified by:

onClick in interface com.google.gwt.event.dom.client.ClickHandler

See Also:

ClickHandler.onClick(ClickEvent)

onChange

public void onChange(com.google.gwt.event.dom.client.ChangeEvent event)

Specified by:

onChange in interface com.google.gwt.event.dom.client.ChangeHandler

See Also:

ChangeHandler.onChange(ChangeEvent)

update

public void update()

Specified by:

update in interface Updatable

See Also:

Updatable.update()