Package com.xpn.xwiki.plugin.image

Class ImagePlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.image.ImagePlugin

All Implemented Interfaces:

XWikiPluginInterface

@Deprecated
public class ImagePlugin
extends XWikiDefaultPlugin

Deprecated.

the plugin technology is deprecated, consider rewriting as components

Version:

$Id: bc09665a1fada2994f10715482a863ec39cabe36 $

Constructor Summary

Constructors

Constructor	Description
ImagePlugin(String name, String className, XWikiContext context)	Deprecated. Creates a new instance of this plugin.

Method Summary

Modifier and Type	Method	Description
XWikiAttachment	downloadAttachment(XWikiAttachment attachment, XWikiContext context)	Deprecated.
void	flushCache()	Deprecated.
int	getHeight(XWikiAttachment attachment, XWikiContext context)	Deprecated.
String	getName()	Deprecated.
Api	getPluginApi(XWikiPluginInterface plugin, XWikiContext context)	Deprecated.
int	getWidth(XWikiAttachment attachment, XWikiContext context)	Deprecated.
void	init(XWikiContext context)	Deprecated.

Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin

beginParsing, beginRendering, commonTagsHandler, endParsing, endRendering, endRenderingHandler, flushCache, getClassName, getLocalization, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit

Methods inherited from class java.lang.Object

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

Constructor Detail

ImagePlugin

public ImagePlugin(String name,
                   String className,
                   XWikiContext context)

Deprecated.

Creates a new instance of this plugin.

Parameters:

name - the name of the plugin

className - the class name

context - the XWiki context

See Also:

XWikiDefaultPlugin(String, String, com.xpn.xwiki.XWikiContext)

Method Detail

getPluginApi

public Api getPluginApi(XWikiPluginInterface plugin,
                        XWikiContext context)

Deprecated.

Specified by:

getPluginApi in interface XWikiPluginInterface

Overrides:

getPluginApi in class XWikiDefaultPlugin

getName

public String getName()

Deprecated.

Specified by:

getName in interface XWikiPluginInterface

Overrides:

getName in class XWikiDefaultPlugin

init

public void init(XWikiContext context)

Deprecated.

Specified by:

init in interface XWikiPluginInterface

Overrides:

init in class XWikiDefaultPlugin

flushCache

public void flushCache()

Deprecated.

Overrides:

flushCache in class XWikiDefaultPlugin

downloadAttachment

public XWikiAttachment downloadAttachment(XWikiAttachment attachment,
                                          XWikiContext context)

Deprecated.

Allows to scale images server-side, in order to have real thumbnails for reduced traffic. The new image dimensions are passed in the request as the width and height parameters. If only one of the dimensions is specified, then the other one is computed to preserve the original aspect ratio of the image.

Specified by:

downloadAttachment in interface XWikiPluginInterface

Overrides:

downloadAttachment in class XWikiDefaultPlugin

See Also:

XWikiDefaultPlugin.downloadAttachment(XWikiAttachment, XWikiContext)

getWidth

public int getWidth(XWikiAttachment attachment,
                    XWikiContext context)
             throws IOException,
                    XWikiException

Deprecated.

Parameters:

attachment - an image attachment

context - the XWiki context

Returns:

the width of the specified image

Throws:

IOException - if reading the image from the attachment content fails

XWikiException - if reading the attachment content fails

getHeight

public int getHeight(XWikiAttachment attachment,
                     XWikiContext context)
              throws IOException,
                     XWikiException

Deprecated.

Parameters:

attachment - an image attachment

context - the XWiki context

Returns:

the height of the specified image

Throws:

IOException - if reading the image from the attachment content fails

XWikiException - if reading the attachment content fails