Package org.apache.wiki.plugin

Class Image

  • All Implemented Interfaces:
    Plugin
    public class Image
extends java.lang.Object
implements Plugin
    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 Description
      static java.lang.String PARAM_ALIGN
      The parameter name for setting the align.
      static java.lang.String PARAM_ALT
      The parameter name for setting the alt.
      static java.lang.String PARAM_BORDER
      The parameter name for setting the border.
      static java.lang.String PARAM_CAPTION
      The parameter name for setting the caption.
      static java.lang.String PARAM_CLASS
      The parameter name for setting the class.
      static java.lang.String PARAM_HEIGHT
      The parameter name for setting the height.
      static java.lang.String PARAM_LINK
      The parameter name for setting the link.
      static java.lang.String PARAM_SRC
      The parameter name for setting the src.
      static java.lang.String PARAM_STYLE
      The parameter name for setting the style.
      static java.lang.String PARAM_TARGET
      The parameter name for setting the target.
      static java.lang.String PARAM_TITLE
      The parameter name for setting the title.
      static java.lang.String PARAM_WIDTH
      The parameter name for setting the width.

    • Constructor Summary

      Constructors 
      Constructor Description
      Image()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.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

    • Constructor Detail

    • Method Detail

      • execute

        public java.lang.String execute​(Context context,
                                java.util.Map<java.lang.String,​java.lang.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 Plugin
        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.