From 26c891db22bb89bfc022529a8b698148a24ab59b Mon Sep 17 00:00:00 2001
From: Fabrice Bellingard <fabrice.bellingard@sonarsource.com>
Date: Fri, 11 Jan 2013 17:23:34 +0100
Subject: [PATCH] SONAR-4025 Add filter description to filter widget

---
 .../plugins/core/widgets/MeasureFilterListWidget.java      | 4 +++-
 .../plugins/core/widgets/MeasureFilterTreemapWidget.java   | 5 ++++-
 .../plugins/core/widgets/measure_filter_list.html.erb      | 7 +++++++
 .../plugins/core/widgets/measure_filter_treemap.html.erb   | 7 +++++++
 4 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterListWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterListWidget.java
index a551f35d74e..3376cf91031 100644
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterListWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterListWidget.java
@@ -31,11 +31,13 @@ import static org.sonar.api.web.WidgetScope.GLOBAL;
 @WidgetScope(GLOBAL)
 @WidgetProperties({
   @WidgetProperty(key = MeasureFilterListWidget.FILTER_PROPERTY, type = WidgetPropertyType.FILTER, optional = false),
-  @WidgetProperty(key = MeasureFilterListWidget.PAGE_SIZE_PROPERTY, type = WidgetPropertyType.INTEGER, defaultValue = "30")
+  @WidgetProperty(key = MeasureFilterListWidget.PAGE_SIZE_PROPERTY, type = WidgetPropertyType.INTEGER, defaultValue = "30"),
+  @WidgetProperty(key = MeasureFilterListWidget.DISPLAY_FILTER_DESCRIPTION, type = WidgetPropertyType.BOOLEAN, defaultValue = "false")
 })
 public class MeasureFilterListWidget extends CoreWidget {
   public static final String FILTER_PROPERTY = "filter";
   public static final String PAGE_SIZE_PROPERTY = "pageSize";
+  public static final String DISPLAY_FILTER_DESCRIPTION = "displayFilterDescription";
   public static final String ID = "measure_filter_list";
 
   public MeasureFilterListWidget() {
diff --git a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterTreemapWidget.java b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterTreemapWidget.java
index 267b5b48573..6bf98555097 100644
--- a/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterTreemapWidget.java
+++ b/plugins/sonar-core-plugin/src/main/java/org/sonar/plugins/core/widgets/MeasureFilterTreemapWidget.java
@@ -33,13 +33,16 @@ import static org.sonar.api.web.WidgetScope.GLOBAL;
   @WidgetProperty(key = MeasureFilterTreemapWidget.FILTER_PROPERTY, type = WidgetPropertyType.FILTER, optional = false),
   @WidgetProperty(key = MeasureFilterTreemapWidget.SIZE_METRIC_PROPERTY, type = WidgetPropertyType.METRIC, optional = true),
   @WidgetProperty(key = MeasureFilterTreemapWidget.COLOR_METRIC_PROPERTY, type = WidgetPropertyType.METRIC, optional = true, options = "type:PERCENT"),
-  @WidgetProperty(key = MeasureFilterTreemapWidget.HEIGHT_PERCENTS_PROPERTY, type = WidgetPropertyType.INTEGER, optional = true, defaultValue = "55", description = "Height in percents of width")
+  @WidgetProperty(key = MeasureFilterTreemapWidget.HEIGHT_PERCENTS_PROPERTY, type = WidgetPropertyType.INTEGER, optional = true, defaultValue = "55",
+    description = "Height in percents of width"),
+  @WidgetProperty(key = MeasureFilterListWidget.DISPLAY_FILTER_DESCRIPTION, type = WidgetPropertyType.BOOLEAN, defaultValue = "false")
 })
 public class MeasureFilterTreemapWidget extends CoreWidget {
   public static final String FILTER_PROPERTY = "filter";
   public static final String SIZE_METRIC_PROPERTY = "sizeMetric";
   public static final String COLOR_METRIC_PROPERTY = "colorMetric";
   public static final String HEIGHT_PERCENTS_PROPERTY = "heightInPercents";
+  public static final String DISPLAY_FILTER_DESCRIPTION = "displayFilterDescription";
   public static final String ID = "measure_filter_treemap";
 
   public MeasureFilterTreemapWidget() {
diff --git a/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_list.html.erb b/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_list.html.erb
index 7ec7a3bbe7b..c0e810f71d9 100644
--- a/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_list.html.erb
+++ b/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_list.html.erb
@@ -10,6 +10,13 @@
        filter.execute(self, :user => current_user)
        @widget_title = link_to h(filter.name), {:controller => 'measures', :action => 'filter', :id => filter.id, :display => 'list'}
 %>
+
+  <% if widget_properties['displayFilterDescription'] && !filter.description.blank? %>
+    <div style="padding-bottom: 5px">
+      <span class="note"><%= h filter.description -%></span>
+    </div>
+  <% end %>
+
     <%= render :partial => "measures/display_#{filter.display.key}", :locals => {:edit_mode => false, :filter => filter, :widget_id => widget.id} -%>
 <%
      end
diff --git a/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_treemap.html.erb b/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_treemap.html.erb
index 259ed662c38..4cf3eb1ae50 100644
--- a/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_treemap.html.erb
+++ b/plugins/sonar-core-plugin/src/main/resources/org/sonar/plugins/core/widgets/measure_filter_treemap.html.erb
@@ -23,6 +23,13 @@
 
        @widget_title = link_to h(filter.name), url_options
 %>
+
+  <% if widget_properties['displayFilterDescription'] && !filter.description.blank? %>
+    <div style="padding-bottom: 5px">
+      <span class="note"><%= h filter.description -%></span>
+    </div>
+  <% end %>
+
     <%= render :partial => "measures/display_#{filter.display.key}", :locals => {:edit_mode => false, :widget_id => widget.id, :filter => filter} %>
 <%
      end
-- 
2.39.5