source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * Sonar, open source software quality management tool.
   3  * Copyright (C) 2008-2012 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * Sonar is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * Sonar is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with Sonar; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
  19  */
  20 package org.sonar.plugins.core.dashboards;
  21
  22 import org.sonar.plugins.core.widgets.FilterWidget;
  23
  24 import org.sonar.api.web.Dashboard.Widget;
  25
  26 import org.sonar.api.web.Dashboard;
  27 import org.sonar.api.web.DashboardLayout;
  28 import org.sonar.api.web.DashboardTemplate;
  29
  30 /**
  31  * Base class for global dashboard containing a single
  32  * filter widget.
  33  *
  34  * @since 3.1
  35  */
  36 abstract class AbstractFilterDashboard extends DashboardTemplate {
  37   protected abstract String getFilterKey();
  38
  39   @Override
  40   public Dashboard createDashboard() {
  41     Dashboard dashboard = Dashboard.create()
  42         .setGlobal(true)
  43         .setLayout(DashboardLayout.ONE_COLUMN);
  44
  45     Widget filterWidget = dashboard.addWidget("filter", 1)
  46         .setProperty(FilterWidget.FILTER, getFilterKey());
  47
  48     return dashboard;
  49   }
  50 }