com.atlassian.renderer.macro.macros

Class AbstractPanelMacro

java.lang.Object

org.radeox.macro.BaseMacro

com.atlassian.renderer.macro.BaseMacro

com.atlassian.renderer.macro.macros.AbstractPanelMacro

All Implemented Interfaces:

Comparable, org.radeox.macro.Macro

Direct Known Subclasses:

PanelMacro

public abstract class AbstractPanelMacro
extends BaseMacro

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

initialContext, paramDescription

Constructor Summary

Constructors

Constructor and Description
AbstractPanelMacro()

Method Summary

Modifier and Type	Method and Description
void	execute(Writer writer, org.radeox.macro.parameter.MacroParameter macroParameter)
protected String	getBodyContent(org.radeox.macro.parameter.MacroParameter macroParameter) What should the body content of the panel be? Override in subclasses
protected abstract String	getPanelContentCSSClass()
protected abstract String	getPanelCSSClass()
protected abstract String	getPanelHeaderCSSClass()
String[]	getParamDescription()
protected String	getTitle(org.radeox.macro.parameter.MacroParameter macroParameter) What should the title of the panel be? Override in subclasses
protected void	writeContent(Writer writer, org.radeox.macro.parameter.MacroParameter macroParameter, String content, String backgroundColor)
protected void	writeHeader(Writer writer, String title, String borderStyle, String borderColor, Integer borderWidth, String titleBackgroundColor)

Methods inherited from class com.atlassian.renderer.macro.BaseMacro

getDescription, getResourcePath, setDescription, setResourcePath

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, getName, setInitialContext, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.radeox.macro.Macro

getName, setInitialContext

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

AbstractPanelMacro

public AbstractPanelMacro()

Method Detail

getParamDescription

public String[] getParamDescription()

Specified by:

getParamDescription in interface org.radeox.macro.Macro

Overrides:

getParamDescription in class org.radeox.macro.BaseMacro

getPanelCSSClass

protected abstract String getPanelCSSClass()

getPanelHeaderCSSClass

protected abstract String getPanelHeaderCSSClass()

getPanelContentCSSClass

protected abstract String getPanelContentCSSClass()

getTitle

protected String getTitle(org.radeox.macro.parameter.MacroParameter macroParameter)

What should the title of the panel be? Override in subclasses

Parameters:

macroParameter - the macroParameter context for this macro

Returns:

the contents of the panel's title.

getBodyContent

protected String getBodyContent(org.radeox.macro.parameter.MacroParameter macroParameter)

What should the body content of the panel be? Override in subclasses

Parameters:

macroParameter - the macroParameter context for this macro

Returns:

the contents of the panel's body.

execute

public void execute(Writer writer,
                    org.radeox.macro.parameter.MacroParameter macroParameter)
             throws IllegalArgumentException,
                    IOException

Specified by:

execute in interface org.radeox.macro.Macro

Specified by:

execute in class org.radeox.macro.BaseMacro

Throws:

IllegalArgumentException

IOException

writeHeader

protected void writeHeader(Writer writer,
                           String title,
                           String borderStyle,
                           String borderColor,
                           Integer borderWidth,
                           String titleBackgroundColor)
                    throws IOException

Throws:

IOException

writeContent

protected void writeContent(Writer writer,
                            org.radeox.macro.parameter.MacroParameter macroParameter,
                            String content,
                            String backgroundColor)
                     throws IOException

Throws:

IOException