src/jalview/structures/models/SequenceStructureBindingModel.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.structures.models;
  22
  23 import jalview.api.SequenceStructureBinding;
  24
  25 public class SequenceStructureBindingModel
  26         implements SequenceStructureBinding
  27 {
  28
  29   /**
  30    * set if Structure Viewer state is being restored from some source -
  31    * instructs binding not to apply default display style when structure set is
  32    * updated for first time.
  33    */
  34   private boolean loadingFromArchive = false;
  35
  36   /**
  37    * second flag to indicate if the Structure viewer should ignore sequence
  38    * colouring events from the structure manager because the GUI is still
  39    * setting up
  40    */
  41   private boolean loadingFinished = true;
  42
  43   @Override
  44   public void setLoadingFromArchive(boolean loadingFromArchive)
  45   {
  46     this.loadingFromArchive = loadingFromArchive;
  47   }
  48
  49   /**
  50    *
  51    * @return true if viewer is still restoring state or loading is still going
  52    *         on (see setFinishedLoadingFromArchive)
  53    */
  54   @Override
  55   public boolean isLoadingFromArchive()
  56   {
  57     return loadingFromArchive && !loadingFinished;
  58   }
  59
  60   @Override
  61   public boolean isLoadingFinished()
  62   {
  63     return loadingFinished;
  64   }
  65
  66   @Override
  67   public void setFinishedLoadingFromArchive(boolean finishedLoading)
  68   {
  69     loadingFinished = finishedLoading;
  70   }
  71
  72 }