org.xwiki.rendering.block

Class VerbatimBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.VerbatimBlock

All Implemented Interfaces:

Cloneable, Block

public class VerbatimBlock
extends AbstractBlock

A Verbatim block.

Since:

1.8M2

Version:

$Id: 814a56bbdfbc96d5dd30353c921734d439d3de55 $

Nested Class Summary

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

Block.Axes

Constructor Summary

Constructors

Constructor and Description
VerbatimBlock(String protectedString, boolean isInline)
VerbatimBlock(String protectedString, Map<String,String> parameters, boolean isInline)

Method Summary

Methods

Modifier and Type	Method and Description
String	getProtectedString()
boolean	isInline()
String	toString()
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, wait, wait, wait

Constructor Detail

VerbatimBlock

public VerbatimBlock(String protectedString,
             boolean isInline)

Parameters:

protectedString - the string to protect from rendering.

isInline - if true the macro is located in a inline content (like paragraph, etc.).

VerbatimBlock

public VerbatimBlock(String protectedString,
             Map<String,String> parameters,
             boolean isInline)

Parameters:

protectedString - the string to protect from rendering.

parameters - the custom parameters

isInline - if true the macro is located in a inline content (like paragraph, etc.).

Method Detail

getProtectedString

public String getProtectedString()

Returns:

the string to protect from rendering

isInline

public boolean isInline()

Returns:

if true the macro is located in a inline content (like paragraph, etc.).

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.

toString

public String toString()

Overrides:

toString in class Object

Since:

1.8RC2