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 import java.awt.Rectangle;
  27
  28 /**
  29  * Interface implemented by gui implementations managing a Jalview Alignment
  30  * View
  31  *
  32  * @author jimp
  33  *
  34  */
  35 public interface AlignViewControllerGuiI
  36 {
  37
  38   /**
  39    * display the given string in the GUI's status bar
  40    *
  41    * @param string
  42    */
  43   void setStatus(String string);
  44
  45   void addHistoryItem(CommandI command);
  46
  47   void setShowSeqFeatures(boolean show);
  48
  49   void setMenusForViewport();
  50
  51   void changeColour(ColourSchemeI cs);
  52
  53   /**
  54    * trigger an update of the UI in response to a model data change, and if
  55    * necessary enable the display of sequence feature annotation on the view.
  56    *
  57    * @param enableIfNecessary
  58    */
  59   void refreshFeatureUI(boolean enableIfNecessary);
  60
  61   /**
  62    * get the Feature Settings control panel for the alignment view if one exists
  63    *
  64    * @return
  65    */
  66   FeatureSettingsControllerI getFeatureSettingsUI();
  67
  68   /**
  69    * displays the Feature Settigns control panel for the alignment view - if one
  70    * exists it is closed and re-opened.
  71    *
  72    * @return the current feature settings controller
  73    */
  74   FeatureSettingsControllerI showFeatureSettingsUI();
  75
  76   /**
  77    * record the last position of a feature settings dialog before it was closed
  78    *
  79    * @param bounds
  80    */
  81   void setFeatureSettingsGeometry(Rectangle bounds);
  82
  83   /**
  84    *
  85    * @return last position of feature settings for this alignment view GUI
  86    */
  87   Rectangle getFeatureSettingsGeometry();
  88 }