src/jalview/api/AlignViewControllerI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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 /**
  24  * prototype abstract controller for a Jalview alignment view
  25  * @author jimp
  26  *
  27  * All operations should return true if the view has changed as a result of the operation
  28  * @param <ViewportI>
  29  *
  30  */
  31 public interface AlignViewControllerI<ViewportI>
  32 {
  33
  34   public boolean makeGroupsFromSelection();
  35
  36   public boolean createGroup();
  37
  38   public boolean unGroup();
  39
  40   public boolean deleteGroups();
  41
  42   public void setViewportAndAlignmentPanel(AlignViewportI viewport, AlignmentViewPanel alignPanel);
  43
  44   /**
  45    * Mark columns in the current column selection according to positions of sequence features
  46    * @param invert - when set, mark all but columns containing given type
  47    * @param extendCurrent - when set, do not clear existing column selection
  48    * @param toggle - rather than explicitly set, toggle selection state
  49    * @param featureType - feature type string
  50    * @return true if operation affected state
  51    */
  52   boolean markColumnsContainingFeatures(boolean invert, boolean extendCurrent, boolean clearColumns, String featureType);
  53
  54 }