001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube 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 * SonarQube 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 License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.web;
021
022/**
023 * Possible layouts for a dashboard.
024 *
025 * @since 2.13
026 */
027public enum DashboardLayout {
028
029  /**
030   * Only 1 column that take all the page
031   */
032  ONE_COLUMN("100%", 1),
033
034  /**
035   * 2 columns of the same width
036   */
037  TWO_COLUMNS("50%-50%", 2),
038
039  /**
040   * 2 columns with the first one smaller than the second
041   */
042  TWO_COLUMNS_30_70("30%-70%", 2),
043
044  /**
045   * 2 columns with the first one bigger than the second
046   */
047  TWO_COLUMNS_70_30("70%-30%", 2),
048
049  /**
050   * 3 columns of the same width
051   */
052  TREE_COLUMNS("33%-33%-33%", 3);
053
054  private String code;
055  private int columns;
056
057  private DashboardLayout(String code, int columns) {
058    this.code = code;
059    this.columns = columns;
060  }
061
062  public String getCode() {
063    return code;
064  }
065
066  public int getColumns() {
067    return columns;
068  }
069
070  @Override
071  public String toString() {
072    return code;
073  }
074
075}