src/jalview/api/AlignViewControllerGuiI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.api;
  22
  23 import jalview.commands.CommandI;
  24 import jalview.schemes.ColourSchemeI;
  25
  26 /**
  27  * Interface implemented by gui implementations managing a Jalview Alignment
  28  * View
  29  *
  30  * @author jimp
  31  *
  32  */
  33 public interface AlignViewControllerGuiI
  34 {
  35
  36   /**
  37    * display the given string in the GUI's status bar
  38    *
  39    * @param string
  40    */
  41   void setStatus(String string);
  42
  43   void addHistoryItem(CommandI command);
  44
  45   void setShowSeqFeatures(boolean show);
  46
  47   void setMenusForViewport();
  48
  49   void changeColour(ColourSchemeI cs);
  50
  51   /**
  52    * trigger an update of the UI in response to a model data change, and if
  53    * necessary enable the display of sequence feature annotation on the view.
  54    *
  55    * @param enableIfNecessary
  56    */
  57   void refreshFeatureUI(boolean enableIfNecessary);
  58
  59   /**
  60    * get the Feature Settings control panel for the alignment view if one exists
  61    *
  62    * @return
  63    */
  64   FeatureSettingsControllerI getFeatureSettingsUI();
  65
  66   /**
  67    * displays the Feature Settigns control panel for the alignment view - if one
  68    * exists it is closed and re-opened.
  69    *
  70    * @return the current feature settings controller
  71    */
  72   FeatureSettingsControllerI showFeatureSettingsUI();
  73 }