jalview/api/AlignExportSettingI.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
  22 package jalview.api;
  23
  24 /**
  25  * Abstract interface implemented by Alignment Export dialog to retrieve user
  26  * configurations
  27  *
  28  * @author tcnofoegbu
  29  *
  30  */
  31 public interface AlignExportSettingI
  32 {
  33   /**
  34    * Checks if hidden sequences should be exported
  35    *
  36    * @return
  37    */
  38   public boolean isExportHiddenSequences();
  39
  40   /**
  41    * Checks if hidden columns shoulb be exported
  42    *
  43    * @return
  44    */
  45   public boolean isExportHiddenColumns();
  46
  47   /**
  48    * Checks if Annotations should be exported, note this is available for
  49    * complex flat file exports like JSON, HTML, GFF
  50    *
  51    * @return
  52    */
  53   public boolean isExportAnnotations();
  54
  55   /**
  56    * Checks if SequenceFeatures should be exported, note this is available for
  57    * complex flat file exports like JSON, HTML, GFF
  58    *
  59    * @return
  60    */
  61   public boolean isExportFeatures();
  62
  63   /**
  64    * Checks if SequenceGroups should be exported, note this is available for
  65    * complex flat file exports like JSON, HTML, GFF
  66    *
  67    * @return
  68    */
  69   public boolean isExportGroups();
  70
  71   public boolean isCancelled();
  72
  73 }