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

java.lang.Object
  com.atlassian.confluence.plugins.macros.dashboard.DashboardMacroSupport

public class DashboardMacroSupport
extends Object

This support class provides common functionality used by the macros that are used on the dashboard.

Constructor Summary

DashboardMacroSupport()

DashboardMacroSupport(LabelManager labelManager, SpaceManager spaceManager, LocaleManager localeManager)

Method Summary

List<Space>	getAllViewableSpaces()
DateFormatter	getDateFormatter()
List<Space>	getFavouriteSpaces()
List<Space>	getNewSpaces()
Set<Space>	getPermittedSpaces() Deprecated. use getPermittedSpacesBuilder instead
ListBuilder<Space>	getPermittedSpacesBuilder() Get an ListBuilder of all spaces the current user can see.
javax.servlet.http.HttpServletRequest	getRequest() There are two possible cases here - You are within an HTTP request thread, in which case the request will be retrieved from a ThreadLocal You are not a 'web related' thread (e.g.
String	getRequestParameter(String key)
protected String	getSelectedTeamLabelName()
String	getSpacesSelectedTab()
List<Space>	getTeamSpaces()
protected UserInterfaceState	getUserInterfaceState()
List<String>	getViewableTeamLabels()
protected String	sanitiseSelectedSpacesTab(String spacesSelectedTab) four cases to sanitise on "new" tab when there are no new spaces "my" tab when there are no favourite spaces "team" tab when there are no teams
void	setLabelManager(LabelManager labelManager)
void	setLocaleManager(LocaleManager localeManager)
void	setSpaceManager(SpaceManager spaceManager)

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardMacroSupport

public DashboardMacroSupport()

DashboardMacroSupport

public DashboardMacroSupport(LabelManager labelManager,
                             SpaceManager spaceManager,
                             LocaleManager localeManager)

Method Detail

getFavouriteSpaces

public List<Space> getFavouriteSpaces()

getDateFormatter

public DateFormatter getDateFormatter()

getNewSpaces

public List<Space> getNewSpaces()

getTeamSpaces

public List<Space> getTeamSpaces()

getPermittedSpaces

@Deprecated
public Set<Space> getPermittedSpaces()

Deprecated. use getPermittedSpacesBuilder instead

Get a set of all spaces the current user can see.

Returns:

all spaces the current user can see

getPermittedSpacesBuilder

public ListBuilder<Space> getPermittedSpacesBuilder()

Get an ListBuilder of all spaces the current user can see.

Returns:

a ListBuilder of all spaces the current user can see

getSelectedTeamLabelName

protected String getSelectedTeamLabelName()

getViewableTeamLabels

public List<String> getViewableTeamLabels()

getUserInterfaceState

protected UserInterfaceState getUserInterfaceState()

getSpacesSelectedTab

public String getSpacesSelectedTab()

sanitiseSelectedSpacesTab

protected String sanitiseSelectedSpacesTab(String spacesSelectedTab)

four cases to sanitise on

• "new" tab when there are no new spaces
• "my" tab when there are no favourite spaces
• "team" tab when there are no teams

Parameters:

spacesSelectedTab - currently selected tab

Returns:

spacesSelectedTab if the tab contains spaces, return the tab, else return "all"

getRequestParameter

public String getRequestParameter(String key)

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

There are two possible cases here -

1. You are within an HTTP request thread, in which case the request will be retrieved from a ThreadLocal
2. You are not a 'web related' thread (e.g. a Long running task) in which case null will be returned.

Returns:

The HttpServletRequest associated with the current thread.

getAllViewableSpaces

public List<Space> getAllViewableSpaces()

setLabelManager

public void setLabelManager(LabelManager labelManager)

setSpaceManager

public void setSpaceManager(SpaceManager spaceManager)

setLocaleManager

public void setLocaleManager(LocaleManager localeManager)