org.xwiki.rendering.macro.box
Class BoxMacroParameters

java.lang.Object
  org.xwiki.rendering.macro.box.BoxMacroParameters

public class BoxMacroParameters
extends Object

Parameters for the Box macro.

Version:

$Id$

Constructor Summary

BoxMacroParameters()

Method Summary

List<? extends Block>	getBlockTitle() Optionally, the title can contain a list of Blocks, for more flexibility, instead of storing only ordinary text.
String	getCssClass()
ResourceReference	getImage()
String	getTitle()
String	getWidth()
void	setBlockTitle(List<? extends Block> blockTitle)
void	setCssClass(String cssClass)
void	setImage(ResourceReference imageReference)
void	setTitle(String title)
void	setWidth(String width)

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxMacroParameters

public BoxMacroParameters()

Method Detail

getBlockTitle

public List<? extends Block> getBlockTitle()

Optionally, the title can contain a list of Blocks, for more flexibility, instead of storing only ordinary text.

Returns:

the title represented as a list of Blocks

setBlockTitle

public void setBlockTitle(List<? extends Block> blockTitle)

Parameters:

blockTitle - - refer to getBlockTitle()

getTitle

public String getTitle()

Returns:

the title to be displayed in the message box. Note that it can contain content in the current syntax and that text which will be parsed and rendered as any syntax content

setTitle

public void setTitle(String title)

Parameters:

title - refer to getTitle()

getImage

public ResourceReference getImage()

Returns:

the reference to the image to display in the message box.

setImage

public void setImage(ResourceReference imageReference)

Parameters:

imageReference - see getImage()

getCssClass

public String getCssClass()

Returns:

an optional CSS sheet to be used when rendering this macro. If no sheet is specified, the BoxMacro.getClassProperty() is used to provide a default one.

setCssClass

public void setCssClass(String cssClass)

Parameters:

cssClass - refer to getCssClass()

getWidth

public String getWidth()

Returns:

an optional width to enforce as an inline style on the DIV element the box will be formed of.

setWidth

public void setWidth(String width)

Parameters:

width - refer to getWidth()