JAL-2089 patch broken merge to master for Release 2.10.0b1

[jalview.git] / src / jalview / renderer / AwtRenderPanelI.java

diff --git a/src/jalview/renderer/AwtRenderPanelI.java b/src/jalview/renderer/AwtRenderPanelI.java
index 70bbc7b..b86afbc 100644 (file)
--- a/src/jalview/renderer/AwtRenderPanelI.java
+++ b/src/jalview/renderer/AwtRenderPanelI.java
@@ -1,19 +1,22 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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 <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.renderer;
 
@@ -21,6 +24,14 @@ import java.awt.FontMetrics;
 import java.awt.Image;
 import java.awt.image.ImageObserver;
 
+/**
+ * semi-insulated interface for rendering a faded image whilst a calculation is
+ * in progress on annotation panel. Will need to remove java.awt dependencies
+ * for Android/etc
+ * 
+ * @author jprocter
+ *
+ */
 public interface AwtRenderPanelI extends ImageObserver
 {
   /**
@@ -41,4 +52,11 @@ public interface AwtRenderPanelI extends ImageObserver
    */
   int getFadedImageWidth();
 
+  /**
+   * height of visible area on to the image - used to draw only what is visible.
+   * 
+   * @return [start, end of visible region]
+   */
+  int[] getVisibleVRange();
+
 }