org.xwiki.rendering.block

Class ExpandedMacroBlock

java.lang.Object

org.xwiki.rendering.block.AbstractBlock

org.xwiki.rendering.block.AbstractMacroBlock

org.xwiki.rendering.block.MacroBlock

org.xwiki.rendering.block.ExpandedMacroBlock

All Implemented Interfaces:

Cloneable, org.xwiki.rendering.block.Block

public class ExpandedMacroBlock
extends org.xwiki.rendering.block.MacroBlock

A MacroBlock whose content is expanded. The macro content can be accessed and modified through the child blocks. This type of macro block is suited only for macros whose content can be parsed into a list of block nodes.

Since:

3.0M3

Version:

$Id: f913c5a7e3ef4d829f2c706a31a617aec1a8d128 $

Nested Class Summary

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

org.xwiki.rendering.block.Block.Axes

Constructor Summary

Constructors

Constructor and Description
ExpandedMacroBlock(String id, Map<String,String> parameters, org.xwiki.rendering.renderer.BlockRenderer contentRenderer, boolean inline) Creates a new expanded macro block.
ExpandedMacroBlock(String id, Map<String,String> parameters, org.xwiki.rendering.renderer.BlockRenderer contentRenderer, boolean inline, org.xwiki.component.manager.ComponentManager componentManager) Creates a new expanded macro block.

Method Summary

Modifier and Type	Method and Description
String	getContent()

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

traverse

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

equals, getId, hashCode, isInline

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

addChild, addChildren, after, before, clone, clone, getBlocks, getChildren, getFirstBlock, getNextSibling, getParameter, getParameters, getParent, getPreviousSibling, getRoot, 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

ExpandedMacroBlock

public ExpandedMacroBlock(String id,
                          Map<String,String> parameters,
                          org.xwiki.rendering.renderer.BlockRenderer contentRenderer,
                          boolean inline)

Creates a new expanded macro block.

Parameters:

id - the id of the macro

parameters - the parameters of the macro

contentRenderer - the component used to reconstruct the macro content from the child blocks

inline - indicates if the macro is located in an in-line content (e.g. inside a paragraph)

ExpandedMacroBlock

public ExpandedMacroBlock(String id,
                          Map<String,String> parameters,
                          org.xwiki.rendering.renderer.BlockRenderer contentRenderer,
                          boolean inline,
                          org.xwiki.component.manager.ComponentManager componentManager)

Creates a new expanded macro block.

Parameters:

id - the id of the macro

parameters - the parameters of the macro

contentRenderer - the component used to reconstruct the macro content from the child blocks

inline - indicates if the macro is located in an in-line content (e.g. inside a paragraph)

componentManager - allows the expanded macro block to use a different syntax for its content if one of its ancestor meta data blocks specify the syntax

Method Detail

getContent

public String getContent()

Overrides:

getContent in class org.xwiki.rendering.block.AbstractMacroBlock