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

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by com.atlassian.renderer.macro.BaseMacro
          extended by com.atlassian.confluence.renderer.radeox.macros.AbstractHtmlGeneratingMacro
              extended by com.atlassian.confluence.plugins.macros.dashboard.SpacesListMacro
All Implemented Interfaces:
Comparable, org.radeox.macro.Macro

public class SpacesListMacro
extends AbstractHtmlGeneratingMacro


Nested Class Summary
static class SpacesListMacro.Tabs
           
 
Field Summary
static 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  String getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
           
protected  I18NBean getI18n()
           
protected  Map<String,Object> getMacroVelocityContext()
           
 String getName()
           
 String getSelectedTeam(List<String> availableTeams, DashboardMacroSupport support)
           
 Map<String,List<Space>> getSortedRecentlyCreatedSpaces(DashboardMacroSupport support)
           
 Set<Space> getSpacesForLabels(String labels)
           
 List<Space> getSpacesForTeam(String selectedTeam)
           
 UserInterfaceState getUserInterfaceState()
           
protected  String renderMacro(Map contextMap, String velocityTemplatePath)
           
 void setLabelManager(LabelManager labelManager)
           
 void setLocaleManager(LocaleManager localeManager)
           
 void setPermissionCheckDispatcher(PermissionCheckDispatcher permissionCheckDispatcher)
           
 void setSettingsManager(SettingsManager settingsManager)
           
 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 String MACRO_NAME
See Also:
Constant Field Values
Constructor Detail

SpacesListMacro

public SpacesListMacro()
Method Detail

getHtml

protected String getHtml(org.radeox.macro.parameter.MacroParameter macroParameter)
                  throws IllegalArgumentException,
                         IOException
Specified by:
getHtml in class AbstractHtmlGeneratingMacro
Throws:
IllegalArgumentException
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 String renderMacro(Map contextMap,
                             String velocityTemplatePath)
                      throws IOException
Throws:
IOException

getGlobalSettings

protected Settings getGlobalSettings()

getI18n

protected I18NBean getI18n()

getMacroVelocityContext

protected Map<String,Object> getMacroVelocityContext()

getName

public String getName()
Specified by:
getName in interface org.radeox.macro.Macro
Specified by:
getName in class org.radeox.macro.BaseMacro

getSelectedTeam

public String getSelectedTeam(List<String> availableTeams,
                              DashboardMacroSupport support)

getUserInterfaceState

public UserInterfaceState getUserInterfaceState()

getSpacesForLabels

public Set<Space> getSpacesForLabels(String labels)
Parameters:
labels - comma delimited list of labels
Returns:
spaces belonging to these labels

getSpacesForTeam

public List<Space> getSpacesForTeam(String selectedTeam)

getSortedRecentlyCreatedSpaces

public Map<String,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)


Copyright © 2003-2011 Atlassian. All Rights Reserved.