src/jalview/gui/TextColourChooser.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 java.awt.BorderLayout;
  24 import java.awt.Color;
  25 import java.awt.Dimension;
  26 import java.awt.event.MouseAdapter;
  27 import java.awt.event.MouseEvent;
  28 import java.util.HashMap;
  29 import java.util.Map;
  30
  31 import javax.swing.BorderFactory;
  32 import javax.swing.JLabel;
  33 import javax.swing.JPanel;
  34 import javax.swing.JSlider;
  35 import javax.swing.event.ChangeEvent;
  36 import javax.swing.event.ChangeListener;
  37
  38 import jalview.datamodel.SequenceGroup;
  39 import jalview.gui.JalviewColourChooser.ColourChooserListener;
  40 import jalview.util.MessageManager;
  41
  42 public class TextColourChooser
  43 {
  44   AlignmentPanel ap;
  45
  46   SequenceGroup sg;
  47
  48   Color original1, original2;
  49
  50   int originalThreshold;
  51
  52   Map<SequenceGroup, Color> groupColour1;
  53
  54   Map<SequenceGroup, Color> groupColour2;
  55
  56   Map<SequenceGroup, Integer> groupThreshold;
  57
  58   /**
  59    * Show a dialogue which allows the user to select two text colours and adjust
  60    * a slider for the cross-over point
  61    *
  62    * @param alignPanel
  63    *          the AlignmentPanel context
  64    * @param sequenceGroup
  65    *          the SequenceGroup context (only for group pop-menu option)
  66    */
  67   public void chooseColour(AlignmentPanel alignPanel,
  68           SequenceGroup sequenceGroup)
  69   {
  70     this.ap = alignPanel;
  71     this.sg = sequenceGroup;
  72
  73     saveInitialSettings();
  74
  75     final JSlider slider = new JSlider(0, 750, originalThreshold);
  76     final JPanel col1 = new JPanel();
  77     col1.setPreferredSize(new Dimension(40, 20));
  78     col1.setBorder(BorderFactory.createEtchedBorder());
  79     col1.setToolTipText(MessageManager.getString("label.dark_colour"));
  80     col1.setBackground(original1);
  81     final JPanel col2 = new JPanel();
  82     col2.setPreferredSize(new Dimension(40, 20));
  83     col2.setBorder(BorderFactory.createEtchedBorder());
  84     col2.setToolTipText(MessageManager.getString("label.light_colour"));
  85     col2.setBackground(original2);
  86     final JPanel bigpanel = new JPanel(new BorderLayout());
  87     JPanel panel = new JPanel(new BorderLayout());
  88     bigpanel.add(panel, BorderLayout.CENTER);
  89     bigpanel.add(
  90             new JLabel("<html>"
  91                     + MessageManager.getString(
  92                             "label.select_dark_light_set_threshold")
  93                     + "</html>"),
  94             BorderLayout.NORTH);
  95     panel.add(col1, BorderLayout.WEST);
  96     panel.add(slider, BorderLayout.CENTER);
  97     panel.add(col2, BorderLayout.EAST);
  98
  99     col1.addMouseListener(new MouseAdapter()
 100     {
 101       @Override
 102       public void mousePressed(MouseEvent e)
 103       {
 104         String ttl = MessageManager
 105                 .getString("label.select_colour_for_text");
 106         ColourChooserListener listener = new ColourChooserListener()
 107         {
 108           @Override
 109           public void colourSelected(Color c)
 110           {
 111             colour1Changed(c);
 112             col1.setBackground(c);
 113           }
 114         };
 115         JalviewColourChooser.showColourChooser(bigpanel, ttl,
 116                 col1.getBackground(), listener);
 117       }
 118     });
 119
 120     col2.addMouseListener(new MouseAdapter()
 121     {
 122       @Override
 123       public void mousePressed(MouseEvent e)
 124       {
 125         String ttl = MessageManager
 126                 .getString("label.select_colour_for_text");
 127         ColourChooserListener listener = new ColourChooserListener()
 128         {
 129           @Override
 130           public void colourSelected(Color c)
 131           {
 132             colour2Changed(c);
 133             col2.setBackground(c);
 134           }
 135         };
 136         JalviewColourChooser.showColourChooser(bigpanel, ttl,
 137                 col2.getBackground(), listener);
 138       }
 139     });
 140
 141     slider.addChangeListener(new ChangeListener()
 142     {
 143       @Override
 144       public void stateChanged(ChangeEvent evt)
 145       {
 146         thresholdChanged(slider.getValue());
 147       }
 148     });
 149
 150     Object[] options = new Object[] { MessageManager.getString("action.ok"),
 151         MessageManager.getString("action.cancel") };
 152     String title = MessageManager
 153             .getString("label.adjust_foreground_text_colour_threshold");
 154     Runnable action = () -> // response for 1 = Cancel
 155     {
 156       restoreInitialSettings();
 157     };
 158     JvOptionPane.newOptionDialog(alignPanel.alignFrame)
 159             .setResponseHandler(1, action).showInternalDialog(bigpanel,
 160                     title, JvOptionPane.YES_NO_CANCEL_OPTION,
 161                     JvOptionPane.PLAIN_MESSAGE, null, options,
 162                     MessageManager.getString("action.ok"));
 163   }
 164
 165   /**
 166    * Restore initial settings on Cancel
 167    */
 168   protected void restoreInitialSettings()
 169   {
 170     if (sg == null)
 171     {
 172       ap.av.setTextColour(original1);
 173       ap.av.setTextColour2(original2);
 174       ap.av.setThresholdTextColour(originalThreshold);
 175     }
 176     else
 177     {
 178       sg.textColour = original1;
 179       sg.textColour2 = original2;
 180       sg.thresholdTextColour = originalThreshold;
 181     }
 182
 183     /*
 184      * if 'Apply To All Groups' was in force, there will be
 185      * group-specific settings to restore as well
 186      */
 187     for (SequenceGroup group : this.groupColour1.keySet())
 188     {
 189       group.textColour = groupColour1.get(group);
 190       group.textColour2 = groupColour2.get(group);
 191       group.thresholdTextColour = groupThreshold.get(group);
 192     }
 193
 194     ap.paintAlignment(false, false);
 195   }
 196
 197   /**
 198    * Save settings on entry, for restore on Cancel
 199    */
 200   protected void saveInitialSettings()
 201   {
 202     groupColour1 = new HashMap<>();
 203     groupColour2 = new HashMap<>();
 204     groupThreshold = new HashMap<>();
 205
 206     if (sg == null)
 207     {
 208       /*
 209        * alignment scope
 210        */
 211       original1 = ap.av.getTextColour();
 212       original2 = ap.av.getTextColour2();
 213       originalThreshold = ap.av.getThresholdTextColour();
 214       if (ap.av.getColourAppliesToAllGroups()
 215               && ap.av.getAlignment().getGroups() != null)
 216       {
 217         /*
 218          * if applying changes to all groups, need to be able to
 219          * restore group settings as well
 220          */
 221         for (SequenceGroup group : ap.av.getAlignment().getGroups())
 222         {
 223           groupColour1.put(group, group.textColour);
 224           groupColour2.put(group, group.textColour2);
 225           groupThreshold.put(group, group.thresholdTextColour);
 226         }
 227       }
 228     }
 229     else
 230     {
 231       /*
 232        * Sequence group scope
 233        */
 234       original1 = sg.textColour;
 235       original2 = sg.textColour2;
 236       originalThreshold = sg.thresholdTextColour;
 237     }
 238   }
 239
 240   void colour1Changed(Color col)
 241   {
 242     if (sg == null)
 243     {
 244       ap.av.setTextColour(col);
 245       if (ap.av.getColourAppliesToAllGroups())
 246       {
 247         setGroupTextColour();
 248       }
 249     }
 250     else
 251     {
 252       sg.textColour = col;
 253     }
 254
 255     ap.paintAlignment(false, false);
 256   }
 257
 258   void colour2Changed(Color col)
 259   {
 260     if (sg == null)
 261     {
 262       ap.av.setTextColour2(col);
 263       if (ap.av.getColourAppliesToAllGroups())
 264       {
 265         setGroupTextColour();
 266       }
 267     }
 268     else
 269     {
 270       sg.textColour2 = col;
 271     }
 272
 273     ap.paintAlignment(false, false);
 274   }
 275
 276   void thresholdChanged(int value)
 277   {
 278     if (sg == null)
 279     {
 280       ap.av.setThresholdTextColour(value);
 281       if (ap.av.getColourAppliesToAllGroups())
 282       {
 283         setGroupTextColour();
 284       }
 285     }
 286     else
 287     {
 288       sg.thresholdTextColour = value;
 289     }
 290
 291     ap.paintAlignment(false, false);
 292   }
 293
 294   void setGroupTextColour()
 295   {
 296     if (ap.av.getAlignment().getGroups() == null)
 297     {
 298       return;
 299     }
 300
 301     for (SequenceGroup group : ap.av.getAlignment().getGroups())
 302     {
 303       group.textColour = ap.av.getTextColour();
 304       group.textColour2 = ap.av.getTextColour2();
 305       group.thresholdTextColour = ap.av.getThresholdTextColour();
 306     }
 307   }
 308
 309 }