org.xwiki.rendering.script

Class RenderingScriptService

java.lang.Object

org.xwiki.rendering.script.RenderingScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="rendering")
 @Singleton
public class RenderingScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Provides Rendering-specific Scripting APIs.

Since:

2.3M1

Version:

$Id: 17abf8d517f374b486157e991a8986297cb40de3 $

Constructor Summary

Constructors

Constructor and Description
RenderingScriptService()

Method Summary

Modifier and Type	Method and Description
String	escape(String content, org.xwiki.rendering.syntax.Syntax syntax) Escapes a give text using the escaping method specific to the given syntax.
List<org.xwiki.rendering.syntax.Syntax>	getAvailableParserSyntaxes()
List<org.xwiki.rendering.syntax.Syntax>	getAvailableRendererSyntaxes()
List<org.xwiki.rendering.syntax.Syntax>	getConfiguredSyntaxes()
List<String>	getDefaultTransformationNames()
List<org.xwiki.rendering.syntax.Syntax>	getDisabledSyntaxes()
org.xwiki.rendering.block.XDOM	parse(String text, String syntaxId) Parses a text written in the passed syntax.
String	render(org.xwiki.rendering.block.Block block, String outputSyntaxId) Render a list of Blocks into the passed syntax.
org.xwiki.rendering.syntax.Syntax	resolveSyntax(String syntaxId) Converts a Syntax specified as a String into a proper Syntax object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingScriptService

public RenderingScriptService()

Method Detail

getAvailableParserSyntaxes

public List<org.xwiki.rendering.syntax.Syntax> getAvailableParserSyntaxes()

Returns:

the list of syntaxes for which a Parser is available

getAvailableRendererSyntaxes

public List<org.xwiki.rendering.syntax.Syntax> getAvailableRendererSyntaxes()

Returns:

the list of syntaxes for which a Renderer is available

getDefaultTransformationNames

public List<String> getDefaultTransformationNames()

Returns:

the names of Transformations that are configured in the Rendering Configuration and which are used by the Transformation Manager when running all transformations

parse

public org.xwiki.rendering.block.XDOM parse(String text,
                                            String syntaxId)

Parses a text written in the passed syntax.

Parameters:

text - the text to parse

syntaxId - the id of the syntax in which the text is written in

Returns:

the XDOM representing the AST of the parsed text or null if an error occurred

Since:

3.2M3

render

public String render(org.xwiki.rendering.block.Block block,
                     String outputSyntaxId)

Render a list of Blocks into the passed syntax.

Parameters:

block - the block to render

outputSyntaxId - the syntax in which to render the blocks

Returns:

the string representing the passed blocks in the passed syntax or null if an error occurred

Since:

3.2M3

resolveSyntax

public org.xwiki.rendering.syntax.Syntax resolveSyntax(String syntaxId)

Converts a Syntax specified as a String into a proper Syntax object.

Parameters:

syntaxId - the syntax as a string (eg "xwiki/2.0", "html/4.01", etc)

Returns:

the proper Syntax object representing the passed syntax

escape

public String escape(String content,
                     org.xwiki.rendering.syntax.Syntax syntax)

Escapes a give text using the escaping method specific to the given syntax.

One example of escaping method is using escape characters like ~ for the Syntax.XWIKI_2_1 syntax on all or just some characters of the given text.

The current implementation only escapes XWiki 1.0, 2.0 and 2.1 syntaxes.

Parameters:

content - the text to escape

syntax - the syntax to escape the content in (e.g. Syntax.XWIKI_1_0, Syntax.XWIKI_2_0, Syntax.XWIKI_2_1, etc.). This is the syntax where the output will be used and not necessarily the same syntax of the input content

Returns:

the escaped text or null if the given content or the given syntax are null, or if the syntax is not supported

Since:

7.1M1

getConfiguredSyntaxes

public List<org.xwiki.rendering.syntax.Syntax> getConfiguredSyntaxes()

Returns:

the list of Rendering Syntaxes that are configured for the current wiki (i.e. that are proposed to the user when editing wik pages)

Since:

8.2M1

getDisabledSyntaxes

public List<org.xwiki.rendering.syntax.Syntax> getDisabledSyntaxes()

Returns:

the list of Rendering Syntaxes that are disabled for the current wiki (i.e. that should not be proposed to the user when editing wiki pages)

Since:

8.2M1