Package 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: 84eeda015c0a4fcece48f5f99a54c1042e527102 $
-
-
Constructor Summary
Constructors Constructor Description BoxMacroParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
-
-
-
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 togetBlockTitle()
-
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 togetTitle()
-
getImage
public ResourceReference getImage()
- Returns:
- the reference to the image to display in the message box.
-
setImage
public void setImage(ResourceReference imageReference)
- Parameters:
imageReference
- seegetImage()
-
getCssClass
public String getCssClass()
- Returns:
- an optional
class
parameter value to use when rendering the Box. The XHTML renderer for example uses it on the surroundingSPAN
(in case the box is used inline) or on the surroundingDIV
(in case the box is used standalone). This allows the user to provide CSS to style the box according to his needs. Example:cssClass="mybox"
. If not specified, theBoxMacro.getClassProperty()
is used to provide a default one.
-
setCssClass
public void setCssClass(String cssClass)
- Parameters:
cssClass
- refer togetCssClass()
-
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 togetWidth()
-
-