com.atlassian.confluence.plugins.macros.dashboard
Class SpacesListMacro

java.lang.Object
  org.radeox.macro.BaseMacro
      com.atlassian.renderer.macro.BaseMacro
          com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro
              com.atlassian.confluence.plugins.macros.dashboard.SpacesListMacro

All Implemented Interfaces:

java.lang.Comparable, org.radeox.macro.Macro

public class SpacesListMacro
extends AbstractHtmlGeneratingMacro

Field Summary

static java.lang.String

MACRO_NAME

Fields inherited from class com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro

log

Fields inherited from class org.radeox.macro.BaseMacro

initialContext, paramDescription

Constructor Summary

SpacesListMacro()

Method Summary

protected DashboardMacroSupport	createDashboardMacroSupport() Instantiates DashboardMacroSupport.
protected DashboardMacroSupport	getDashboardMacroSupport()
protected Settings	getGlobalSettings()
protected java.lang.String	getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
protected I18NBean	getI18n()
protected java.util.Map<java.lang.String,java.lang.Object>	getMacroVelocityContext()
java.lang.String	getName()
java.lang.String	getSelectedGroup(java.util.List<SpaceGroup> availableGroups, DashboardMacroSupport support)
java.lang.String	getSelectedTeam(java.util.List<java.lang.String> availableTeams, DashboardMacroSupport support)
java.util.Map<java.lang.String,java.util.List<Space>>	getSortedRecentlyCreatedSpaces(DashboardMacroSupport support)
java.util.List<Space>	getSpacesForGroup(java.lang.String selectedGroup)
java.util.Set<Space>	getSpacesForLabels(java.lang.String labels)
java.util.List<Space>	getSpacesForTeam(java.lang.String selectedTeam)
UserInterfaceState	getUserInterfaceState()
protected boolean	isSuperUser()
protected java.lang.String	renderMacro(java.util.Map contextMap, java.lang.String velocityTemplatePath)
void	setLabelManager(LabelManager labelManager)
void	setLocaleManager(LocaleManager localeManager)
void	setPermissionCheckDispatcher(PermissionCheckDispatcher permissionCheckDispatcher)
void	setSettingsManager(SettingsManager settingsManager)
void	setSpaceGroupManager(SpaceGroupManager spaceGroupManager)
void	setSpaceManager(SpaceManager spaceManager)

Methods inherited from class com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro

buildBaseUrl, errorContent, execute, getPageContext, getRemoteUser, hasLoneParameter, parseParameterForKey

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

getDescription, getResourcePath, setDescription, setResourcePath

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, getParamDescription, 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

getParamDescription, setInitialContext

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MACRO_NAME

public static final java.lang.String MACRO_NAME

See Also:

Constant Field Values

Constructor Detail

SpacesListMacro

public SpacesListMacro()

Method Detail

getHtml

protected java.lang.String getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
                            throws java.lang.IllegalArgumentException,
                                   java.io.IOException

Specified by:

getHtml in class AbstractHtmlGeneratingMacro

Throws:

java.lang.IllegalArgumentException

java.io.IOException

getDashboardMacroSupport

protected DashboardMacroSupport getDashboardMacroSupport()

createDashboardMacroSupport

protected DashboardMacroSupport createDashboardMacroSupport()

Instantiates DashboardMacroSupport. This method is here because it is overridden in tests to instead provide a mock DashboardMacroSupport.

Returns:

A DashboradMacroSupport object.

renderMacro

protected java.lang.String renderMacro(java.util.Map contextMap,
                                       java.lang.String velocityTemplatePath)
                                throws java.io.IOException

Throws:

java.io.IOException

getGlobalSettings

protected Settings getGlobalSettings()

getI18n

protected I18NBean getI18n()

getMacroVelocityContext

protected java.util.Map<java.lang.String,java.lang.Object> getMacroVelocityContext()

setSpaceGroupManager

public void setSpaceGroupManager(SpaceGroupManager spaceGroupManager)

isSuperUser

protected boolean isSuperUser()

getName

public java.lang.String getName()

Specified by:

getName in interface org.radeox.macro.Macro

Specified by:

getName in class org.radeox.macro.BaseMacro

getSelectedTeam

public java.lang.String getSelectedTeam(java.util.List<java.lang.String> availableTeams,
                                        DashboardMacroSupport support)

getSelectedGroup

public java.lang.String getSelectedGroup(java.util.List<SpaceGroup> availableGroups,
                                         DashboardMacroSupport support)

getUserInterfaceState

public UserInterfaceState getUserInterfaceState()

getSpacesForLabels

public java.util.Set<Space> getSpacesForLabels(java.lang.String labels)

Parameters:

labels - comma delimited list of labels

Returns:

spaces belonging to these labels

getSpacesForGroup

public java.util.List<Space> getSpacesForGroup(java.lang.String selectedGroup)

getSpacesForTeam

public java.util.List<Space> getSpacesForTeam(java.lang.String selectedTeam)

getSortedRecentlyCreatedSpaces

public java.util.Map<java.lang.String,java.util.List<Space>> getSortedRecentlyCreatedSpaces(DashboardMacroSupport support)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setLabelManager

public void setLabelManager(LabelManager labelManager)

setPermissionCheckDispatcher

public void setPermissionCheckDispatcher(PermissionCheckDispatcher permissionCheckDispatcher)

setSettingsManager

public void setSettingsManager(SettingsManager settingsManager)

setLocaleManager

public void setLocaleManager(LocaleManager localeManager)