src/jalview/structure/CommandListener.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   3  * Copyright (C) 2015 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.structure;
  22
  23 import jalview.commands.CommandI;
  24
  25 /**
  26  * Defines a listener for commands performed on another alignment. This is to
  27  * support linked editing of two alternative representations of an alignment (in
  28  * particular, cDNA and protein).
  29  *
  30  * @author gmcarstairs
  31  *
  32  */
  33 public interface CommandListener
  34 {
  35   /**
  36    * The listener may attempt to perform the specified command; the region acted
  37    * on is determined by a callback to the StructureSelectionManager (which
  38    * holds mappings between alignments).
  39    *
  40    * @param command
  41    * @param undo
  42    * @param ssm
  43    * @param source
  44    *          the originator of the command
  45    */
  46   public void mirrorCommand(CommandI command, boolean undo,
  47           StructureSelectionManager ssm, VamsasSource source);
  48
  49   /**
  50    * Temporary workaround to make check for source == listener work.
  51    *
  52    * @return
  53    */
  54   public VamsasSource getVamsasSource();
  55 }