org.xwiki.gwt.wysiwyg.client.plugin.image
Class ImagePlugin

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin
      org.xwiki.gwt.wysiwyg.client.plugin.image.ImagePlugin

All Implemented Interfaces:

com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.shared.EventHandler, WizardListener, Plugin

public class ImagePlugin
extends org.xwiki.gwt.wysiwyg.client.plugin.internal.AbstractPlugin
implements com.google.gwt.event.dom.client.ClickHandler, WizardListener

Rich text editor plug-in for inserting images, using a dialog to get image data settings from the user. It installs one button in the toolbar, to be used for both insert and edit image actions.

Version:

$Id: ImagePlugin.java 31743 2010-10-13 01:20:32Z mflorea $

Constructor Summary

ImagePlugin(WikiServiceAsync wikiService)
Create a new image plugin that used the specified wiki service.

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	onCancel(Wizard sender)
void	onClick(com.google.gwt.event.dom.client.ClickEvent event)
void	onFinish(Wizard sender, java.lang.Object result)
void	onImage() Function to handle the image event, when the tool bar button is clicked or the menu command is issued: either create a new image, or edit an existing image.
void	onImageRemove() Removes the selection if the insert image command is executed.

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

ImagePlugin

public ImagePlugin(WikiServiceAsync wikiService)

Create a new image plugin that used the specified wiki service.

Parameters:

wikiService - the service used to access the wiki

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:

AbstractPlugin#init(XRichTextArea, 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.AbstractPlugin

See Also:

AbstractPlugin.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)

onImage

public void onImage()

Function to handle the image event, when the tool bar button is clicked or the menu command is issued: either create a new image, or edit an existing image.

onImageRemove

public void onImageRemove()

Removes the selection if the insert image command is executed.

onFinish

public void onFinish(Wizard sender,
                     java.lang.Object result)

Specified by:

onFinish in interface WizardListener

onCancel

public void onCancel(Wizard sender)

Specified by:

onCancel in interface WizardListener