X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fapi%2Fstructures%2FJalviewStructureDisplayI.java;h=77f2b6d69f74686a1506b507f68bd3c67bb03087;hb=1140532d01b32b648e7e5b17ea717ae790625f8f;hp=69d08fa8fb43c8c6e5e46a2b9e92a12313a9114f;hpb=0ca159283d6fdd7b76b033421393209ee8c0c8a8;p=jalview.git

diff --git a/src/jalview/api/structures/JalviewStructureDisplayI.java b/src/jalview/api/structures/JalviewStructureDisplayI.java
index 69d08fa..77f2b6d 100644
--- a/src/jalview/api/structures/JalviewStructureDisplayI.java
+++ b/src/jalview/api/structures/JalviewStructureDisplayI.java
@@ -20,10 +20,15 @@
  */
 package jalview.api.structures;
 
+import java.io.File;
+import java.util.Collections;
+import java.util.List;
+
 import jalview.api.AlignmentViewPanel;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
-import jalview.schemes.ColourSchemeI;
+import jalview.gui.AlignmentPanel;
+import jalview.gui.StructureViewer;
 import jalview.structures.models.AAStructureBindingModel;
 
 public interface JalviewStructureDisplayI
@@ -59,11 +64,9 @@ public interface JalviewStructureDisplayI
   void closeViewer(boolean closeExternalViewer);
 
   /**
-   * apply a colourscheme to the structures in the viewer
-   * 
-   * @param colourScheme
+   * Check if the external viewer is still running
    */
-  void setJalviewColourScheme(ColourSchemeI colourScheme);
+  boolean stillRunning();
 
   /**
    * 
@@ -72,12 +75,131 @@ public interface JalviewStructureDisplayI
    */
   boolean hasMapping();
 
-  // construction method - move to another interface ?
+  /**
+   * Checks if the PDB file is already loaded in this viewer, if so just adds
+   * mappings as necessary and answers true, else answers false. This supports
+   * the use case of adding additional chains of the same structure to a viewer.
+   * 
+   * @param seq
+   * @param chains
+   * @param apanel
+   * @param pdbId
+   * @return
+   */
   boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
           AlignmentViewPanel apanel, String pdbId);
 
-  // construction method - move to another interface ?
-  boolean addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
+  /**
+   * Adds one or more chains (sequences) of a PDB structure to this structure
+   * viewer
+   * 
+   * @param pdbentry
+   * @param seq
+   * @param chains
+   * @param apanel
+   * @param pdbId
+   * @return
+   */
+  void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
           String[] chains, AlignmentViewPanel apanel, String pdbId);
 
+  /**
+   * refresh GUI after reconfiguring structure(s) and alignment panels
+   */
+  void updateTitleAndMenus();
+
+  /**
+   * Answers true if the viewer should attempt to align any added structures,
+   * else false
+   * 
+   * @return
+   */
+  boolean isAlignAddedStructures();
+
+  /**
+   * Sets the flag for whether added structures should be aligned
+   * 
+   * @param alignAdded
+   */
+  void setAlignAddedStructures(boolean alignAdded);
+
+  /**
+   * Raise the panel to the top of the stack...
+   */
+  void raiseViewer();
+
+  AlignmentViewPanel getAlignmentPanel();
+
+  /**
+   * Answers true if the given alignment view is used to colour structures by
+   * sequence, false if not
+   * 
+   * @param ap
+   * @return
+   */
+  boolean isUsedForColourBy(AlignmentViewPanel ap);
+
+  /**
+   * If implemented, shows a command line console in the structure viewer
+   * 
+   * @param show
+   *          true to show, false to hide
+   */
+  void showConsole(boolean show);
+
+  /**
+   * Remove references to the given alignment view for this structure viewer
+   * 
+   * @param avp
+   */
+  void removeAlignmentPanel(AlignmentViewPanel avp);
+
+  /**
+   * Updates the progress bar if there is one. Call stopProgressBar with the
+   * returned handle to remove the message.
+   * 
+   * @param msg
+   * @return handle
+   */
+  long startProgressBar(String msg);
+
+  /**
+   * Ends the progress bar with the specified handle, leaving a message (if not
+   * null) on the status bar
+   * 
+   * @param msg
+   * @param handle
+   */
+  void stopProgressBar(String msg, long handle);
+
+  /**
+   * 
+   * @return true if the actions menu is shown for this viewer
+   */
+  boolean hasViewerActionsMenu();
+
+  String getViewId();
+
+  StructureViewer.ViewerType getViewerType();
+
+  boolean isUsedforaligment(AlignmentViewPanel ap);
+
+  boolean isColouredByViewer();
+
+  int getHeight();
+
+  int getWidth();
+
+  int getY();
+
+  File saveSession();
+
+  /**
+   * 
+   * @return heteroatoms in a form suitable for display and passing to command generator to display hetatms
+   */
+  default List<String> getHetatms() {
+    return Collections.EMPTY_LIST;
+  }
+
 }