001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2009 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.api.web; 021 022 import org.sonar.api.ServerExtension; 023 024 /** 025 * Widget in project dashboard. 026 * <p/> 027 * Template is written in Ruby on Rails, so ERB snippets can be injected in HTML. Example : <%= my ruby code -%>. 028 * <a href="http://svn.sonar.codehaus.org/browse/sonar/trunk/tests/integration/extensions/plugin-sample/src/main/resources/sample/dashboardwidget/sample_dashboard_widget.erb?r=trunk">Example</a><br/> 029 * <br/> 030 * It's recommended to extend <code>org.sonar.api.web.AbstractDashboardWidget</code> for performance reasons. 031 * Template is cached in memory. 032 * 033 * @since 1.10 034 * @deprecated use org.sonar.api.web.RubyRailsWidget, better because of optional conditions (see annotations in org.sonar.api.web.views package) 035 */ 036 @Deprecated 037 public interface DashboardWidget extends ServerExtension { 038 039 /** 040 * @return content of the Ruby on Rails template 041 */ 042 String getTemplate(); 043 044 }