Package org.apache.wiki.plugin
Class InsertPage
java.lang.Object
org.apache.wiki.plugin.InsertPage
- All Implemented Interfaces:
Plugin
Inserts page contents. Muchos thanks to Scott Hurlbert for the initial code.
Parameters :
- page - the name of the page to be inserted
- style - the style to use
- maxlength - the maximum length of the page to be inserted (page contents)
- class - the class to use
- section - the section of the page that has to be inserted (separated by "----"
- default - the text to insert if the requested page does not exist
- Since:
- 2.1.37
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThis attribute is stashed in the WikiContext to make sure that we don't have circular references.static final StringParameter name for setting the class.static final StringParameter name for setting the default.static final StringParameter name for setting the maxlength.static final StringParameter name for setting the page.static final StringParameter name for setting the section.static final StringParameter name for setting the show option.static final StringParameter name for setting the style.Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis is the main entry point for any plugin.getDisplayName(Locale locale) Provides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom pluginProvides the ability for a plugin to provide a suggestion or template for execution within a wiki page.
-
Field Details
-
PARAM_PAGENAME
Parameter name for setting the page. Value is "page".- See Also:
-
PARAM_STYLE
Parameter name for setting the style. Value is "style".- See Also:
-
PARAM_MAXLENGTH
Parameter name for setting the maxlength. Value is "maxlength".- See Also:
-
PARAM_CLASS
Parameter name for setting the class. Value is "class".- See Also:
-
PARAM_SHOW
Parameter name for setting the show option. Value is "show".- See Also:
-
PARAM_SECTION
Parameter name for setting the section. Value is "section".- See Also:
-
PARAM_DEFAULT
Parameter name for setting the default. Value is "default".- See Also:
-
ATTR_RECURSE
This attribute is stashed in the WikiContext to make sure that we don't have circular references.- See Also:
-
-
Constructor Details
-
InsertPage
public InsertPage()
-
-
Method Details
-
getDisplayName
Description copied from interface:PluginProvides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom plugin- Specified by:
getDisplayNamein interfacePlugin- Returns:
- String
-
getSnipExample
Description copied from interface:PluginProvides the ability for a plugin to provide a suggestion or template for execution within a wiki page. Default returns just the FQCN of the plugin, which should enable it to fire off, however no parameters are provided in this case. Override it to provide example inputs to aid users with configuring your plugin. Example: com.company.Plugin inputParamter='test'- Specified by:
getSnipExamplein interfacePlugin- Returns:
- String
-
execute
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:
executein interfacePlugin- 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.
-