public class BoxMacroParameters extends Object
Constructor and Description |
---|
BoxMacroParameters() |
Modifier and Type | Method and 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) |
public List<? extends Block> getBlockTitle()
public void setBlockTitle(List<? extends Block> blockTitle)
blockTitle
- - refer to getBlockTitle()
public String getTitle()
public void setTitle(String title)
title
- refer to getTitle()
public ResourceReference getImage()
public void setImage(ResourceReference imageReference)
imageReference
- see getImage()
public String getCssClass()
class
parameter value to use when rendering the Box. The XHTML renderer for example
uses it on the surrounding SPAN
(in case the box is used inline) or on the surrounding
DIV
(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, the
BoxMacro.getClassProperty()
is used to provide a default one.public void setCssClass(String cssClass)
cssClass
- refer to getCssClass()
public String getWidth()
public void setWidth(String width)
width
- refer to getWidth()
Copyright © 2004–2020 XWiki. All rights reserved.