Package org.sonar.api.web

Class Dashboard

  • @Deprecated
public final class Dashboard
extends java.lang.Object
    Deprecated.
    since 6.2, this extension is ignored as dashboards have been removed
    Definition of a dashboard.
    Its name and description can be retrieved using the i18n mechanism, using the keys "dashboard.<id>.name" and "dashboard.<id>.description".
    Since:
    2.13

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Dashboard.Widget
      Deprecated.
      Note that this class is an inner class to avoid confusion with the extension point org.sonar.api.web.Widget.

    • Method Detail

      • addWidget

        public Dashboard.Widget addWidget​(java.lang.String widgetId,
                                  int columnId)
        Deprecated.
        Add a widget with the given parameters, and return the newly created Dashboard.Widget object if one wants to add parameters to it.

        The widget ids are listed by the web service /api/widgets

        Parameters:
        widgetId - id of an existing widget
        columnId - column starts with 1. The widget is ignored if the column id does not match the layout.

      • getWidgets

        public java.util.Collection<Dashboard.Widget> getWidgets()
        Deprecated.

      • getWidgetsOfColumn

        public java.util.List<Dashboard.Widget> getWidgetsOfColumn​(int columnId)
        Deprecated.

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Returns the description of the dashboard.
        Returns:
        the description

      • setDescription

        public Dashboard setDescription​(java.lang.String description)
        Deprecated.
        Sets the description of the dashboard.
        Note: you should use the i18n mechanism for the description.
        Parameters:
        description - the description to set

      • getLayout

        public DashboardLayout getLayout()
        Deprecated.
        Returns the layout. Default value is the 2 columns mode with width 50%/50%.
        Returns:
        the layout

      • isGlobal

        public boolean isGlobal()
        Deprecated.
        A dashboard is global when it doesn't display information from a project but rather more general information.

        Before version 3.1 no dashboard was global.

        Since version 6.1, project dashboards are dropped. Project dashboards (global=false) are ignored.

        Since:
        3.1

      • setGlobal

        public Dashboard setGlobal​(boolean global)
        Deprecated.
        A dashboard is global when it doesn't display information from a project but rather more general information.

        Before version 3.1 no dashboard was global.

        Since version 6.1, project dashboards are dropped. Project dashboards (global=false) are ignored.

        Since:
        3.1

      • isActivated

        public boolean isActivated()
        Deprecated.
        A dashboard can be activated for all anonymous users or users who haven't configured their own dashboards.

        Before version 3.1 every dashboard created through this extension point was automatically activated. This is still the default behavior.

        Since:
        3.1

      • setActivated

        public Dashboard setActivated​(boolean activated)
        Deprecated.
        Set whether the dashboard is activated for all anonymous users or users who haven't configured their own dashboards.
        Since:
        3.1