com.xpn.xwiki.wysiwyg.server.plugin
Class WysiwygPluginApi

java.lang.Object
  com.xpn.xwiki.api.Api
      com.xpn.xwiki.wysiwyg.server.plugin.WysiwygPluginApi

public class WysiwygPluginApi
extends com.xpn.xwiki.api.Api

Api for the WysiwygPlugin.

Field Summary

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

WysiwygPluginApi(WysiwygPlugin plugin, com.xpn.xwiki.XWikiContext context)

Method Summary

java.lang.String	getInput(java.lang.String id, java.lang.String source, java.lang.String syntax) Creates an HTML input hidden that could serve as the input for a WYSIWYG editor instance.
WysiwygPlugin	getPlugin()
boolean	isSyntaxSupported(java.lang.String syntaxId)
void	setPlugin(WysiwygPlugin plugin)

Methods inherited from class com.xpn.xwiki.api.Api

checkProgrammingRights, convert, convert, getXWikiContext, hasAccessLevel, hasAdminRights, hasProgrammingRights

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WysiwygPluginApi

public WysiwygPluginApi(WysiwygPlugin plugin,
                        com.xpn.xwiki.XWikiContext context)

Method Detail

getPlugin

public WysiwygPlugin getPlugin()

See Also:

plugin

setPlugin

public void setPlugin(WysiwygPlugin plugin)

See Also:

plugin

isSyntaxSupported

public boolean isSyntaxSupported(java.lang.String syntaxId)

Parameters:

syntaxId - The syntax identifier, like "xwiki/2.0".

Returns:

true if the specified syntax is currently supported by the editor.

getInput

public java.lang.String getInput(java.lang.String id,
                                 java.lang.String source,
                                 java.lang.String syntax)

Creates an HTML input hidden that could serve as the input for a WYSIWYG editor instance. The editor instance should be configured to have its inputId parameter equal to the id passed to this method.

Parameters:

id - The id of the generated HTML input.

source - The text that will be converted to HTML and then filled in the value attribute.

syntax - The syntax of the source text.

Returns:

The HTML to be included in a page in order to use the input.