forester/java/src/org/forester/archaeopteryx/MainPanel.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // Copyright (C) 2000-2001 Washington University School of Medicine
   8 // and Howard Hughes Medical Institute
   9 // Copyright (C) 2003-2007 Ethalinda K.S. Cannon
  10 // All rights reserved
  11 //
  12 // This library is free software; you can redistribute it and/or
  13 // modify it under the terms of the GNU Lesser General Public
  14 // License as published by the Free Software Foundation; either
  15 // version 2.1 of the License, or (at your option) any later version.
  16 //
  17 // This library is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20 // Lesser General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU Lesser General Public
  23 // License along with this library; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  25 //
  26 // Contact: phylosoft @ gmail . com
  27 // WWW: www.phylosoft.org/forester
  28
  29 package org.forester.archaeopteryx;
  30
  31 import java.awt.BorderLayout;
  32 import java.awt.Dimension;
  33 import java.awt.event.AdjustmentEvent;
  34 import java.awt.event.AdjustmentListener;
  35 import java.awt.event.ComponentEvent;
  36 import java.awt.event.ComponentListener;
  37 import java.awt.image.BufferedImage;
  38 import java.util.ArrayList;
  39 import java.util.HashMap;
  40 import java.util.Hashtable;
  41 import java.util.List;
  42 import java.util.Map;
  43 import java.util.Set;
  44
  45 import javax.swing.JPanel;
  46 import javax.swing.JScrollPane;
  47 import javax.swing.JTabbedPane;
  48 import javax.swing.SwingConstants;
  49 import javax.swing.event.ChangeEvent;
  50 import javax.swing.event.ChangeListener;
  51
  52 import org.forester.archaeopteryx.phylogeny.data.RenderableDomainArchitecture;
  53 import org.forester.phylogeny.Phylogeny;
  54 import org.forester.util.ForesterUtil;
  55
  56 public class MainPanel extends JPanel implements ComponentListener {
  57
  58     private static final long                serialVersionUID = -2682765312661416435L;
  59     MainFrame                                _mainframe;
  60     List<TreePanel>                          _treepanels;
  61     ControlPanel                             _control_panel;
  62     private List<JScrollPane>                _treegraphic_scroll_panes;
  63     private List<JPanel>                     _treegraphic_scroll_pane_panels;
  64     Configuration                            _configuration;
  65     private JTabbedPane                      _tabbed_pane;
  66     private TreeColorSet                     _colorset;
  67     private TreeFontSet                      _fontset;
  68     private Phylogeny                        _cut_or_copied_tree;
  69     private Set<Integer>                     _copied_and_pasted_nodes;
  70     private Hashtable<String, BufferedImage> _image_map;
  71     private static Map<String, String>       _lineage_to_rank_map;
  72
  73     MainPanel() {
  74     }
  75
  76     public MainPanel( final Configuration configuration, final MainFrame parent ) {
  77         if ( configuration == null ) {
  78             throw new IllegalArgumentException( "configuration is null" );
  79         }
  80         addComponentListener( this );
  81         _configuration = configuration;
  82         _mainframe = parent;
  83         _treepanels = new ArrayList<TreePanel>();
  84         initialize();
  85         _control_panel = new ControlPanel( this, configuration );
  86         add( _control_panel, BorderLayout.WEST );
  87         setupTreeGraphic( configuration, getControlPanel() );
  88         getControlPanel().showWhole();
  89     }
  90
  91     public void addPhylogenyInNewTab( final Phylogeny phy,
  92                                       final Configuration config,
  93                                       final String default_name,
  94                                       final String full_path ) {
  95         final TreePanel treepanel = new TreePanel( phy, config, this );
  96         getControlPanel().phylogenyAdded( config );
  97         treepanel.setControlPanel( getControlPanel() );
  98         _treepanels.add( treepanel );
  99         String name = "";
 100         if ( !ForesterUtil.isEmpty( phy.getName() ) ) {
 101             name = phy.getName();
 102         }
 103         else if ( phy.getIdentifier() != null ) {
 104             name = phy.getIdentifier().toString();
 105         }
 106         else if ( !ForesterUtil.isEmpty( default_name ) ) {
 107             name = default_name;
 108         }
 109         else {
 110             name = "[" + ( getTabbedPane().getTabCount() + 1 ) + "]";
 111         }
 112         final JScrollPane treegraphic_scroll_pane = new JScrollPane( treepanel );
 113         treegraphic_scroll_pane.getHorizontalScrollBar().addAdjustmentListener( new AdjustmentListener() {
 114
 115             @Override
 116             public void adjustmentValueChanged( final AdjustmentEvent e ) {
 117                 if ( treepanel.isOvOn() || getOptions().isShowScale() ) {
 118                     treepanel.repaint();
 119                 }
 120             }
 121         } );
 122         treegraphic_scroll_pane.getVerticalScrollBar().addAdjustmentListener( new AdjustmentListener() {
 123
 124             @Override
 125             public void adjustmentValueChanged( final AdjustmentEvent e ) {
 126                 if ( treepanel.isOvOn() || getOptions().isShowScale() ) {
 127                     treepanel.repaint();
 128                     //System.out.println( e.getValue() );
 129                 }
 130             }
 131         } );
 132         treegraphic_scroll_pane.getHorizontalScrollBar().setUnitIncrement( 10 );
 133         treegraphic_scroll_pane.getHorizontalScrollBar().setBlockIncrement( 200 );
 134         treegraphic_scroll_pane.getVerticalScrollBar().setUnitIncrement( 10 );
 135         treegraphic_scroll_pane.getVerticalScrollBar().setBlockIncrement( 200 );
 136         final JPanel treegraphic_scroll_pane_panel = new JPanel();
 137         treegraphic_scroll_pane_panel.setLayout( new BorderLayout() );
 138         treegraphic_scroll_pane_panel.add( treegraphic_scroll_pane, BorderLayout.CENTER );
 139         _treegraphic_scroll_pane_panels.add( treegraphic_scroll_pane_panel );
 140         _treegraphic_scroll_panes.add( treegraphic_scroll_pane );
 141         getTabbedPane().addTab( name, null, treegraphic_scroll_pane_panel, "" );
 142         getTabbedPane().setSelectedIndex( getTabbedPane().getTabCount() - 1 );
 143         getControlPanel().showWhole();
 144     }
 145
 146     void addPhylogenyInPanel( final Phylogeny phy, final Configuration config ) {
 147         final TreePanel treepanel = new TreePanel( phy, config, this );
 148         getControlPanel().phylogenyAdded( config );
 149         treepanel.setControlPanel( getControlPanel() );
 150         _treepanels.add( treepanel );
 151         final JScrollPane treegraphic_scroll_pane = new JScrollPane( treepanel );
 152         treegraphic_scroll_pane.getHorizontalScrollBar().setUnitIncrement( 20 );
 153         treegraphic_scroll_pane.getHorizontalScrollBar().setBlockIncrement( 50 );
 154         treegraphic_scroll_pane.getVerticalScrollBar().setUnitIncrement( 20 );
 155         treegraphic_scroll_pane.getVerticalScrollBar().setBlockIncrement( 50 );
 156         final JPanel treegraphic_scroll_pane_panel = new JPanel();
 157         treegraphic_scroll_pane_panel.setLayout( new BorderLayout() );
 158         treegraphic_scroll_pane_panel.add( treegraphic_scroll_pane, BorderLayout.CENTER );
 159         _treegraphic_scroll_pane_panels.add( treegraphic_scroll_pane_panel );
 160         _treegraphic_scroll_panes.add( treegraphic_scroll_pane );
 161         add( treegraphic_scroll_pane_panel, BorderLayout.CENTER );
 162     }
 163
 164     void adjustJScrollPane() {
 165         if ( getTabbedPane() != null ) {
 166             getCurrentScrollPanePanel().remove( getCurrentScrollPane() );
 167             getCurrentScrollPanePanel().add( getCurrentScrollPane(), BorderLayout.CENTER );
 168         }
 169         getCurrentScrollPane().revalidate();
 170     }
 171
 172     void closeCurrentPane() {
 173         final int index = getCurrentTabIndex();
 174         if ( ( index >= 0 ) && ( getTabbedPane().getTabCount() > 0 ) ) {
 175             getTabbedPane().remove( index );
 176             getTreePanels().remove( index );
 177             _treegraphic_scroll_panes.remove( index );
 178             _treegraphic_scroll_pane_panels.remove( index );
 179             getControlPanel().phylogenyRemoved( index );
 180         }
 181     }
 182
 183     @Override
 184     public void componentHidden( final ComponentEvent e ) {
 185         // Do nothing.
 186     }
 187
 188     @Override
 189     public void componentMoved( final ComponentEvent e ) {
 190         // Do nothing.
 191     }
 192
 193     @Override
 194     public void componentResized( final ComponentEvent e ) {
 195         if ( getCurrentTreePanel() != null ) {
 196             getCurrentTreePanel().updateOvSettings();
 197             getCurrentTreePanel().updateOvSizes();
 198         }
 199     }
 200
 201     @Override
 202     public void componentShown( final ComponentEvent e ) {
 203         // Do nothing.
 204     }
 205
 206     private Configuration getConfiguration() {
 207         return _configuration;
 208     }
 209
 210     public ControlPanel getControlPanel() {
 211         return _control_panel;
 212     }
 213
 214     public Set<Integer> getCopiedAndPastedNodes() {
 215         return _copied_and_pasted_nodes;
 216     }
 217
 218     Phylogeny getCurrentPhylogeny() {
 219         if ( getCurrentTreePanel() == null ) {
 220             return null;
 221         }
 222         return getCurrentTreePanel().getPhylogeny();
 223     }
 224
 225     JScrollPane getCurrentScrollPane() {
 226         if ( _treegraphic_scroll_panes.size() > 0 ) {
 227             final int selected = getTabbedPane().getSelectedIndex();
 228             if ( selected >= 0 ) {
 229                 return _treegraphic_scroll_panes.get( selected );
 230             }
 231             else {
 232                 return _treegraphic_scroll_panes.get( 0 );
 233             }
 234         }
 235         else {
 236             return null;
 237         }
 238     }
 239
 240     JPanel getCurrentScrollPanePanel() {
 241         final int selected = getTabbedPane().getSelectedIndex();
 242         if ( selected >= 0 ) {
 243             return _treegraphic_scroll_pane_panels.get( selected );
 244         }
 245         else {
 246             return _treegraphic_scroll_pane_panels.get( 0 );
 247         }
 248     }
 249
 250     int getCurrentTabIndex() {
 251         final int selected = getTabbedPane().getSelectedIndex();
 252         if ( selected >= 0 ) {
 253             return selected;
 254         }
 255         else {
 256             return 0;
 257         }
 258     }
 259
 260     void setTitleOfSelectedTab( final String title ) {
 261         final int selected = getTabbedPane().getSelectedIndex();
 262         if ( selected >= 0 ) {
 263             getTabbedPane().setTitleAt( selected, title );
 264         }
 265     }
 266
 267     public TreePanel getCurrentTreePanel() {
 268         final int selected = getTabbedPane().getSelectedIndex();
 269         if ( selected >= 0 ) {
 270             return _treepanels.get( selected );
 271         }
 272         else {
 273             if ( _treepanels.size() == 1 ) {
 274                 return _treepanels.get( 0 );
 275             }
 276             else {
 277                 return null;
 278             }
 279         }
 280     }
 281
 282     Phylogeny getCutOrCopiedTree() {
 283         return _cut_or_copied_tree;
 284     }
 285
 286     MainFrame getMainFrame() {
 287         return _mainframe;
 288     }
 289
 290     public Options getOptions() {
 291         return _mainframe.getOptions();
 292     }
 293
 294     Phylogeny getPhylogeny( final int index ) {
 295         if ( getCurrentTreePanel() == null ) {
 296             return null;
 297         }
 298         return _treepanels.get( index ).getPhylogeny();
 299     }
 300
 301     Dimension getSizeOfViewport() {
 302         return getCurrentScrollPane().getViewport().getExtentSize();
 303     }
 304
 305     public JTabbedPane getTabbedPane() {
 306         return _tabbed_pane;
 307     }
 308
 309     TreeColorSet getTreeColorSet() {
 310         return _colorset;
 311     }
 312
 313     public TreeFontSet getTreeFontSet() {
 314         return _fontset;
 315     }
 316
 317     List<TreePanel> getTreePanels() {
 318         return _treepanels;
 319     }
 320
 321     void initialize() {
 322         if ( !getConfiguration().isUseNativeUI() ) {
 323             setBackground( getConfiguration().getGuiBackgroundColor() );
 324         }
 325         setTreeFontSet( new TreeFontSet( this ) );
 326         getTreeFontSet().setBaseFont( getOptions().getBaseFont() );
 327         setLayout( new BorderLayout() );
 328         setTreeColorSet( TreeColorSet.createInstance( getConfiguration() ) );
 329         _treegraphic_scroll_panes = new ArrayList<JScrollPane>();
 330         _treegraphic_scroll_pane_panels = new ArrayList<JPanel>();
 331         _tabbed_pane = new JTabbedPane( SwingConstants.TOP );
 332         if ( !getConfiguration().isUseNativeUI() ) {
 333             _tabbed_pane.setBackground( getConfiguration().getGuiBackgroundColor() );
 334             _tabbed_pane.setForeground( getConfiguration().getGuiBackgroundColor() );
 335         }
 336         _tabbed_pane.addChangeListener( new ChangeListener() {
 337
 338             // This method is called whenever the selected tab changes
 339             @Override
 340             public void stateChanged( final ChangeEvent evt ) {
 341                 final JTabbedPane pane = ( JTabbedPane ) evt.getSource();
 342                 getControlPanel().tabChanged();
 343                 // Get current tab
 344                 final int sel = pane.getSelectedIndex();
 345                 if ( sel >= 0 ) {
 346                     if ( !getConfiguration().isUseNativeUI() ) {
 347                         if ( _tabbed_pane.getTabCount() > 0 ) {
 348                             _tabbed_pane.setForegroundAt( sel, Constants.TAB_LABEL_FOREGROUND_COLOR_SELECTED );
 349                             for( int i = 0; i < _tabbed_pane.getTabCount(); ++i ) {
 350                                 if ( i != sel ) {
 351                                     _tabbed_pane.setBackgroundAt( i, getConfiguration().getGuiBackgroundColor() );
 352                                     _tabbed_pane.setForegroundAt( i, getConfiguration().getGuiCheckboxTextColor() );
 353                                 }
 354                             }
 355                         }
 356                     }
 357                 }
 358             }
 359         } );
 360         if ( !getConfiguration().isUseNativeUI() ) {
 361             _tabbed_pane.setFont( ControlPanel.jcb_font );
 362         }
 363         _tabbed_pane.setTabLayoutPolicy( JTabbedPane.SCROLL_TAB_LAYOUT );
 364         add( _tabbed_pane, BorderLayout.CENTER );
 365     }
 366
 367     public void setArrowCursor() {
 368         setCursor( TreePanel.ARROW_CURSOR );
 369         repaint();
 370     }
 371
 372     public void setCopiedAndPastedNodes( final Set<Integer> node_ids ) {
 373         _copied_and_pasted_nodes = node_ids;
 374     }
 375
 376     void setCutOrCopiedTree( final Phylogeny cut_or_copied_tree ) {
 377         _cut_or_copied_tree = cut_or_copied_tree;
 378     }
 379
 380     void setTreeColorSet( final TreeColorSet colorset ) {
 381         _colorset = colorset;
 382         for( final TreePanel p : getTreePanels() ) {
 383             p.setBackground( colorset.getBackgroundColor() );
 384         }
 385     }
 386
 387     void setTreeFontSet( final TreeFontSet fontset ) {
 388         _fontset = fontset;
 389     }
 390
 391     void setupTreeGraphic( final Configuration config_settings, final ControlPanel control ) {
 392         control.setSpeciesColors( config_settings.getSpeciesColors() );
 393         control.setAnnotationColors( config_settings.getAnnotationColors() );
 394         RenderableDomainArchitecture.setColorMap( config_settings.getDomainColors() );
 395     }
 396
 397     public void setWaitCursor() {
 398         setCursor( TreePanel.WAIT_CURSOR );
 399         repaint();
 400     }
 401
 402     void terminate() {
 403         for( final TreePanel atvtreepanel : _treepanels ) {
 404             atvtreepanel.removeAllEditNodeJFrames();
 405         }
 406     }
 407
 408     synchronized void setImageMap( final Hashtable<String, BufferedImage> image_map ) {
 409         _image_map = image_map;
 410     }
 411
 412     synchronized Hashtable<String, BufferedImage> getImageMap() {
 413         return _image_map;
 414     }
 415
 416     public synchronized static Map<String, String> getLineageToRankMap() {
 417         if ( _lineage_to_rank_map == null ) {
 418             _lineage_to_rank_map = new HashMap<String, String>();
 419         }
 420         return _lineage_to_rank_map;
 421     }
 422 }