org.apache.wiki.plugin

Class Image

java.lang.Object

org.apache.wiki.plugin.Image

All Implemented Interfaces:

WikiPlugin

public class Image
extends Object
implements WikiPlugin

Provides an image plugin for better control than is possible with a simple image inclusion.
Most parameters are equivalents of the html image attributes.

Parameters :

• src - the source (a URL) of the image (required parameter)
• align - the alignment of the image
• height - the height of the image
• width - the width of the image
• alt - alternate text
• caption - the caption for the image
• link - the hyperlink for the image
• target - the target (frame) to be used for opening the image
• style - the style attribute of the image
• class - the associated class for the image
• border - the border for the image
• title - the title for the image, can be presented as a tooltip to the user

Since:

2.1.4.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_ALIGN The parameter name for setting the align.
static String	PARAM_ALT The parameter name for setting the alt.
static String	PARAM_BORDER The parameter name for setting the border.
static String	PARAM_CAPTION The parameter name for setting the caption.
static String	PARAM_CLASS The parameter name for setting the class.
static String	PARAM_HEIGHT The parameter name for setting the height.
static String	PARAM_LINK The parameter name for setting the link.
static String	PARAM_SRC The parameter name for setting the src.
static String	PARAM_STYLE The parameter name for setting the style.
static String	PARAM_TARGET The parameter name for setting the target.
static String	PARAM_TITLE The parameter name for setting the title.
static String	PARAM_WIDTH The parameter name for setting the width.

Fields inherited from interface org.apache.wiki.api.plugin.WikiPlugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
String	execute(WikiContext context, Map<String,String> params) This is the main entry point for any plugin.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_SRC

public static final String PARAM_SRC

The parameter name for setting the src. Value is "src".

See Also:

Constant Field Values

PARAM_ALIGN

public static final String PARAM_ALIGN

The parameter name for setting the align. Value is "align".

See Also:

Constant Field Values

PARAM_HEIGHT

public static final String PARAM_HEIGHT

The parameter name for setting the height. Value is "height".

See Also:

Constant Field Values

PARAM_WIDTH

public static final String PARAM_WIDTH

The parameter name for setting the width. Value is "width".

See Also:

Constant Field Values

PARAM_ALT

public static final String PARAM_ALT

The parameter name for setting the alt. Value is "alt".

See Also:

Constant Field Values

PARAM_CAPTION

public static final String PARAM_CAPTION

The parameter name for setting the caption. Value is "caption".

See Also:

Constant Field Values

PARAM_LINK

public static final String PARAM_LINK

The parameter name for setting the link. Value is "link".

See Also:

Constant Field Values

PARAM_TARGET

public static final String PARAM_TARGET

The parameter name for setting the target. Value is "target".

See Also:

Constant Field Values

PARAM_STYLE

public static final String PARAM_STYLE

The parameter name for setting the style. Value is "style".

See Also:

Constant Field Values

PARAM_CLASS

public static final String PARAM_CLASS

The parameter name for setting the class. Value is "class".

See Also:

Constant Field Values

PARAM_BORDER

public static final String PARAM_BORDER

The parameter name for setting the border. Value is "border".

See Also:

Constant Field Values

PARAM_TITLE

public static final String PARAM_TITLE

The parameter name for setting the title. Value is "title".

See Also:

Constant Field Values

Constructor Detail

Image

public Image()

Method Detail

execute

public String execute(WikiContext context,
                      Map<String,String> params)
               throws PluginException

This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.

Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.

Specified by:

execute in interface WikiPlugin

Parameters:

context - The current WikiContext.

params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.

Returns:

HTML, ready to be included into the rendered page.

Throws:

PluginException - In case anything goes wrong.