de.tuberlin.cs.flp.jspwiki.plugin


Class Picture

All known implemented Interfaces:
WikiPlugin


public class Picture
Namespace: plugin


[{Picture [src=page-or-attachment] [size=thumbnail|small|_medium_|large] [style=css-name] [textflow] }]

Insert an image in the page using pre-set named size alternatives. The image can be taken from an image-archive's page. If a page is given as src, the first image inlined in the page will be used as picture, or the first image attachment to that page in case the page has no image inlined. If src is missing, the first image-attachment of the current page will be used. The names available for the size attribute ("thumbnail", "small", etc.) are configured in the jspwiki.properties using parameter jspwiki.picture.size.XXX=n.

Authors:
Jens Gulden


Attribute Summary
protected static String  PROPERTIES_PREFIX
 

Method Summary
public String   execute(WikiContext context, Map params)
Executes the plugin.  
public static String   imageHTML(WikiContext context, String src, String sizename, String style, String align, boolean clickToEnlarge, boolean description)
 

Tagged Values
static false
documentation#author Jens Gulden

Attribute Detail

PROPERTIES_PREFIX

protected static final String PROPERTIES_PREFIX

Multiplicity: 1..1
Ordering: unspecified

Method Detail

execute

public String execute(WikiContext context, Map params)


Executes the plugin.
Method Tagged Values
documentation#throws PluginException if an error occurs

Parameters:
context - The WikiContext.
params - Parameters specified at plugin inclusion.
Returns:
HTML to be inserted into page
Exceptions:
PluginException if an error occurs


imageHTML

public static String imageHTML(WikiContext context, String src, String sizename, String style, String align, boolean clickToEnlarge, boolean description)

Parameters:
context -
src -
sizename -
style -
align -
clickToEnlarge -
description -
Returns:

previous   TOC   next

Generated with Poseidon for UMLTM.
Poseidon is a registered trademark of Gentleware AG in the USA and other countries. Copyright 2003-2006 Gentleware AG, Ludwigstr. 12, 20357 Hamburg, Germany. All Rights Reserved.
UML is a trademark or registered trademark of Object Management Group, Inc. in the U.S. and other countries.