org.xwiki.edit.script

Class SyntaxContentEditScriptService

java.lang.Object

org.xwiki.edit.script.AbstractTypedEditScriptService<org.xwiki.rendering.syntax.SyntaxContent>

org.xwiki.edit.script.SyntaxContentEditScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Singleton
 @Named(value="edit.syntaxContent")
 @Unstable
public class SyntaxContentEditScriptService
extends AbstractTypedEditScriptService<org.xwiki.rendering.syntax.SyntaxContent>

Edit script service specialized in SyntaxContent Editors.

Since:

8.2RC1

Version:

$Id: 520022060cb79cbbf46c1dea31ecbb6fa3242469 $

Constructor Summary

Constructors

Constructor and Description
SyntaxContentEditScriptService()

Method Summary

Modifier and Type	Method and Description
Editor<org.xwiki.rendering.syntax.SyntaxContent>	getDefaultTextEditor()
Editor<org.xwiki.rendering.syntax.SyntaxContent>	getDefaultWysiwygEditor()
String	text(String content, org.xwiki.rendering.syntax.Syntax syntax, Map<String,Object> parameters) Generates the HTML code needed to edit the given data.
String	wysiwyg(String content, org.xwiki.rendering.syntax.Syntax syntax, Map<String,Object> parameters) Generates the HTML code needed to edit the given data.

Methods inherited from class org.xwiki.edit.script.AbstractTypedEditScriptService

getDataType, getDefaultEditor, getDefaultEditor, getDefaultEditorId, getDefaultEditorId, getEditor, getEditors, getEditors

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxContentEditScriptService

public SyntaxContentEditScriptService()

Method Detail

getDefaultTextEditor

public Editor<org.xwiki.rendering.syntax.SyntaxContent> getDefaultTextEditor()

Returns:

the default SyntaxContent editor in the "Text" category

getDefaultWysiwygEditor

public Editor<org.xwiki.rendering.syntax.SyntaxContent> getDefaultWysiwygEditor()

Returns:

the default SyntaxContent editor in the "WYSIWYG" category

text

public String text(String content,
                   org.xwiki.rendering.syntax.Syntax syntax,
                   Map<String,Object> parameters)
            throws EditException

Generates the HTML code needed to edit the given data.

Parameters:

content - the text content to edit

syntax - the syntax of the given content

parameters - the edit parameters

Returns:

the HTML code that displays the default text editor for SyntaxContent

Throws:

EditException - if rendering the editor fails

wysiwyg

public String wysiwyg(String content,
                      org.xwiki.rendering.syntax.Syntax syntax,
                      Map<String,Object> parameters)
               throws EditException

Generates the HTML code needed to edit the given data.

Parameters:

content - the text content to edit

syntax - the syntax of the given content

parameters - the edit parameters

Returns:

the HTML code that displays the default WYSIWYG editor for SyntaxContent

Throws:

EditException - if rendering the editor fails