JAL-3676 Documentation in Help for Java Console, Logging and Reporting Bugs
[jalview.git] / src / jalview / renderer / AwtRenderPanelI.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.renderer;
22
23 import java.awt.FontMetrics;
24 import java.awt.Image;
25 import java.awt.image.ImageObserver;
26
27 /**
28  * semi-insulated interface for rendering a faded image whilst a calculation is
29  * in progress on annotation panel. Will need to remove java.awt dependencies
30  * for Android/etc
31  * 
32  * @author jprocter
33  *
34  */
35 public interface AwtRenderPanelI extends ImageObserver
36 {
37   /**
38    * old image used when data is currently being calculated and cannot be
39    * rendered
40    */
41   Image getFadedImage();
42
43   /**
44    * FontMetrics to use for rendering into Panel
45    * 
46    * @return
47    */
48   FontMetrics getFontMetrics();
49
50   /**
51    * width of image to render in panel
52    */
53   int getFadedImageWidth();
54
55   /**
56    * height of visible area on to the image - used to draw only what is visible.
57    * 
58    * @return [start, end of visible region]
59    */
60   int[] getVisibleVRange();
61
62 }