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  *
  26  * @author jimp
  27  *
  28  *         All operations should return true if the view has changed as a result
  29  *         of the operation
  30  * @param <ViewportI>
  31  *
  32  */
  33 public interface AlignViewControllerI<ViewportI>
  34 {
  35
  36   public boolean makeGroupsFromSelection();
  37
  38   public boolean createGroup();
  39
  40   public boolean unGroup();
  41
  42   public boolean deleteGroups();
  43
  44   public void setViewportAndAlignmentPanel(AlignViewportI viewport,
  45           AlignmentViewPanel alignPanel);
  46
  47   /**
  48    * Mark columns in the current column selection according to positions of
  49    * sequence features
  50    *
  51    * @param invert
  52    *          - when set, mark all but columns containing given type
  53    * @param extendCurrent
  54    *          - when set, do not clear existing column selection
  55    * @param toggle
  56    *          - rather than explicitly set, toggle selection state
  57    * @param featureType
  58    *          - feature type string
  59    * @return true if operation affected state
  60    */
  61   boolean markColumnsContainingFeatures(boolean invert,
  62           boolean extendCurrent, boolean clearColumns, String featureType);
  63
  64 }