X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2FSequenceStructureBinding.java;h=91ee9cc7b8a342fba6d2e7d3bfd3409e66b2cab1;hb=7596cd64543481df859a9bd2e73a3b3bb6b2e42c;hp=e95f047dfd38a14d184726ebb49c28ecf817c2cf;hpb=153dd62dc91da13ae732600e6ea55ddbe15eab39;p=jalview.git diff --git a/src/jalview/api/SequenceStructureBinding.java b/src/jalview/api/SequenceStructureBinding.java index e95f047..91ee9cc 100644 --- a/src/jalview/api/SequenceStructureBinding.java +++ b/src/jalview/api/SequenceStructureBinding.java @@ -1,29 +1,51 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) - * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - * + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.api; /** - * methods for interacting with the binding between a structure visualization and one or more Jalview views. - * @author JimP - * prototype class - this may disappear ! + * methods for interacting with the binding between a structure visualization + * and one or more Jalview views. + * + * @author JimP prototype class - this may disappear ! */ public interface SequenceStructureBinding { - // todo: decide what this really means - we could return a reference to the alignment/jmol binding, or some other binding. + /** + * + * @return true if Jalview or the Viewer is still restoring state or loading + * is still going on (see setFinishedLoadingFromArchive) + */ + void setLoadingFromArchive(boolean loadingFromArchive); + + boolean isLoadingFromArchive(); + + /** + * modify flag which controls if sequence colouring events are honoured by the + * binding. Should be true for normal operation + * + * @param finishedLoading + */ + void setFinishedLoadingFromArchive(boolean finishedLoading); + + boolean isLoadingFinished(); + }