Package com.atlassian.gadgets.dashboard.view

Interface DashboardTabViewFactory

public interface DashboardTabViewFactory

A factory which provides a way to create ViewComponents for dashboards displaying other dashboards available as tabs. A host application should use this for embedding dashboards in the desired locations by creating a view and then calling the ViewComponent.writeTo(java.io.Writer) method.

Method Summary

Modifier and Type	Method	Description
ViewComponent	createDashboardView(Iterable<DashboardTab> tabs, DashboardState selectedTabDashboardState, String username, int maxGadgets, GadgetRequestContext gadgetRequestContext)	Returns a ViewComponent that will render the DashboardState and DashboardTabs customizing the view based on the permissions the user has to view/edit the dashboard and the specified Locale.

Method Details

createDashboardView

ViewComponent createDashboardView(Iterable<DashboardTab> tabs,
 DashboardState selectedTabDashboardState,
 @Nullable
 String username,
 int maxGadgets,
 GadgetRequestContext gadgetRequestContext)

Returns a ViewComponent that will render the DashboardState and DashboardTabs customizing the view based on the permissions the user has to view/edit the dashboard and the specified Locale.

This can be used by host applications to place dashboards in a place of their choosing, including tabs to navigate to other dashboards.

Parameters:

tabs - a list of dashboards a particular user can see. This can be empty if no tabs are desired.

selectedTabDashboardState - state of the dashboard to be rendered by the ViewComponent

username - user that is viewing the dashboard and whose permissions will be checked

maxGadgets - the (application-wide) maximum number of supported gadgets

gadgetRequestContext - the context of this request

Returns:

a ViewComponent that will render the DashboardState