JAL-1953 moved now-generic methods outside of Aptx package
[jalview.git] / src / jalview / ext / archaeopteryx / AptxFrame.java
1 package jalview.ext.archaeopteryx;
2
3 import jalview.bin.Cache;
4 import jalview.ext.treeviewer.TreeControlsI;
5 import jalview.ext.treeviewer.TreeFrameI;
6 import jalview.ext.treeviewer.TreeI;
7 import jalview.ext.treeviewer.TreePanelI;
8 import jalview.ext.treeviewer.TreeViewerUtils;
9 import jalview.gui.Desktop;
10 import jalview.gui.EPSOptions;
11 import jalview.io.JalviewFileChooser;
12 import jalview.io.JalviewFileView;
13 import jalview.util.ImageMaker;
14 import jalview.util.MessageManager;
15
16 import java.awt.Component;
17 import java.awt.Container;
18 import java.awt.Dimension;
19 import java.awt.Event;
20 import java.awt.Font;
21 import java.awt.Image;
22 import java.awt.MenuComponent;
23 import java.awt.event.ActionEvent;
24 import java.awt.event.ActionListener;
25 import java.io.FileOutputStream;
26
27 import javax.accessibility.AccessibleContext;
28 import javax.swing.JLayeredPane;
29 import javax.swing.JMenu;
30 import javax.swing.JMenuBar;
31 import javax.swing.JMenuItem;
32 import javax.swing.JRootPane;
33 import javax.swing.JSeparator;
34 import javax.swing.event.InternalFrameListener;
35
36 import org.forester.archaeopteryx.Archaeopteryx;
37 import org.forester.archaeopteryx.Configuration;
38 import org.forester.archaeopteryx.MainFrame;
39 import org.forester.phylogeny.Phylogeny;
40 import org.jibble.epsgraphics.EpsGraphics2D;
41
42 public class AptxFrame implements TreeFrameI
43 {
44   private final MainFrame aptxFrame;
45
46   private TreePanelI aptxPanel;
47
48   private TreeControlsI aptxControls;
49
50
51   public AptxFrame(Phylogeny tree, Configuration aptxConfig,
52           String treeTitle)
53   {
54     this(Archaeopteryx.createApplication(tree,
55             aptxConfig,
56             treeTitle));
57
58   }
59
60
61   public AptxFrame(MainFrame aptx)
62   {
63
64     aptxFrame = aptx;
65     aptxPanel = new AptxTreePanel(
66             aptxFrame.getMainPanel().getCurrentTreePanel());
67     aptxControls = new AptxControlPanel(
68             aptxFrame.getMainPanel().getControlPanel());
69     adaptAptxGui(aptxFrame);
70
71   }
72   
73   /**
74    * Hides certain redundant Archaeopteryx GUI elements such as the menu items
75    * for reading in trees and adds extra items related to Jalview such as the
76    * tree sorting menu item.
77    * 
78    * 
79    * @param aptxFrame
80    */
81   protected void adaptAptxGui(MainFrame aptxFrame)
82   {
83     JMenuBar frameBar = aptxFrame.getJMenuBar();
84     boolean epsAdded = false;
85     for (int i = 0; i < frameBar.getMenuCount();i++) {
86       JMenu menu = frameBar.getMenu(i);
87       int menuCount = menu.getMenuComponentCount();
88
89       if (menu.getText().contains("File"))
90       {
91         // hide all "Read from ..." and "New" menu items and any Separators that
92         // come directly after them
93         Component previousComp = null;
94         for (int x = 0; x < menuCount; x++)
95         {
96           Component menuItem = menu.getMenuComponent(x);
97           if (previousComp instanceof JMenuItem)
98           {
99             JMenuItem previousMenuItem = (JMenuItem) previousComp;
100             if (previousMenuItem.getText().startsWith("Read")
101                     || previousMenuItem.getText()
102                             .startsWith("New")
103                     || previousMenuItem.getText()
104                             .startsWith("Close Tab"))
105             {
106               previousComp.setVisible(false);
107
108               if (menuItem instanceof JSeparator)
109               {
110                 menuItem.setVisible(false);
111               }
112
113             }
114
115             if ((!epsAdded) && previousMenuItem.getText()
116                     .startsWith("Export to"))
117             {
118               JMenuItem exportEps = new JMenuItem("Export to EPS file...");
119               menu.add(exportEps, x);
120               exportEps.addActionListener(new ActionListener()
121               {
122
123                 @Override
124                 public void actionPerformed(ActionEvent e)
125                 {
126                   epsTree_actionPerformed(e);
127
128                 }
129                 
130               });
131               epsAdded = true;
132
133             }
134           }
135           previousComp = menuItem;
136         }
137       }
138       else if (menu.getText().contains("Inference"))
139       {
140         menu.setVisible(false);
141       }
142       else if (menu.getText().contains("View"))
143       {
144         menu.addSeparator();
145         JMenuItem sortByTree = new JMenuItem("Sort alignment by tree");
146         JMenuItem refreshJalview = new JMenuItem(
147                 "Filter alignment to show only currently visible sequences");
148
149         refreshJalview.setFont(menu.getFont());
150
151         menu.add(sortByTree);
152         menu.add(refreshJalview);
153
154         sortByTree.setFont(menu.getFont());
155         refreshJalview
156                 .addActionListener(TreeViewerUtils.getActiveTreeViews().get(this));
157
158
159       }
160
161     }
162     // aptxFrame.validate();
163   }
164
165   public void epsTree_actionPerformed(ActionEvent e)
166   {
167     boolean accurateText = true;
168
169     String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
170             "Prompt each time");
171
172     // If we need to prompt, and if the GUI is visible then
173     // Prompt for EPS rendering style
174     if (renderStyle.equalsIgnoreCase("Prompt each time")
175             && !(System.getProperty("java.awt.headless") != null && System
176                     .getProperty("java.awt.headless").equals("true")))
177     {
178       EPSOptions eps = new EPSOptions();
179       renderStyle = eps.getValue();
180
181       if (renderStyle == null || eps.cancelled)
182       {
183         return;
184       }
185
186     }
187
188     if (renderStyle.equalsIgnoreCase("text"))
189     {
190       accurateText = false;
191     }
192
193     int width = getTreePanel().getWidth();
194     int height = getTreePanel().getHeight();
195
196     try
197     {
198       JalviewFileChooser chooser = new JalviewFileChooser(
199               ImageMaker.EPS_EXTENSION, ImageMaker.EPS_EXTENSION);
200       chooser.setFileView(new JalviewFileView());
201       chooser.setDialogTitle(
202               MessageManager.getString("label.create_eps_from_tree"));
203       chooser.setToolTipText(MessageManager.getString("action.save"));
204
205       int value = chooser.showSaveDialog(aptxFrame);
206
207       if (value != JalviewFileChooser.APPROVE_OPTION)
208       {
209         return;
210       }
211
212       Cache.setProperty("LAST_DIRECTORY",
213               chooser.getSelectedFile().getParent());
214
215       FileOutputStream out = new FileOutputStream(
216               chooser.getSelectedFile());
217       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
218               height);
219
220       pg.setAccurateTextMode(accurateText);
221
222       getTreePanel().paintToFile(pg, width, height);
223
224       pg.flush();
225       pg.close();
226     } catch (Exception ex)
227     {
228       ex.printStackTrace();
229     }
230   }
231   @Override
232   public TreePanelI getTreePanel()
233   {
234     return aptxPanel;
235   }
236
237   @Override
238   public TreeI getTree()
239   {
240     return aptxPanel.getTree();
241   }
242
243   @Override
244   public void checkMultipleTrees()
245   {
246     aptxFrame.activateSaveAllIfNeeded();
247
248   }
249
250   @Override
251   public int getNumberOfTrees()
252   {
253     return aptxFrame.getMainPanel().getTabbedPane().getTabCount();
254   }
255
256   @Override
257   public TreeControlsI getTreeControls()
258   {
259     return aptxControls;
260   }
261
262   @Override
263   public AccessibleContext getAccessibleContext()
264   {
265     return aptxFrame.getAccessibleContext();
266   }
267
268   @Override
269   public JRootPane getRootPane()
270   {
271     return aptxFrame.getRootPane();
272   }
273
274   @Override
275   public void setContentPane(Container contentPane)
276   {
277     aptxFrame.setContentPane(contentPane);
278
279   }
280
281   @Override
282   public Container getContentPane()
283   {
284     return aptxFrame.getContentPane();
285   }
286
287   @Override
288   public void setLayeredPane(JLayeredPane layeredPane)
289   {
290     aptxFrame.setLayeredPane(layeredPane);
291
292   }
293
294   @Override
295   public JLayeredPane getLayeredPane()
296   {
297     return aptxFrame.getLayeredPane();
298   }
299
300   @Override
301   public void setGlassPane(Component glassPane)
302   {
303     aptxFrame.setGlassPane(glassPane);
304
305   }
306
307   @Override
308   public Component getGlassPane()
309   {
310     return aptxFrame.getGlassPane();
311   }
312
313   @Override
314   public boolean imageUpdate(Image img, int infoflags, int x, int y,
315           int width, int height)
316   {
317     return aptxFrame.imageUpdate(img, infoflags, x, y, width, height);
318   }
319
320   @Override
321   public Font getFont()
322   {
323     return aptxFrame.getFont();
324   }
325
326   @Override
327   public void remove(MenuComponent comp)
328   {
329     aptxFrame.remove(comp);
330
331   }
332
333   @Deprecated
334   @Override
335   public boolean postEvent(Event evt)
336   {
337     return aptxFrame.postEvent(evt);
338   }
339
340   @Override
341   public void addFrameListener(InternalFrameListener listener)
342   {
343     aptxFrame.addInternalFrameListener(listener);
344
345   }
346
347   @Override
348   public void removeFrameListener(InternalFrameListener listener)
349   {
350     aptxFrame.removeInternalFrameListener(listener);
351
352   }
353
354   @Override
355   public InternalFrameListener[] getFrameListeners()
356   {
357     return aptxFrame.getInternalFrameListeners();
358
359   }
360
361   @Override
362   public void repaint()
363   {
364     aptxFrame.repaint();
365
366   }
367
368   @Override
369   public void setMinimumSize(Dimension dimension)
370   {
371     aptxFrame.setMinimumSize(dimension);
372
373   }
374
375   @Override
376   public boolean isShowing()
377   {
378     return aptxFrame.isShowing();
379   }
380
381   @Override
382   public Container getTopLevelAncestor()
383   {
384     return aptxFrame.getTopLevelAncestor();
385   }
386
387   @Override
388   public void addFrameToJalview(String title, boolean makeVisible,
389           int width, int height, boolean resizable, boolean ignoreMinSize)
390   {
391     Desktop.addInternalFrame(aptxFrame, title, makeVisible, width, height,
392             resizable, ignoreMinSize);
393
394   }
395
396 }