|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jdom.Content
org.jdom.Text
com.ecyrd.jspwiki.parser.PluginContent
public class PluginContent
Stores the contents of a plugin in a WikiDocument DOM tree.
If the RenderingManager.WYSIWYG_EDITOR_MODE is set to Boolean.TRUE in the context, then the plugin is rendered as WikiMarkup. This allows an HTML editor to work without rendering the plugin each time as well.
If RenderingManager.VAR_EXECUTE_PLUGINS is set to Boolean.FALSE, then the plugin is not executed.
Field Summary |
---|
Fields inherited from class org.jdom.Text |
---|
value |
Fields inherited from class org.jdom.Content |
---|
parent |
Constructor Summary | |
---|---|
PluginContent(String pluginName,
Map parameters)
Creates a new DOM element with the given plugin name and a map of parameters. |
Method Summary | |
---|---|
void |
executeParse(WikiContext context)
Executes the executeParse() method. |
Object |
getParameter(String name)
Returns a parameter value from the parameter map. |
Map |
getParameters()
Returns the parameter map given in the constructor. |
String |
getPluginName()
Returns the name of the plugin invoked by the DOM element. |
String |
getText()
The main invocation for the plugin. |
String |
getValue()
Returns the rendered plugin. |
Methods inherited from class org.jdom.Text |
---|
append, append, clone, getTextNormalize, getTextTrim, normalizeString, setText, toString |
Methods inherited from class org.jdom.Content |
---|
detach, equals, getDocument, getParent, getParentElement, hashCode, setParent |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PluginContent(String pluginName, Map parameters)
pluginName
- The FQN of a plugin.parameters
- A Map of parameters.Method Detail |
---|
public String getPluginName()
public Object getParameter(String name)
name
- the name of the parameter.
public Map getParameters()
public String getValue()
getValue
in class Text
public String getText()
getText
in class Text
public void executeParse(WikiContext context) throws PluginException
context
- The WikiContext
PluginException
- If something goes wrong.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |