001/* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2012 SonarSource 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 */ 020package org.sonar.api.workflow.screen; 021 022import com.google.common.annotations.Beta; 023 024/** 025 * <h2>Localization</h2> 026 * <p>At least two buttons must have labels :</p> 027 * <ul> 028 * <li>the button in the violation toolbar that displays the form screen. Key is 'reviews.command.<command_key>.button'.</li> 029 * <li>the button in the form screen that submits the command. Key is 'reviews.command.<command_key>.submit'.</li> 030 * </ul> 031 * @since 3.1 032 */ 033@Beta 034public abstract class Screen { 035 private final String key; 036 private String commandKey; 037 038 protected Screen(String key) { 039 this.key = key; 040 } 041 042 public final String getKey() { 043 return key; 044 } 045 046 public final String getCommandKey() { 047 return commandKey; 048 } 049 050 public final Screen setCommandKey(String commandKey) { 051 this.commandKey = commandKey; 052 return this; 053 } 054}