2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.api.structures.JalviewStructureDisplayI;
24 import jalview.datamodel.SequenceGroup;
25 import jalview.io.JalviewFileChooser;
26 import jalview.jbgui.GUserDefinedColours;
27 import jalview.schemes.ColourSchemeI;
28 import jalview.schemes.ResidueProperties;
29 import jalview.schemes.UserColourScheme;
30 import jalview.util.MessageManager;
32 import java.awt.Color;
34 import java.awt.event.ActionEvent;
35 import java.awt.event.MouseEvent;
37 import java.io.FileInputStream;
38 import java.io.FileOutputStream;
39 import java.io.InputStreamReader;
40 import java.io.OutputStreamWriter;
41 import java.io.PrintWriter;
42 import java.util.Hashtable;
43 import java.util.StringTokenizer;
44 import java.util.Vector;
46 import javax.swing.JButton;
47 import javax.swing.JInternalFrame;
48 import javax.swing.JOptionPane;
49 import javax.swing.event.ChangeEvent;
50 import javax.swing.event.ChangeListener;
58 public class UserDefinedColours extends GUserDefinedColours implements
61 private static final int MY_FRAME_HEIGHT = 420;
62 private static final int MY_FRAME_WIDTH = 810;
63 private static final int MY_FRAME_WIDTH_CASE_SENSITIVE = 970;
67 SequenceGroup seqGroup;
69 Vector selectedButtons;
71 ColourSchemeI oldColourScheme;
75 JalviewStructureDisplayI jmol;
77 Vector upperCaseButtons;
79 Vector lowerCaseButtons;
82 * Creates a new UserDefinedColours object.
89 public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg)
93 lcaseColour.setEnabled(false);
100 oldColourScheme = seqGroup.cs;
104 oldColourScheme = ap.av.getGlobalColourScheme();
107 if (oldColourScheme instanceof UserColourScheme)
109 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
110 if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null)
112 caseSensitive.setSelected(true);
113 lcaseColour.setEnabled(true);
114 resetButtonPanel(true);
118 resetButtonPanel(false);
123 resetButtonPanel(false);
129 public UserDefinedColours(JalviewStructureDisplayI jmol, ColourSchemeI oldcs)
134 colorChooser.getSelectionModel().addChangeListener(this);
136 oldColourScheme = oldcs;
138 if (oldColourScheme instanceof UserColourScheme)
140 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
143 resetButtonPanel(false);
151 colorChooser.getSelectionModel().addChangeListener(this);
152 frame = new JInternalFrame();
153 frame.setContentPane(this);
154 Desktop.addInternalFrame(frame,
155 MessageManager.getString("label.user_defined_colours"), MY_FRAME_WIDTH,
156 MY_FRAME_HEIGHT, true);
158 if (seqGroup != null)
160 frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")");
164 void resetButtonPanel(boolean caseSensitive)
166 buttonPanel.removeAll();
168 if (upperCaseButtons == null)
170 upperCaseButtons = new Vector();
175 for (int i = 0; i < 20; i++)
179 label = ResidueProperties.aa[i];
183 label = ResidueProperties.aa2Triplet.get(ResidueProperties.aa[i])
187 button = makeButton(label, ResidueProperties.aa[i], upperCaseButtons,
190 buttonPanel.add(button);
193 buttonPanel.add(makeButton("B", "B", upperCaseButtons, 20));
194 buttonPanel.add(makeButton("Z", "Z", upperCaseButtons, 21));
195 buttonPanel.add(makeButton("X", "X", upperCaseButtons, 22));
196 buttonPanel.add(makeButton("Gap", "-", upperCaseButtons, 23));
200 gridLayout.setRows(6);
201 gridLayout.setColumns(4);
205 gridLayout.setRows(7);
207 gridLayout.setColumns(cols + 1);
209 if (lowerCaseButtons == null)
211 lowerCaseButtons = new Vector();
214 for (int i = 0; i < 20; i++)
216 int row = i / cols + 1;
217 int index = (row * cols) + i;
218 button = makeButton(ResidueProperties.aa[i].toLowerCase(),
219 ResidueProperties.aa[i].toLowerCase(), lowerCaseButtons, i);
221 buttonPanel.add(button, index);
227 buttonPanel.add(makeButton("b", "b", lowerCaseButtons, 20));
228 buttonPanel.add(makeButton("z", "z", lowerCaseButtons, 21));
229 buttonPanel.add(makeButton("x", "x", lowerCaseButtons, 22));
232 // JAL-1360 widen the frame dynamically to accommodate case-sensitive AA codes
233 if (this.frame != null) {
234 int newWidth = caseSensitive ? MY_FRAME_WIDTH_CASE_SENSITIVE : MY_FRAME_WIDTH;
235 this.frame.setSize(newWidth, this.frame.getHeight());
238 buttonPanel.validate();
248 public void stateChanged(ChangeEvent evt)
250 if (selectedButtons != null)
252 JButton button = null;
253 for (int i = 0; i < selectedButtons.size(); i++)
255 button = (JButton) selectedButtons.elementAt(i);
256 button.setBackground(colorChooser.getColor());
257 button.setForeground(button.getBackground().brighter().brighter()
260 if (button == lcaseColour)
262 for (int i = 0; i < lowerCaseButtons.size(); i++)
264 button = (JButton) lowerCaseButtons.elementAt(i);
265 button.setBackground(colorChooser.getColor());
266 button.setForeground(button.getBackground().brighter().brighter()
279 public void colourButtonPressed(MouseEvent e)
281 if (selectedButtons == null)
283 selectedButtons = new Vector();
286 JButton pressed = (JButton) e.getSource();
290 JButton start, end = (JButton) e.getSource();
291 if (selectedButtons.size() > 0)
293 start = (JButton) selectedButtons
294 .elementAt(selectedButtons.size() - 1);
298 start = (JButton) e.getSource();
301 int startIndex = 0, endIndex = 0;
302 for (int b = 0; b < buttonPanel.getComponentCount(); b++)
304 if (buttonPanel.getComponent(b) == start)
308 if (buttonPanel.getComponent(b) == end)
314 if (startIndex > endIndex)
316 int temp = startIndex;
317 startIndex = endIndex;
321 for (int b = startIndex; b <= endIndex; b++)
323 JButton button = (JButton) buttonPanel.getComponent(b);
324 if (!selectedButtons.contains(button))
326 button.setForeground(button.getBackground().brighter().brighter());
327 selectedButtons.add(button);
331 else if (!e.isControlDown())
333 for (int b = 0; b < selectedButtons.size(); b++)
335 JButton button = (JButton) selectedButtons.elementAt(b);
336 button.setForeground(button.getBackground().darker().darker());
338 selectedButtons.clear();
339 pressed.setForeground(pressed.getBackground().brighter().brighter());
340 selectedButtons.addElement(pressed);
343 else if (e.isControlDown())
345 if (selectedButtons.contains(pressed))
347 pressed.setForeground(pressed.getBackground().darker().darker());
348 selectedButtons.remove(pressed);
352 pressed.setForeground(pressed.getBackground().brighter().brighter());
353 selectedButtons.addElement(pressed);
357 if (selectedButtons.size() > 0)
359 colorChooser.setColor(((JButton) selectedButtons.elementAt(0))
372 JButton makeButton(String label, String aa, Vector caseSensitiveButtons,
375 final JButton button;
378 if (buttonIndex < caseSensitiveButtons.size())
380 button = (JButton) caseSensitiveButtons.elementAt(buttonIndex);
381 col = button.getBackground();
385 button = new JButton();
386 button.addMouseListener(new java.awt.event.MouseAdapter()
388 public void mouseClicked(MouseEvent e)
390 colourButtonPressed(e);
394 caseSensitiveButtons.addElement(button);
397 if (oldColourScheme != null)
401 col = oldColourScheme.findColour(aa.charAt(0), -1, null);
402 } catch (Exception ex)
408 if (caseSensitive.isSelected())
410 button.setMargin(new java.awt.Insets(2, 2, 2, 2));
414 button.setMargin(new java.awt.Insets(2, 14, 2, 14));
417 button.setOpaque(true); // required for the next line to have effect
418 button.setBackground(col);
419 button.setText(label);
420 button.setForeground(col.darker().darker().darker());
421 button.setFont(new java.awt.Font("Verdana", Font.BOLD, 10));
432 protected void okButton_actionPerformed(ActionEvent e)
434 applyButton_actionPerformed(null);
438 frame.setClosed(true);
439 } catch (Exception ex)
450 protected void applyButton_actionPerformed(ActionEvent e)
452 UserColourScheme ucs = getSchemeFromButtons();
453 ucs.setName(schemeName.getText());
455 if (seqGroup != null)
458 ap.paintAlignment(true);
462 ap.alignFrame.changeColour(ucs);
464 else if (jmol != null)
466 jmol.setJalviewColourScheme(ucs);
470 UserColourScheme getSchemeFromButtons()
473 Color[] newColours = new Color[24];
475 for (int i = 0; i < 24; i++)
477 JButton button = (JButton) upperCaseButtons.elementAt(i);
478 newColours[i] = button.getBackground();
481 UserColourScheme ucs = new UserColourScheme(newColours);
483 if (caseSensitive.isSelected())
485 newColours = new Color[23];
486 for (int i = 0; i < 23; i++)
488 JButton button = (JButton) lowerCaseButtons.elementAt(i);
489 newColours[i] = button.getBackground();
491 ucs.setLowerCaseColours(newColours);
496 ucs.setThreshold(0, ap.av.getIgnoreGapsConsensus());
508 protected void loadbutton_actionPerformed(ActionEvent e)
510 upperCaseButtons = new Vector();
511 lowerCaseButtons = new Vector();
513 JalviewFileChooser chooser = new JalviewFileChooser(
514 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
515 { "jc" }, new String[]
516 { "Jalview User Colours" }, "Jalview User Colours");
517 chooser.setFileView(new jalview.io.JalviewFileView());
518 chooser.setDialogTitle(MessageManager
519 .getString("label.load_colour_scheme"));
520 chooser.setToolTipText(MessageManager.getString("action.load"));
522 int value = chooser.showOpenDialog(this);
524 if (value == JalviewFileChooser.APPROVE_OPTION)
526 File choice = chooser.getSelectedFile();
527 jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
528 String defaultColours = jalview.bin.Cache.getDefault(
529 "USER_DEFINED_COLOURS", choice.getPath());
530 if (defaultColours.indexOf(choice.getPath()) == -1)
532 defaultColours = defaultColours.concat("|")
533 .concat(choice.getPath());
536 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
538 UserColourScheme ucs = loadColours(choice.getAbsolutePath());
539 Color[] colors = ucs.getColours();
540 schemeName.setText(ucs.getName());
542 if (ucs.getLowerCaseColours() != null)
544 caseSensitive.setSelected(true);
545 lcaseColour.setEnabled(true);
546 resetButtonPanel(true);
547 for (int i = 0; i < lowerCaseButtons.size(); i++)
549 JButton button = (JButton) lowerCaseButtons.elementAt(i);
550 button.setBackground(ucs.getLowerCaseColours()[i]);
556 caseSensitive.setSelected(false);
557 lcaseColour.setEnabled(false);
558 resetButtonPanel(false);
561 for (int i = 0; i < upperCaseButtons.size(); i++)
563 JButton button = (JButton) upperCaseButtons.elementAt(i);
564 button.setBackground(colors[i]);
573 * @return DOCUMENT ME!
575 public static UserColourScheme loadDefaultColours()
577 UserColourScheme ret = null;
579 String colours = jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS");
582 if (colours.indexOf("|") > -1)
584 colours = colours.substring(0, colours.indexOf("|"));
587 ret = loadColours(colours);
592 Color[] newColours = new Color[24];
593 for (int i = 0; i < 24; i++)
595 newColours[i] = Color.white;
597 ret = new UserColourScheme(newColours);
609 * @return DOCUMENT ME!
611 static UserColourScheme loadColours(String file)
613 UserColourScheme ucs = null;
614 Color[] newColours = null;
617 InputStreamReader in = new InputStreamReader(
618 new FileInputStream(file), "UTF-8");
620 jalview.schemabinding.version2.JalviewUserColours jucs = new jalview.schemabinding.version2.JalviewUserColours();
622 org.exolab.castor.xml.Unmarshaller unmar = new org.exolab.castor.xml.Unmarshaller(
624 jucs = (jalview.schemabinding.version2.JalviewUserColours) unmar
627 newColours = new Color[24];
629 Color[] lowerCase = null;
630 boolean caseSensitive = false;
634 for (int i = 0; i < jucs.getColourCount(); i++)
636 name = jucs.getColour(i).getName();
637 if (ResidueProperties.aa3Hash.containsKey(name))
639 index = ((Integer) ResidueProperties.aa3Hash.get(name))
644 index = ResidueProperties.aaIndex[name.charAt(0)];
651 if (name.toLowerCase().equals(name))
653 if (lowerCase == null)
655 lowerCase = new Color[23];
657 caseSensitive = true;
658 lowerCase[index] = new Color(Integer.parseInt(jucs.getColour(i)
663 newColours[index] = new Color(Integer.parseInt(jucs.getColour(i)
668 if (newColours != null)
670 ucs = new UserColourScheme(newColours);
671 ucs.setName(jucs.getSchemeName());
674 ucs.setLowerCaseColours(lowerCase);
678 } catch (Exception ex)
680 // Could be Archive Jalview format
683 InputStreamReader in = new InputStreamReader(new FileInputStream(
686 jalview.binding.JalviewUserColours jucs = new jalview.binding.JalviewUserColours();
688 jucs = (jalview.binding.JalviewUserColours) jucs.unmarshal(in);
690 newColours = new Color[jucs.getColourCount()];
692 for (int i = 0; i < 24; i++)
694 newColours[i] = new Color(Integer.parseInt(jucs.getColour(i)
697 if (newColours != null)
699 ucs = new UserColourScheme(newColours);
700 ucs.setName(jucs.getSchemeName());
702 } catch (Exception ex2)
704 ex2.printStackTrace();
707 if (newColours == null)
709 System.out.println("Error loading User ColourFile\n" + ex);
722 protected void savebutton_actionPerformed(ActionEvent e)
724 if (schemeName.getText().trim().length() < 1)
726 JOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
727 .getString("label.user_colour_scheme_must_have_name"),
728 MessageManager.getString("label.no_name_colour_scheme"),
729 JOptionPane.WARNING_MESSAGE);
733 if (userColourSchemes != null
734 && userColourSchemes.containsKey(schemeName.getText()))
736 int reply = JOptionPane.showInternalConfirmDialog(Desktop.desktop,
737 MessageManager.formatMessage(
738 "label.colour_scheme_exists_overwrite", new String[]
739 { schemeName.getText(), schemeName.getText() }),
740 MessageManager.getString("label.duplicate_scheme_name"),
741 JOptionPane.YES_NO_OPTION);
742 if (reply != JOptionPane.YES_OPTION)
747 userColourSchemes.remove(schemeName.getText());
749 JalviewFileChooser chooser = new JalviewFileChooser(
750 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
751 { "jc" }, new String[]
752 { "Jalview User Colours" }, "Jalview User Colours");
754 chooser.setFileView(new jalview.io.JalviewFileView());
755 chooser.setDialogTitle("Save colour scheme");
756 chooser.setToolTipText(MessageManager.getString("action.save"));
758 int value = chooser.showSaveDialog(this);
760 if (value == JalviewFileChooser.APPROVE_OPTION)
762 String choice = chooser.getSelectedFile().getPath();
763 String defaultColours = jalview.bin.Cache.getDefault(
764 "USER_DEFINED_COLOURS", choice);
765 if (defaultColours.indexOf(choice) == -1)
767 if (defaultColours.length() > 0)
769 defaultColours = defaultColours.concat("|");
771 defaultColours = defaultColours.concat(choice);
774 userColourSchemes.put(schemeName.getText(), getSchemeFromButtons());
776 ap.alignFrame.updateUserColourMenu();
778 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
780 jalview.schemabinding.version2.JalviewUserColours ucs = new jalview.schemabinding.version2.JalviewUserColours();
782 ucs.setSchemeName(schemeName.getText());
785 PrintWriter out = new PrintWriter(new OutputStreamWriter(
786 new FileOutputStream(choice), "UTF-8"));
788 for (int i = 0; i < buttonPanel.getComponentCount(); i++)
790 JButton button = (JButton) buttonPanel.getComponent(i);
791 jalview.schemabinding.version2.Colour col = new jalview.schemabinding.version2.Colour();
792 col.setName(button.getText());
793 col.setRGB(jalview.util.Format.getHexString(button
800 } catch (Exception ex)
802 ex.printStackTrace();
813 protected void cancelButton_actionPerformed(ActionEvent e)
817 if (seqGroup != null)
819 seqGroup.cs = oldColourScheme;
823 ap.av.setGlobalColourScheme(oldColourScheme);
825 ap.paintAlignment(true);
830 jmol.setJalviewColourScheme(oldColourScheme);
835 frame.setClosed(true);
836 } catch (Exception ex)
841 static Hashtable userColourSchemes;
843 public static Hashtable getUserColourSchemes()
845 return userColourSchemes;
848 public static void initUserColourSchemes(String files)
850 userColourSchemes = new Hashtable();
852 if (files == null || files.length() == 0)
857 // In case colours can't be loaded, we'll remove them
858 // from the default list here.
859 StringBuffer coloursFound = new StringBuffer();
860 StringTokenizer st = new StringTokenizer(files, "|");
861 while (st.hasMoreElements())
863 String file = st.nextToken();
866 UserColourScheme ucs = loadColours(file);
869 if (coloursFound.length() > 0)
871 coloursFound.append("|");
873 coloursFound.append(file);
874 userColourSchemes.put(ucs.getName(), ucs);
876 } catch (Exception ex)
878 System.out.println("Error loading User ColourFile\n" + ex);
881 if (!files.equals(coloursFound.toString()))
883 if (coloursFound.toString().length() > 1)
885 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
886 coloursFound.toString());
890 jalview.bin.Cache.applicationProperties
891 .remove("USER_DEFINED_COLOURS");
896 public static void removeColourFromDefaults(String target)
898 // The only way to find colours by name is to load them in
899 // In case colours can't be loaded, we'll remove them
900 // from the default list here.
902 userColourSchemes = new Hashtable();
904 StringBuffer coloursFound = new StringBuffer();
905 StringTokenizer st = new StringTokenizer(
906 jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS"), "|");
908 while (st.hasMoreElements())
910 String file = st.nextToken();
913 UserColourScheme ucs = loadColours(file);
914 if (ucs != null && !ucs.getName().equals(target))
916 if (coloursFound.length() > 0)
918 coloursFound.append("|");
920 coloursFound.append(file);
921 userColourSchemes.put(ucs.getName(), ucs);
923 } catch (Exception ex)
925 System.out.println("Error loading User ColourFile\n" + ex);
929 if (coloursFound.toString().length() > 1)
931 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
932 coloursFound.toString());
936 jalview.bin.Cache.applicationProperties
937 .remove("USER_DEFINED_COLOURS");
942 public void caseSensitive_actionPerformed(ActionEvent e)
944 resetButtonPanel(caseSensitive.isSelected());
945 lcaseColour.setEnabled(caseSensitive.isSelected());
948 public void lcaseColour_actionPerformed(ActionEvent e)
950 if (selectedButtons == null)
952 selectedButtons = new Vector();
956 selectedButtons.clear();
958 selectedButtons.add(lcaseColour);