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:

java.lang.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

AbstractPanelMacro()

Method Summary

void	execute(java.io.Writer writer, org.radeox.macro.parameter.MacroParameter macroParameter)
protected java.lang.String	getBodyContent(org.radeox.macro.parameter.MacroParameter macroParameter) What should the body content of the panel be? Override in subclasses
protected abstract java.lang.String	getPanelContentCSSClass()
protected abstract java.lang.String	getPanelCSSClass()
protected abstract java.lang.String	getPanelHeaderCSSClass()
java.lang.String[]	getParamDescription()
protected java.lang.String	getTitle(org.radeox.macro.parameter.MacroParameter macroParameter) What should the title of the panel be? Override in subclasses
protected void	writeContent(java.io.Writer writer, org.radeox.macro.parameter.MacroParameter macroParameter, java.lang.String content, java.lang.String backgroundColor)
protected void	writeHeader(java.io.Writer writer, java.lang.String title, java.lang.String borderStyle, java.lang.String borderColor, java.lang.Integer borderWidth, java.lang.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 java.lang.String[] getParamDescription()

Specified by:

getParamDescription in interface org.radeox.macro.Macro

Overrides:

getParamDescription in class org.radeox.macro.BaseMacro

getPanelCSSClass

protected abstract java.lang.String getPanelCSSClass()

getPanelHeaderCSSClass

protected abstract java.lang.String getPanelHeaderCSSClass()

getPanelContentCSSClass

protected abstract java.lang.String getPanelContentCSSClass()

getTitle

protected java.lang.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 java.lang.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(java.io.Writer writer,
                    org.radeox.macro.parameter.MacroParameter macroParameter)
             throws java.lang.IllegalArgumentException,
                    java.io.IOException

Specified by:

execute in interface org.radeox.macro.Macro

Specified by:

execute in class org.radeox.macro.BaseMacro

Throws:

java.lang.IllegalArgumentException

java.io.IOException

writeHeader

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

Throws:

java.io.IOException

writeContent

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

Throws:

java.io.IOException