|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wiki.plugin.ReferredPagesPlugin
public class ReferredPagesPlugin
Displays the pages referring to the current page.
Parameters
Field Summary | |
---|---|
static int |
MAX_DEPTH
The maximum depth. |
static int |
MIN_DEPTH
The minimum depth. |
static String |
PARAM_DEPTH
The parameter name for the depth. |
static String |
PARAM_EXCLUDE
The parameter name for the excluded pages. |
static String |
PARAM_FORMAT
The parameter name for the format. |
static String |
PARAM_INCLUDE
The parameter name for the included pages. |
static String |
PARAM_ROOT
The parameter name for the root page to start from. |
static String |
PARAM_TYPE
The parameter name for the type of the references. |
Fields inherited from interface org.apache.wiki.api.plugin.WikiPlugin |
---|
CORE_PLUGINS_RESOURCEBUNDLE |
Constructor Summary | |
---|---|
ReferredPagesPlugin()
|
Method Summary | |
---|---|
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 |
---|
public static final String PARAM_ROOT
public static final String PARAM_DEPTH
public static final String PARAM_TYPE
public static final String PARAM_INCLUDE
public static final String PARAM_EXCLUDE
public static final String PARAM_FORMAT
public static final int MIN_DEPTH
public static final int MAX_DEPTH
Constructor Detail |
---|
public ReferredPagesPlugin()
Method Detail |
---|
public String execute(WikiContext context, Map<String,String> params) throws PluginException
Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.
execute
in interface WikiPlugin
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.
PluginException
- In case anything goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |