com.atlassian.confluence.plugins.macros.dashboard.recentupdates.tabs
Class FavouriteSpacesTab

java.lang.Object
  extended by com.atlassian.confluence.plugins.macros.dashboard.recentupdates.tabs.AbstractTab
      extended by com.atlassian.confluence.plugins.macros.dashboard.recentupdates.tabs.FavouriteSpacesTab
All Implemented Interfaces:
RecentlyUpdatedMacroTab

public class FavouriteSpacesTab
extends AbstractTab

Implements the "Favourite Spaces" tab, which displays updates from a user's favourite spaces.


Field Summary
 
Fields inherited from class com.atlassian.confluence.plugins.macros.dashboard.recentupdates.tabs.AbstractTab
httpContext, i18NBeanFactory
 
Constructor Summary
FavouriteSpacesTab(HttpContext httpContext, I18NBeanFactory i18NBeanFactory, LabelManager labelManager, PermissionManager permissionManager, LocaleManager localeManager)
           
 
Method Summary
 Set<String> getFavouriteSpaceKeys(com.atlassian.user.User user)
           
 String getName()
           
 RecentUpdateQueryParameters getQueryParameters(RecentlyUpdatedMacroParams macroParams, RecentlyUpdatedMacroRequestParams requestParams, com.atlassian.renderer.RenderContext renderContext)
           
 Map<String,Object> getRenderContext(RecentlyUpdatedMacroRequestParams requestParams, com.atlassian.renderer.RenderContext renderContext)
          Gives each tab a chance to add things to the macro's rendering context
 boolean shouldDisplay(com.atlassian.renderer.RenderContext renderContext)
           
 
Methods inherited from class com.atlassian.confluence.plugins.macros.dashboard.recentupdates.tabs.AbstractTab
getDisplayName, getNoContentMessage, getUrl, getUser
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FavouriteSpacesTab

public FavouriteSpacesTab(HttpContext httpContext,
                          I18NBeanFactory i18NBeanFactory,
                          LabelManager labelManager,
                          PermissionManager permissionManager,
                          LocaleManager localeManager)
Method Detail

getName

public String getName()
Returns:
the identifier for this tab. Should be a short, lowercase string that is unique to each tab.

shouldDisplay

public boolean shouldDisplay(com.atlassian.renderer.RenderContext renderContext)
Parameters:
renderContext - The macro rendering context
Returns:
true if the tab should be visible in the provided context.

getQueryParameters

public RecentUpdateQueryParameters getQueryParameters(RecentlyUpdatedMacroParams macroParams,
                                                      RecentlyUpdatedMacroRequestParams requestParams,
                                                      com.atlassian.renderer.RenderContext renderContext)
Parameters:
macroParams - Settings passed in via macro parameters
requestParams - Settings passed in via request parameters
renderContext - The macro rendering context
Returns:
the query parameters that are used to display search results on this tab.

getRenderContext

public Map<String,Object> getRenderContext(RecentlyUpdatedMacroRequestParams requestParams,
                                           com.atlassian.renderer.RenderContext renderContext)
Description copied from interface: RecentlyUpdatedMacroTab
Gives each tab a chance to add things to the macro's rendering context

Parameters:
requestParams - Settings passed in via request parameters
renderContext - Settings passed in via macro parameters
Returns:
A map of key/value pairs that the tab wants added to the Velocity context

getFavouriteSpaceKeys

public Set<String> getFavouriteSpaceKeys(com.atlassian.user.User user)


Copyright © 2003–2015 Atlassian. All rights reserved.