src/jalview/api/AlignmentViewPanel.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.datamodel.AlignmentI;
  24 import jalview.structure.StructureSelectionManager;
  25
  26 /**
  27  * abstract interface implemented by alignment panels holding an alignment view
  28  *
  29  * @author JimP
  30  *
  31  */
  32 public interface AlignmentViewPanel extends OOMHandlerI
  33 {
  34
  35   AlignViewportI getAlignViewport();
  36
  37   AlignmentI getAlignment();
  38
  39   StructureSelectionManager getStructureSelectionManager();
  40
  41   /**
  42    * repaint the alignment view after a datamodel update.
  43    *
  44    * @param updateOverview
  45    *          - if true, the overview panel will also be updated and repainted
  46    * @param updateStructures
  47    *          - if true then any linked structure views will also be updated
  48    */
  49   void paintAlignment(boolean updateOverview, boolean updateStructures);
  50
  51   /**
  52    * automatically adjust annotation panel height for new annotation whilst
  53    * ensuring the alignment is still visible.
  54    */
  55   void adjustAnnotationHeight();
  56
  57   FeatureRenderer getFeatureRenderer();
  58
  59   FeatureRenderer cloneFeatureRenderer();
  60
  61   /**
  62    *
  63    * @return displayed name for the view
  64    */
  65   String getViewName();
  66 }