org.xwiki.rendering.block

Class RawBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.RawBlock

All Implemented Interfaces:

Cloneable, Block

public class RawBlock
extends AbstractBlock

Represents some raw content that shouldn't be parsed or modified and that should be injected as is in any output. The content depends on a syntax and listeners decide if they can handle that syntax or not. For example if it's in "xhtml/1.0" syntax then the XHTML Renderer can insert it directly in the XHTML output.

Since:

1.8.3

Version:

$Id: 1e8d725386863fdc77c6dc7781dd284ddef33032 $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.rendering.block.Block

Block.Axes

Constructor Summary

Constructors

Constructor and Description
RawBlock(String rawContent, Syntax syntax)

Method Summary

Methods

Modifier and Type	Method and Description
String	getRawContent()
Syntax	getSyntax()
void	traverse(Listener listener) Let the block send Listener events corresponding to its content.

Methods inherited from class org.xwiki.rendering.block.AbstractBlock

addChild, addChildren, after, before, clone, clone, equals, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, hashCode, insertChildAfter, insertChildBefore, removeBlock, replaceChild, replaceChild, setChildren, setNextSiblingBlock, setParameter, setParameters, setParent, setPreviousSiblingBlock

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RawBlock

public RawBlock(String rawContent,
        Syntax syntax)

Parameters:

rawContent - the content to inject as is into the listener (it won't be modified)

syntax - the syntax in which the content is written

Method Detail

traverse

public void traverse(Listener listener)

Description copied from interface: Block

Let the block send Listener events corresponding to its content. For example a Paragraph block will send the Listener.beginParagraph(java.util.Map<java.lang.String, java.lang.String>) and Listener.endParagraph(java.util.Map<java.lang.String, java.lang.String>) events when this method is called.

Specified by:

traverse in interface Block

Overrides:

traverse in class AbstractBlock

Parameters:

listener - the listener to which to send the events to.

getRawContent

public String getRawContent()

Returns:

the content to inject as is into the listener (it won't be modified)

getSyntax

public Syntax getSyntax()

Returns:

the syntax in which the content is written