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.datamodel.SequenceGroup;
24 import jalview.io.JalviewFileChooser;
25 import jalview.jbgui.GUserDefinedColours;
26 import jalview.schemes.ColourSchemeI;
27 import jalview.schemes.ResidueProperties;
28 import jalview.schemes.UserColourScheme;
29 import jalview.util.MessageManager;
31 import java.awt.Color;
33 import java.awt.event.ActionEvent;
34 import java.awt.event.MouseEvent;
36 import java.io.FileInputStream;
37 import java.io.FileOutputStream;
38 import java.io.InputStreamReader;
39 import java.io.OutputStreamWriter;
40 import java.io.PrintWriter;
41 import java.util.Hashtable;
42 import java.util.StringTokenizer;
43 import java.util.Vector;
45 import javax.swing.JButton;
46 import javax.swing.JInternalFrame;
47 import javax.swing.JOptionPane;
48 import javax.swing.event.ChangeEvent;
49 import javax.swing.event.ChangeListener;
57 public class UserDefinedColours extends GUserDefinedColours implements
62 SequenceGroup seqGroup;
64 Vector selectedButtons;
66 ColourSchemeI oldColourScheme;
72 Vector upperCaseButtons;
74 Vector lowerCaseButtons;
77 * Creates a new UserDefinedColours object.
84 public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg)
88 lcaseColour.setEnabled(false);
95 oldColourScheme = seqGroup.cs;
99 oldColourScheme = ap.av.getGlobalColourScheme();
102 if (oldColourScheme instanceof UserColourScheme)
104 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
105 if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null)
107 caseSensitive.setSelected(true);
108 lcaseColour.setEnabled(true);
109 resetButtonPanel(true);
113 resetButtonPanel(false);
118 resetButtonPanel(false);
124 public UserDefinedColours(AppJmol jmol, ColourSchemeI oldcs)
129 colorChooser.getSelectionModel().addChangeListener(this);
131 oldColourScheme = oldcs;
133 if (oldColourScheme instanceof UserColourScheme)
135 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
138 resetButtonPanel(false);
146 colorChooser.getSelectionModel().addChangeListener(this);
147 frame = new JInternalFrame();
148 frame.setContentPane(this);
149 Desktop.addInternalFrame(frame, MessageManager.getString("label.user_defined_colours"), 720, 370, true);
151 if (seqGroup != null)
153 frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")");
156 if (new jalview.util.Platform().isAMac())
158 frame.setSize(760, 370);
162 void resetButtonPanel(boolean caseSensitive)
164 buttonPanel.removeAll();
166 if (upperCaseButtons == null)
168 upperCaseButtons = new Vector();
173 for (int i = 0; i < 20; i++)
177 label = ResidueProperties.aa[i];
181 label = ResidueProperties.aa2Triplet.get(ResidueProperties.aa[i])
185 button = makeButton(label, ResidueProperties.aa[i], upperCaseButtons,
188 buttonPanel.add(button);
191 buttonPanel.add(makeButton("B", "B", upperCaseButtons, 20));
192 buttonPanel.add(makeButton("Z", "Z", upperCaseButtons, 21));
193 buttonPanel.add(makeButton("X", "X", upperCaseButtons, 22));
194 buttonPanel.add(makeButton("Gap", "-", upperCaseButtons, 23));
198 gridLayout.setRows(6);
199 gridLayout.setColumns(4);
203 gridLayout.setRows(7);
205 gridLayout.setColumns(cols + 1);
207 if (lowerCaseButtons == null)
209 lowerCaseButtons = new Vector();
212 for (int i = 0; i < 20; i++)
214 int row = i / cols + 1;
215 int index = (row * cols) + i;
216 button = makeButton(ResidueProperties.aa[i].toLowerCase(),
217 ResidueProperties.aa[i].toLowerCase(), lowerCaseButtons, i);
219 buttonPanel.add(button, index);
225 buttonPanel.add(makeButton("b", "b", lowerCaseButtons, 20));
226 buttonPanel.add(makeButton("z", "z", lowerCaseButtons, 21));
227 buttonPanel.add(makeButton("x", "x", lowerCaseButtons, 22));
230 buttonPanel.validate();
240 public void stateChanged(ChangeEvent evt)
242 if (selectedButtons != null)
244 JButton button = null;
245 for (int i = 0; i < selectedButtons.size(); i++)
247 button = (JButton) selectedButtons.elementAt(i);
248 button.setBackground(colorChooser.getColor());
249 button.setForeground(button.getBackground().brighter().brighter()
252 if (button == lcaseColour)
254 for (int i = 0; i < lowerCaseButtons.size(); i++)
256 button = (JButton) lowerCaseButtons.elementAt(i);
257 button.setBackground(colorChooser.getColor());
258 button.setForeground(button.getBackground().brighter().brighter()
271 public void colourButtonPressed(MouseEvent e)
273 if (selectedButtons == null)
275 selectedButtons = new Vector();
278 JButton pressed = (JButton) e.getSource();
282 JButton start, end = (JButton) e.getSource();
283 if (selectedButtons.size() > 0)
285 start = (JButton) selectedButtons
286 .elementAt(selectedButtons.size() - 1);
290 start = (JButton) e.getSource();
293 int startIndex = 0, endIndex = 0;
294 for (int b = 0; b < buttonPanel.getComponentCount(); b++)
296 if (buttonPanel.getComponent(b) == start)
300 if (buttonPanel.getComponent(b) == end)
306 if (startIndex > endIndex)
308 int temp = startIndex;
309 startIndex = endIndex;
313 for (int b = startIndex; b <= endIndex; b++)
315 JButton button = (JButton) buttonPanel.getComponent(b);
316 if (!selectedButtons.contains(button))
318 button.setForeground(button.getBackground().brighter().brighter());
319 selectedButtons.add(button);
323 else if (!e.isControlDown())
325 for (int b = 0; b < selectedButtons.size(); b++)
327 JButton button = (JButton) selectedButtons.elementAt(b);
328 button.setForeground(button.getBackground().darker().darker());
330 selectedButtons.clear();
331 pressed.setForeground(pressed.getBackground().brighter().brighter());
332 selectedButtons.addElement(pressed);
335 else if (e.isControlDown())
337 if (selectedButtons.contains(pressed))
339 pressed.setForeground(pressed.getBackground().darker().darker());
340 selectedButtons.remove(pressed);
344 pressed.setForeground(pressed.getBackground().brighter().brighter());
345 selectedButtons.addElement(pressed);
349 if (selectedButtons.size() > 0)
351 colorChooser.setColor(((JButton) selectedButtons.elementAt(0))
364 JButton makeButton(String label, String aa, Vector caseSensitiveButtons,
367 final JButton button;
370 if (buttonIndex < caseSensitiveButtons.size())
372 button = (JButton) caseSensitiveButtons.elementAt(buttonIndex);
373 col = button.getBackground();
377 button = new JButton();
378 button.addMouseListener(new java.awt.event.MouseAdapter()
380 public void mouseClicked(MouseEvent e)
382 colourButtonPressed(e);
386 caseSensitiveButtons.addElement(button);
389 if (oldColourScheme != null)
393 col = oldColourScheme.findColour(aa.charAt(0), -1, null);
394 } catch (Exception ex)
400 if (caseSensitive.isSelected())
402 button.setMargin(new java.awt.Insets(2, 2, 2, 2));
406 button.setMargin(new java.awt.Insets(2, 14, 2, 14));
409 button.setBackground(col);
410 button.setText(label);
411 button.setForeground(col.darker().darker().darker());
412 button.setFont(new java.awt.Font("Verdana", Font.BOLD, 10));
423 protected void okButton_actionPerformed(ActionEvent e)
425 applyButton_actionPerformed(null);
429 frame.setClosed(true);
430 } catch (Exception ex)
441 protected void applyButton_actionPerformed(ActionEvent e)
443 UserColourScheme ucs = getSchemeFromButtons();
444 ucs.setName(schemeName.getText());
446 if (seqGroup != null)
449 ap.paintAlignment(true);
453 ap.alignFrame.changeColour(ucs);
455 else if (jmol != null)
457 jmol.setJalviewColourScheme(ucs);
461 UserColourScheme getSchemeFromButtons()
464 Color[] newColours = new Color[24];
466 for (int i = 0; i < 24; i++)
468 JButton button = (JButton) upperCaseButtons.elementAt(i);
469 newColours[i] = button.getBackground();
472 UserColourScheme ucs = new UserColourScheme(newColours);
474 if (caseSensitive.isSelected())
476 newColours = new Color[23];
477 for (int i = 0; i < 23; i++)
479 JButton button = (JButton) lowerCaseButtons.elementAt(i);
480 newColours[i] = button.getBackground();
482 ucs.setLowerCaseColours(newColours);
487 ucs.setThreshold(0, ap.av.getIgnoreGapsConsensus());
499 protected void loadbutton_actionPerformed(ActionEvent e)
501 upperCaseButtons = new Vector();
502 lowerCaseButtons = new Vector();
504 JalviewFileChooser chooser = new JalviewFileChooser(
505 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
506 { "jc" }, new String[]
507 { "Jalview User Colours" }, "Jalview User Colours");
508 chooser.setFileView(new jalview.io.JalviewFileView());
509 chooser.setDialogTitle(MessageManager.getString("label.load_colour_scheme"));
510 chooser.setToolTipText(MessageManager.getString("action.load"));
512 int value = chooser.showOpenDialog(this);
514 if (value == JalviewFileChooser.APPROVE_OPTION)
516 File choice = chooser.getSelectedFile();
517 jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
518 String defaultColours = jalview.bin.Cache.getDefault(
519 "USER_DEFINED_COLOURS", choice.getPath());
520 if (defaultColours.indexOf(choice.getPath()) == -1)
522 defaultColours = defaultColours.concat("|")
523 .concat(choice.getPath());
526 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
528 UserColourScheme ucs = loadColours(choice.getAbsolutePath());
529 Color[] colors = ucs.getColours();
530 schemeName.setText(ucs.getName());
532 if (ucs.getLowerCaseColours() != null)
534 caseSensitive.setSelected(true);
535 lcaseColour.setEnabled(true);
536 resetButtonPanel(true);
537 for (int i = 0; i < lowerCaseButtons.size(); i++)
539 JButton button = (JButton) lowerCaseButtons.elementAt(i);
540 button.setBackground(ucs.getLowerCaseColours()[i]);
546 caseSensitive.setSelected(false);
547 lcaseColour.setEnabled(false);
548 resetButtonPanel(false);
551 for (int i = 0; i < upperCaseButtons.size(); i++)
553 JButton button = (JButton) upperCaseButtons.elementAt(i);
554 button.setBackground(colors[i]);
563 * @return DOCUMENT ME!
565 public static UserColourScheme loadDefaultColours()
567 UserColourScheme ret = null;
569 String colours = jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS");
572 if (colours.indexOf("|") > -1)
574 colours = colours.substring(0, colours.indexOf("|"));
577 ret = loadColours(colours);
582 Color[] newColours = new Color[24];
583 for (int i = 0; i < 24; i++)
585 newColours[i] = Color.white;
587 ret = new UserColourScheme(newColours);
599 * @return DOCUMENT ME!
601 static UserColourScheme loadColours(String file)
603 UserColourScheme ucs = null;
604 Color[] newColours = null;
607 InputStreamReader in = new InputStreamReader(
608 new FileInputStream(file), "UTF-8");
610 jalview.schemabinding.version2.JalviewUserColours jucs = new jalview.schemabinding.version2.JalviewUserColours();
612 org.exolab.castor.xml.Unmarshaller unmar = new org.exolab.castor.xml.Unmarshaller(
614 jucs = (jalview.schemabinding.version2.JalviewUserColours) unmar
617 newColours = new Color[24];
619 Color[] lowerCase = null;
620 boolean caseSensitive = false;
624 for (int i = 0; i < jucs.getColourCount(); i++)
626 name = jucs.getColour(i).getName();
627 if (ResidueProperties.aa3Hash.containsKey(name))
629 index = ((Integer) ResidueProperties.aa3Hash.get(name))
634 index = ResidueProperties.aaIndex[name.charAt(0)];
641 if (name.toLowerCase().equals(name))
643 if (lowerCase == null)
645 lowerCase = new Color[23];
647 caseSensitive = true;
648 lowerCase[index] = new Color(Integer.parseInt(jucs.getColour(i)
653 newColours[index] = new Color(Integer.parseInt(jucs.getColour(i)
658 if (newColours != null)
660 ucs = new UserColourScheme(newColours);
661 ucs.setName(jucs.getSchemeName());
664 ucs.setLowerCaseColours(lowerCase);
668 } catch (Exception ex)
670 // Could be Archive Jalview format
673 InputStreamReader in = new InputStreamReader(new FileInputStream(
676 jalview.binding.JalviewUserColours jucs = new jalview.binding.JalviewUserColours();
678 jucs = (jalview.binding.JalviewUserColours) jucs.unmarshal(in);
680 newColours = new Color[jucs.getColourCount()];
682 for (int i = 0; i < 24; i++)
684 newColours[i] = new Color(Integer.parseInt(jucs.getColour(i)
687 if (newColours != null)
689 ucs = new UserColourScheme(newColours);
690 ucs.setName(jucs.getSchemeName());
692 } catch (Exception ex2)
694 ex2.printStackTrace();
697 if (newColours == null)
699 System.out.println("Error loading User ColourFile\n" + ex);
712 protected void savebutton_actionPerformed(ActionEvent e)
714 if (schemeName.getText().trim().length() < 1)
716 JOptionPane.showInternalMessageDialog(Desktop.desktop,
717 MessageManager.getString("label.user_colour_scheme_must_have_name"),
718 MessageManager.getString("label.no_name_colour_scheme"), JOptionPane.WARNING_MESSAGE);
722 if (userColourSchemes != null
723 && userColourSchemes.containsKey(schemeName.getText()))
725 int reply = JOptionPane.showInternalConfirmDialog(
727 MessageManager.formatMessage("label.colour_scheme_exists_overwrite", new String[]{schemeName.getText(),schemeName.getText()}),
728 MessageManager.getString("label.duplicate_scheme_name"), JOptionPane.YES_NO_OPTION);
729 if (reply != JOptionPane.YES_OPTION)
734 userColourSchemes.remove(schemeName.getText());
736 JalviewFileChooser chooser = new JalviewFileChooser(
737 jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
738 { "jc" }, new String[]
739 { "Jalview User Colours" }, "Jalview User Colours");
741 chooser.setFileView(new jalview.io.JalviewFileView());
742 chooser.setDialogTitle("Save colour scheme");
743 chooser.setToolTipText(MessageManager.getString("action.save"));
745 int value = chooser.showSaveDialog(this);
747 if (value == JalviewFileChooser.APPROVE_OPTION)
749 String choice = chooser.getSelectedFile().getPath();
750 String defaultColours = jalview.bin.Cache.getDefault(
751 "USER_DEFINED_COLOURS", choice);
752 if (defaultColours.indexOf(choice) == -1)
754 if (defaultColours.length() > 0)
756 defaultColours = defaultColours.concat("|");
758 defaultColours = defaultColours.concat(choice);
761 userColourSchemes.put(schemeName.getText(), getSchemeFromButtons());
763 ap.alignFrame.updateUserColourMenu();
765 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
767 jalview.schemabinding.version2.JalviewUserColours ucs = new jalview.schemabinding.version2.JalviewUserColours();
769 ucs.setSchemeName(schemeName.getText());
772 PrintWriter out = new PrintWriter(new OutputStreamWriter(
773 new FileOutputStream(choice), "UTF-8"));
775 for (int i = 0; i < buttonPanel.getComponentCount(); i++)
777 JButton button = (JButton) buttonPanel.getComponent(i);
778 jalview.schemabinding.version2.Colour col = new jalview.schemabinding.version2.Colour();
779 col.setName(button.getText());
780 col.setRGB(jalview.util.Format.getHexString(button
787 } catch (Exception ex)
789 ex.printStackTrace();
800 protected void cancelButton_actionPerformed(ActionEvent e)
804 if (seqGroup != null)
806 seqGroup.cs = oldColourScheme;
810 ap.av.setGlobalColourScheme(oldColourScheme);
812 ap.paintAlignment(true);
817 jmol.setJalviewColourScheme(oldColourScheme);
822 frame.setClosed(true);
823 } catch (Exception ex)
828 static Hashtable userColourSchemes;
830 public static Hashtable getUserColourSchemes()
832 return userColourSchemes;
835 public static void initUserColourSchemes(String files)
837 userColourSchemes = new Hashtable();
839 if (files == null || files.length() == 0)
844 // In case colours can't be loaded, we'll remove them
845 // from the default list here.
846 StringBuffer coloursFound = new StringBuffer();
847 StringTokenizer st = new StringTokenizer(files, "|");
848 while (st.hasMoreElements())
850 String file = st.nextToken();
853 UserColourScheme ucs = loadColours(file);
856 if (coloursFound.length() > 0)
858 coloursFound.append("|");
860 coloursFound.append(file);
861 userColourSchemes.put(ucs.getName(), ucs);
863 } catch (Exception ex)
865 System.out.println("Error loading User ColourFile\n" + ex);
868 if (!files.equals(coloursFound.toString()))
870 if (coloursFound.toString().length() > 1)
872 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
873 coloursFound.toString());
877 jalview.bin.Cache.applicationProperties
878 .remove("USER_DEFINED_COLOURS");
883 public static void removeColourFromDefaults(String target)
885 // The only way to find colours by name is to load them in
886 // In case colours can't be loaded, we'll remove them
887 // from the default list here.
889 userColourSchemes = new Hashtable();
891 StringBuffer coloursFound = new StringBuffer();
892 StringTokenizer st = new StringTokenizer(
893 jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS"), "|");
895 while (st.hasMoreElements())
897 String file = st.nextToken();
900 UserColourScheme ucs = loadColours(file);
901 if (ucs != null && !ucs.getName().equals(target))
903 if (coloursFound.length() > 0)
905 coloursFound.append("|");
907 coloursFound.append(file);
908 userColourSchemes.put(ucs.getName(), ucs);
910 } catch (Exception ex)
912 System.out.println("Error loading User ColourFile\n" + ex);
916 if (coloursFound.toString().length() > 1)
918 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
919 coloursFound.toString());
923 jalview.bin.Cache.applicationProperties
924 .remove("USER_DEFINED_COLOURS");
929 public void caseSensitive_actionPerformed(ActionEvent e)
931 resetButtonPanel(caseSensitive.isSelected());
932 lcaseColour.setEnabled(caseSensitive.isSelected());
935 public void lcaseColour_actionPerformed(ActionEvent e)
937 if (selectedButtons == null)
939 selectedButtons = new Vector();
943 selectedButtons.clear();
945 selectedButtons.add(lcaseColour);