src/jalview/gui/SliderPanel.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.gui;
  22
  23 import jalview.datamodel.SequenceGroup;
  24 import jalview.jbgui.GSliderPanel;
  25 import jalview.schemes.CollectionColourSchemeI;
  26 import jalview.util.MessageManager;
  27
  28 import java.awt.event.MouseAdapter;
  29 import java.awt.event.MouseEvent;
  30 import java.beans.PropertyVetoException;
  31
  32 import javax.swing.JInternalFrame;
  33 import javax.swing.JLayeredPane;
  34 import javax.swing.event.ChangeEvent;
  35 import javax.swing.event.ChangeListener;
  36 import javax.swing.event.InternalFrameAdapter;
  37 import javax.swing.event.InternalFrameEvent;
  38
  39 /**
  40  * DOCUMENT ME!
  41  *
  42  * @author $author$
  43  * @version $Revision$
  44  */
  45 public class SliderPanel extends GSliderPanel
  46 {
  47   static JInternalFrame conservationSlider;
  48
  49   static JInternalFrame PIDSlider;
  50
  51   AlignmentPanel ap;
  52
  53   boolean forConservation = true;
  54
  55   CollectionColourSchemeI cs;
  56
  57   /**
  58    * Creates a new SliderPanel object.
  59    *
  60    * @param ap
  61    *          DOCUMENT ME!
  62    * @param value
  63    *          DOCUMENT ME!
  64    * @param forConserve
  65    *          DOCUMENT ME!
  66    * @param scheme
  67    *          DOCUMENT ME!
  68    */
  69   public SliderPanel(final AlignmentPanel ap, int value,
  70           boolean forConserve, CollectionColourSchemeI scheme)
  71   {
  72     this.ap = ap;
  73     this.cs = scheme;
  74     forConservation = forConserve;
  75     undoButton.setVisible(false);
  76     applyButton.setVisible(false);
  77
  78     if (forConservation)
  79     {
  80       label.setText(MessageManager
  81               .getString("label.enter_value_increase_conservation_visibility"));
  82       slider.setMinimum(0);
  83       slider.setMaximum(100);
  84     }
  85     else
  86     {
  87       label.setText(MessageManager
  88               .getString("label.enter_percentage_identity_above_which_colour_residues"));
  89       slider.setMinimum(0);
  90       slider.setMaximum(100);
  91     }
  92
  93     slider.addChangeListener(new ChangeListener()
  94     {
  95       @Override
  96       public void stateChanged(ChangeEvent evt)
  97       {
  98         valueField.setText(slider.getValue() + "");
  99         valueChanged(slider.getValue());
 100       }
 101     });
 102
 103     slider.addMouseListener(new MouseAdapter()
 104     {
 105       @Override
 106       public void mouseReleased(MouseEvent evt)
 107       {
 108         ap.paintAlignment(true);
 109       }
 110     });
 111
 112     slider.setValue(value);
 113     valueField.setText(value + "");
 114   }
 115
 116   /**
 117    * DOCUMENT ME!
 118    *
 119    * @param ap
 120    *          DOCUMENT ME!
 121    * @param ccs
 122    *          DOCUMENT ME!
 123    * @param source
 124    *          DOCUMENT ME!
 125    *
 126    * @return DOCUMENT ME!
 127    */
 128   public static int setConservationSlider(AlignmentPanel ap,
 129           CollectionColourSchemeI ccs, String source)
 130   {
 131     SliderPanel sp = null;
 132
 133     if (conservationSlider == null)
 134     {
 135       sp = new SliderPanel(ap, ccs.getConservationInc(), true, ccs);
 136       conservationSlider = new JInternalFrame();
 137       conservationSlider.setContentPane(sp);
 138       conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);
 139     }
 140     else
 141     {
 142       sp = (SliderPanel) conservationSlider.getContentPane();
 143       sp.valueField.setText(String.valueOf(ccs.getConservationInc()));
 144       sp.cs = ccs;
 145     }
 146
 147     conservationSlider
 148             .setTitle(MessageManager.formatMessage(
 149                     "label.conservation_colour_increment",
 150                     new String[] { source }));
 151
 152     if (ap.av.getAlignment().getGroups() != null)
 153     {
 154       sp.setAllGroupsCheckEnabled(true);
 155     }
 156     else
 157     {
 158       sp.setAllGroupsCheckEnabled(false);
 159     }
 160
 161     return sp.getValue();
 162   }
 163
 164   /**
 165    * Hides the PID slider panel if it is shown
 166    */
 167   public static void hidePIDSlider()
 168   {
 169     if (PIDSlider != null)
 170     {
 171       try
 172       {
 173         PIDSlider.setClosed(true);
 174         PIDSlider = null;
 175       } catch (PropertyVetoException ex)
 176       {
 177       }
 178     }
 179   }
 180
 181   /**
 182    * Hides the conservation slider panel if it is shown
 183    */
 184   public static void hideConservationSlider()
 185   {
 186     if (conservationSlider != null)
 187     {
 188       try
 189       {
 190         conservationSlider.setClosed(true);
 191         conservationSlider = null;
 192       } catch (PropertyVetoException ex)
 193       {
 194       }
 195     }
 196   }
 197
 198   /**
 199    * DOCUMENT ME!
 200    */
 201   public static void showConservationSlider()
 202   {
 203     hidePIDSlider();
 204
 205     if (!conservationSlider.isVisible())
 206     {
 207       Desktop.addInternalFrame(conservationSlider,
 208               conservationSlider.getTitle(), 420, 90, false);
 209       conservationSlider
 210               .addInternalFrameListener(new InternalFrameAdapter()
 211               {
 212                 @Override
 213                 public void internalFrameClosed(InternalFrameEvent e)
 214                 {
 215                   conservationSlider = null;
 216                 }
 217               });
 218       conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);
 219     }
 220   }
 221
 222   /**
 223    * DOCUMENT ME!
 224    *
 225    * @param ap
 226    *          DOCUMENT ME!
 227    * @param ccs
 228    *          DOCUMENT ME!
 229    * @param source
 230    *          DOCUMENT ME!
 231    *
 232    * @return DOCUMENT ME!
 233    */
 234   public static int setPIDSliderSource(AlignmentPanel ap,
 235           CollectionColourSchemeI ccs, String source)
 236   {
 237     SliderPanel pid = null;
 238
 239     int threshold = ccs.getThreshold();
 240
 241     if (PIDSlider == null)
 242     {
 243       pid = new SliderPanel(ap, threshold, false, ccs);
 244       PIDSlider = new JInternalFrame();
 245       PIDSlider.setContentPane(pid);
 246       PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);
 247     }
 248     else
 249     {
 250       pid = (SliderPanel) PIDSlider.getContentPane();
 251       pid.cs = ccs;
 252       pid.valueField.setText(String.valueOf(ccs.getThreshold()));
 253     }
 254
 255     PIDSlider
 256             .setTitle(MessageManager.formatMessage(
 257                     "label.percentage_identity_threshold",
 258                     new String[] { source }));
 259
 260     if (ap.av.getAlignment().getGroups() != null)
 261     {
 262       pid.setAllGroupsCheckEnabled(true);
 263     }
 264     else
 265     {
 266       pid.setAllGroupsCheckEnabled(false);
 267     }
 268
 269     return pid.getValue();
 270   }
 271
 272   /**
 273    * DOCUMENT ME!
 274    */
 275   public static void showPIDSlider()
 276   {
 277     hideConservationSlider();
 278
 279     if (!PIDSlider.isVisible())
 280     {
 281       Desktop.addInternalFrame(PIDSlider, PIDSlider.getTitle(), 420, 90,
 282               false);
 283       PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);
 284       PIDSlider.addInternalFrameListener(new InternalFrameAdapter()
 285       {
 286         @Override
 287         public void internalFrameClosed(InternalFrameEvent e)
 288         {
 289           PIDSlider = null;
 290         }
 291       });
 292       PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);
 293     }
 294   }
 295
 296   /**
 297    * Updates the colour scheme with the current (identity threshold or
 298    * conservation) percentage value. Also updates all groups if 'apply to all
 299    * groups' is selected.
 300    *
 301    * @param percent
 302    */
 303   public void valueChanged(int percent)
 304   {
 305     if (!forConservation)
 306     {
 307       ap.av.setThreshold(percent);
 308     }
 309     updateColourScheme(percent, cs);
 310
 311     if (allGroupsCheck.isSelected())
 312     {
 313       for (SequenceGroup sg : ap.av.getAlignment().getGroups())
 314       {
 315         updateColourScheme(percent, sg.getGroupColourScheme());
 316       }
 317     }
 318
 319     ap.getSeqPanel().seqCanvas.repaint();
 320   }
 321
 322   /**
 323    * Updates the colour scheme (if not null) with the current (identity
 324    * threshold or conservation) percentage value
 325    *
 326    * @param percent
 327    * @param scheme
 328    */
 329   protected void updateColourScheme(int percent, CollectionColourSchemeI scheme)
 330   {
 331     if (scheme == null)
 332     {
 333       return;
 334     }
 335     if (forConservation)
 336     {
 337       scheme.setConservationInc(percent);
 338     }
 339     else
 340     {
 341       scheme.setThreshold(percent, ap.av.isIgnoreGapsConsensus());
 342     }
 343   }
 344
 345   /**
 346    * DOCUMENT ME!
 347    *
 348    * @param b
 349    *          DOCUMENT ME!
 350    */
 351   public void setAllGroupsCheckEnabled(boolean b)
 352   {
 353     allGroupsCheck.setEnabled(b);
 354   }
 355
 356   /**
 357    * DOCUMENT ME!
 358    *
 359    * @param e
 360    *          DOCUMENT ME!
 361    */
 362   @Override
 363   public void valueField_actionPerformed()
 364   {
 365     try
 366     {
 367       int i = Integer.parseInt(valueField.getText());
 368       slider.setValue(i);
 369     } catch (NumberFormatException ex)
 370     {
 371       valueField.setText(slider.getValue() + "");
 372     }
 373   }
 374
 375   /**
 376    * DOCUMENT ME!
 377    *
 378    * @param value
 379    *          DOCUMENT ME!
 380    */
 381   public void setValue(int value)
 382   {
 383     slider.setValue(value);
 384   }
 385
 386   /**
 387    * DOCUMENT ME!
 388    *
 389    * @return DOCUMENT ME!
 390    */
 391   public int getValue()
 392   {
 393     return Integer.parseInt(valueField.getText());
 394   }
 395
 396   @Override
 397   public void slider_mouseReleased(MouseEvent e)
 398   {
 399     if (ap.overviewPanel != null)
 400     {
 401       ap.overviewPanel.updateOverviewImage();
 402     }
 403   }
 404
 405   public static int getConservationValue()
 406   {
 407     return getValue(conservationSlider);
 408   }
 409
 410   static int getValue(JInternalFrame slider)
 411   {
 412     return slider == null ? 0 : ((SliderPanel) slider.getContentPane())
 413             .getValue();
 414   }
 415
 416   public static int getPIDValue()
 417   {
 418     return getValue(PIDSlider);
 419   }
 420
 421 }