Package com.xwiki.macros.status.macro

Class StatusMacroParameters

java.lang.Object

com.xwiki.macros.status.macro.StatusMacroParameters

public class StatusMacroParameters
extends Object

Parameter bean class for StatusMacro.

Since:

1.31.1

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
StatusMacroParameters()

Method Summary

Modifier and Type	Method	Description
String	getColour()	The color of the status.
String	getTitle()	The text of the status.
boolean	isSubtle()	The aspect of the status: either white text on dark color background (false) or dark color text on light color background (true).
void	setColour(String colour)	See getColour().
void	setSubtle(boolean subtle)	See isSubtle().
void	setTitle(String title)	See getTitle().

Methods inherited from class java.lang.Object

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

Constructor Details

StatusMacroParameters

public StatusMacroParameters()

Method Details

isSubtle

public boolean isSubtle()

The aspect of the status: either white text on dark color background (false) or dark color text on light color background (true). Default value is false.

Returns:

true if the status is subtle, false otherwise

setSubtle

public void setSubtle(boolean subtle)

See isSubtle().

Parameters:

subtle - the aspect of the status.

getColour

public String getColour()

The color of the status. The default value is "Grey".

Returns:

The color of the status.

setColour

public void setColour(String colour)

See getColour().

Parameters:

colour - the color of the status.

getTitle

public String getTitle()

The text of the status.

Returns:

The text of the status.

setTitle

public void setTitle(String title)

See getTitle().

Parameters:

title - the text of the status.