All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.api.web.PageDecoration Maven / Gradle / Ivy

There is a newer version: 5.1
Show newest version
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.web;

import org.sonar.api.ServerExtension;

/**
 * Adds content to HTML pages. A PageDecoration is a Rails template (html.erb file) that executes content_for blocks on predefined locations :
 * 
    *
  • script : javascript header
  • *
  • style : CSS header
  • *
  • header : area over the black top navigation bar
  • *
  • footer : area below the main page
  • *
  • sidebar : area in the sidebar between the menu and the sonar logo
  • *
* *

Example of template:

 <% content_for :script do %>
   
 <% end %>

 <% content_for :footer do %>
  
this is my footer
<% end %>
* * @since 3.3 */ public abstract class PageDecoration extends AbstractRubyTemplate implements ServerExtension { }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy