2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ 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.io.JalviewFileView;
27 import jalview.jbgui.GUserDefinedColours;
28 import jalview.schemes.ColourSchemeI;
29 import jalview.schemes.ResidueProperties;
30 import jalview.schemes.UserColourScheme;
31 import jalview.util.ColorUtils;
32 import jalview.util.MessageManager;
34 import java.awt.Color;
36 import java.awt.event.ActionEvent;
37 import java.awt.event.MouseEvent;
39 import java.io.FileInputStream;
40 import java.io.FileOutputStream;
41 import java.io.InputStreamReader;
42 import java.io.OutputStreamWriter;
43 import java.io.PrintWriter;
44 import java.util.ArrayList;
45 import java.util.Hashtable;
46 import java.util.StringTokenizer;
48 import javax.swing.JButton;
49 import javax.swing.JInternalFrame;
50 import javax.swing.event.ChangeEvent;
51 import javax.swing.event.ChangeListener;
54 * This panel allows the user to assign colours to Amino Acid residue codes, and
55 * save the colour scheme.
57 * @author Andrew Waterhouse
58 * @author Mungo Carstairs
60 public class UserDefinedColours extends GUserDefinedColours implements
63 private static final int MY_FRAME_HEIGHT = 420;
65 private static final int MY_FRAME_WIDTH = 810;
67 private static final int MY_FRAME_WIDTH_CASE_SENSITIVE = 970;
71 SequenceGroup seqGroup;
73 ArrayList<JButton> selectedButtons;
75 ColourSchemeI oldColourScheme;
79 JalviewStructureDisplayI jmol;
81 ArrayList<JButton> upperCaseButtons;
83 ArrayList<JButton> lowerCaseButtons;
86 * Creates a new UserDefinedColours object.
93 public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg)
97 lcaseColour.setEnabled(false);
102 if (seqGroup != null)
104 oldColourScheme = seqGroup.cs;
108 oldColourScheme = ap.av.getGlobalColourScheme();
111 if (oldColourScheme instanceof UserColourScheme)
113 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
114 if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null)
116 caseSensitive.setSelected(true);
117 lcaseColour.setEnabled(true);
118 resetButtonPanel(true);
122 resetButtonPanel(false);
127 resetButtonPanel(false);
133 public UserDefinedColours(JalviewStructureDisplayI jmol,
139 colorChooser.getSelectionModel().addChangeListener(this);
141 oldColourScheme = oldcs;
143 if (oldColourScheme instanceof UserColourScheme)
145 schemeName.setText(((UserColourScheme) oldColourScheme).getName());
148 resetButtonPanel(false);
156 colorChooser.getSelectionModel().addChangeListener(this);
157 frame = new JInternalFrame();
158 frame.setContentPane(this);
159 Desktop.addInternalFrame(frame,
160 MessageManager.getString("label.user_defined_colours"),
161 MY_FRAME_WIDTH, MY_FRAME_HEIGHT, true);
163 if (seqGroup != null)
165 frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")");
169 void resetButtonPanel(boolean caseSensitive)
171 buttonPanel.removeAll();
173 if (upperCaseButtons == null)
175 upperCaseButtons = new ArrayList<JButton>();
180 for (int i = 0; i < 20; i++)
184 label = ResidueProperties.aa[i];
188 label = ResidueProperties.aa2Triplet.get(ResidueProperties.aa[i])
192 button = makeButton(label, ResidueProperties.aa[i], upperCaseButtons,
195 buttonPanel.add(button);
198 buttonPanel.add(makeButton("B", "B", upperCaseButtons, 20));
199 buttonPanel.add(makeButton("Z", "Z", upperCaseButtons, 21));
200 buttonPanel.add(makeButton("X", "X", upperCaseButtons, 22));
201 buttonPanel.add(makeButton("Gap", "-", upperCaseButtons, 23));
205 gridLayout.setRows(6);
206 gridLayout.setColumns(4);
210 gridLayout.setRows(7);
212 gridLayout.setColumns(cols + 1);
214 if (lowerCaseButtons == null)
216 lowerCaseButtons = new ArrayList<JButton>();
219 for (int i = 0; i < 20; i++)
221 int row = i / cols + 1;
222 int index = (row * cols) + i;
223 button = makeButton(ResidueProperties.aa[i].toLowerCase(),
224 ResidueProperties.aa[i].toLowerCase(), lowerCaseButtons, i);
226 buttonPanel.add(button, index);
232 buttonPanel.add(makeButton("b", "b", lowerCaseButtons, 20));
233 buttonPanel.add(makeButton("z", "z", lowerCaseButtons, 21));
234 buttonPanel.add(makeButton("x", "x", lowerCaseButtons, 22));
237 // JAL-1360 widen the frame dynamically to accommodate case-sensitive AA
239 if (this.frame != null)
241 int newWidth = caseSensitive ? MY_FRAME_WIDTH_CASE_SENSITIVE
243 this.frame.setSize(newWidth, this.frame.getHeight());
246 buttonPanel.validate();
257 public void stateChanged(ChangeEvent evt)
259 if (selectedButtons != null)
261 JButton button = null;
262 final Color newColour = colorChooser.getColor();
263 for (int i = 0; i < selectedButtons.size(); i++)
265 button = selectedButtons.get(i);
266 button.setBackground(newColour);
267 button.setForeground(ColorUtils.brighterThan(newColour));
269 if (button == lcaseColour)
271 for (int i = 0; i < lowerCaseButtons.size(); i++)
273 button = lowerCaseButtons.get(i);
274 button.setBackground(newColour);
275 button.setForeground(ColorUtils.brighterThan(button
283 * Performs actions when a residue button is clicked. This manages the button
284 * selection set (highlighted by brighter foreground text).
286 * On select button(s) with Ctrl/click or Shift/click: set button foreground
287 * text to brighter than background.
289 * On unselect button(s) with Ctrl/click on selected, or click to release
290 * current selection: reset foreground text to darker than background.
292 * Simple click: clear selection (resetting foreground to darker); set clicked
293 * button foreground to brighter
295 * Finally, synchronize the colour chooser to the colour of the first button
296 * in the selected set.
300 public void colourButtonPressed(MouseEvent e)
302 if (selectedButtons == null)
304 selectedButtons = new ArrayList<JButton>();
307 JButton pressed = (JButton) e.getSource();
311 JButton start, end = (JButton) e.getSource();
312 if (selectedButtons.size() > 0)
314 start = selectedButtons.get(selectedButtons.size() - 1);
318 start = (JButton) e.getSource();
321 int startIndex = 0, endIndex = 0;
322 for (int b = 0; b < buttonPanel.getComponentCount(); b++)
324 if (buttonPanel.getComponent(b) == start)
328 if (buttonPanel.getComponent(b) == end)
334 if (startIndex > endIndex)
336 int temp = startIndex;
337 startIndex = endIndex;
341 for (int b = startIndex; b <= endIndex; b++)
343 JButton button = (JButton) buttonPanel.getComponent(b);
344 if (!selectedButtons.contains(button))
346 button.setForeground(ColorUtils.brighterThan(button
348 selectedButtons.add(button);
352 else if (!e.isControlDown())
354 for (int b = 0; b < selectedButtons.size(); b++)
356 JButton button = selectedButtons.get(b);
357 button.setForeground(ColorUtils.darkerThan(button.getBackground()));
359 selectedButtons.clear();
360 pressed.setForeground(ColorUtils.brighterThan(pressed.getBackground()));
361 selectedButtons.add(pressed);
364 else if (e.isControlDown())
366 if (selectedButtons.contains(pressed))
368 pressed.setForeground(ColorUtils.darkerThan(pressed.getBackground()));
369 selectedButtons.remove(pressed);
373 pressed.setForeground(ColorUtils.brighterThan(pressed
375 selectedButtons.add(pressed);
379 if (selectedButtons.size() > 0)
381 colorChooser.setColor((selectedButtons.get(0)).getBackground());
393 JButton makeButton(String label, String aa,
394 ArrayList<JButton> caseSensitiveButtons, int buttonIndex)
396 final JButton button;
399 if (buttonIndex < caseSensitiveButtons.size())
401 button = caseSensitiveButtons.get(buttonIndex);
402 col = button.getBackground();
406 button = new JButton();
407 button.addMouseListener(new java.awt.event.MouseAdapter()
410 public void mouseClicked(MouseEvent e)
412 colourButtonPressed(e);
416 caseSensitiveButtons.add(button);
419 if (oldColourScheme != null)
423 col = oldColourScheme.findColour(aa.charAt(0), -1, null);
424 } catch (Exception ex)
430 if (caseSensitive.isSelected())
432 button.setMargin(new java.awt.Insets(2, 2, 2, 2));
436 button.setMargin(new java.awt.Insets(2, 14, 2, 14));
439 button.setOpaque(true); // required for the next line to have effect
440 button.setBackground(col);
441 button.setText(label);
442 button.setForeground(ColorUtils.darkerThan(col));
443 button.setFont(new java.awt.Font("Verdana", Font.BOLD, 10));
455 protected void okButton_actionPerformed(ActionEvent e)
457 if (isNoSelectionMade())
459 JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager
460 .getString("label.no_colour_selection_in_scheme"),
461 MessageManager.getString("label.no_colour_selection_warn"),
462 JvOptionPane.WARNING_MESSAGE);
466 applyButton_actionPerformed(null);
470 frame.setClosed(true);
471 } catch (Exception ex)
478 * Returns true if the user has not made any colour selection (including if
479 * 'case-sensitive' selected and no lower-case colour chosen).
483 protected boolean isNoSelectionMade()
485 final boolean noUpperCaseSelected = upperCaseButtons == null
486 || upperCaseButtons.isEmpty();
487 final boolean noLowerCaseSelected = caseSensitive.isSelected()
488 && (lowerCaseButtons == null || lowerCaseButtons.isEmpty());
489 final boolean noSelectionMade = noUpperCaseSelected
490 || noLowerCaseSelected;
491 return noSelectionMade;
501 protected void applyButton_actionPerformed(ActionEvent e)
503 if (isNoSelectionMade())
505 JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager
506 .getString("label.no_colour_selection_in_scheme"),
507 MessageManager.getString("label.no_colour_selection_warn"),
508 JvOptionPane.WARNING_MESSAGE);
511 UserColourScheme ucs = getSchemeFromButtons();
512 ucs.setName(schemeName.getText());
514 if (seqGroup != null)
517 ap.paintAlignment(true);
521 ap.alignFrame.changeColour(ucs);
523 else if (jmol != null)
525 jmol.setJalviewColourScheme(ucs);
529 UserColourScheme getSchemeFromButtons()
532 Color[] newColours = new Color[24];
534 int length = upperCaseButtons.size();
538 for (JButton btn : upperCaseButtons)
540 newColours[i] = btn.getBackground();
546 for (int i = 0; i < 24; i++)
548 JButton button = upperCaseButtons.get(i);
549 newColours[i] = button.getBackground();
553 UserColourScheme ucs = new UserColourScheme(newColours);
555 if (caseSensitive.isSelected())
557 newColours = new Color[23];
558 length = lowerCaseButtons.size();
562 for (JButton btn : lowerCaseButtons)
564 newColours[i] = btn.getBackground();
570 for (int i = 0; i < 23; i++)
572 JButton button = lowerCaseButtons.get(i);
573 newColours[i] = button.getBackground();
576 ucs.setLowerCaseColours(newColours);
581 ucs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
594 protected void loadbutton_actionPerformed(ActionEvent e)
596 upperCaseButtons = new ArrayList<JButton>();
597 lowerCaseButtons = new ArrayList<JButton>();
599 JalviewFileChooser chooser = new JalviewFileChooser("jc",
600 "Jalview User Colours");
601 chooser.setFileView(new JalviewFileView());
602 chooser.setDialogTitle(MessageManager
603 .getString("label.load_colour_scheme"));
604 chooser.setToolTipText(MessageManager.getString("action.load"));
606 int value = chooser.showOpenDialog(this);
608 if (value == JalviewFileChooser.APPROVE_OPTION)
610 File choice = chooser.getSelectedFile();
611 jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice.getParent());
612 String defaultColours = jalview.bin.Cache.getDefault(
613 "USER_DEFINED_COLOURS", choice.getPath());
614 if (defaultColours.indexOf(choice.getPath()) == -1)
616 defaultColours = defaultColours.concat("|")
617 .concat(choice.getPath());
620 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
622 UserColourScheme ucs = loadColours(choice.getAbsolutePath());
623 Color[] colors = ucs.getColours();
624 schemeName.setText(ucs.getName());
626 if (ucs.getLowerCaseColours() != null)
628 caseSensitive.setSelected(true);
629 lcaseColour.setEnabled(true);
630 resetButtonPanel(true);
631 for (int i = 0; i < lowerCaseButtons.size(); i++)
633 JButton button = lowerCaseButtons.get(i);
634 button.setBackground(ucs.getLowerCaseColours()[i]);
640 caseSensitive.setSelected(false);
641 lcaseColour.setEnabled(false);
642 resetButtonPanel(false);
645 for (int i = 0; i < upperCaseButtons.size(); i++)
647 JButton button = upperCaseButtons.get(i);
648 button.setBackground(colors[i]);
657 * @return DOCUMENT ME!
659 public static UserColourScheme loadDefaultColours()
661 UserColourScheme ret = null;
663 String colours = jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS");
666 if (colours.indexOf("|") > -1)
668 colours = colours.substring(0, colours.indexOf("|"));
671 ret = loadColours(colours);
676 Color[] newColours = new Color[24];
677 for (int i = 0; i < 24; i++)
679 newColours[i] = Color.white;
681 ret = new UserColourScheme(newColours);
693 * @return DOCUMENT ME!
695 static UserColourScheme loadColours(String file)
697 UserColourScheme ucs = null;
698 Color[] newColours = null;
701 InputStreamReader in = new InputStreamReader(
702 new FileInputStream(file), "UTF-8");
704 jalview.schemabinding.version2.JalviewUserColours jucs = new jalview.schemabinding.version2.JalviewUserColours();
706 org.exolab.castor.xml.Unmarshaller unmar = new org.exolab.castor.xml.Unmarshaller(
708 jucs = (jalview.schemabinding.version2.JalviewUserColours) unmar
711 newColours = new Color[24];
713 Color[] lowerCase = null;
714 boolean caseSensitive = false;
718 for (int i = 0; i < jucs.getColourCount(); i++)
720 name = jucs.getColour(i).getName();
721 if (ResidueProperties.aa3Hash.containsKey(name))
723 index = ResidueProperties.aa3Hash.get(name).intValue();
727 index = ResidueProperties.aaIndex[name.charAt(0)];
734 if (name.toLowerCase().equals(name))
736 if (lowerCase == null)
738 lowerCase = new Color[23];
740 caseSensitive = true;
741 lowerCase[index] = new Color(Integer.parseInt(jucs.getColour(i)
746 newColours[index] = new Color(Integer.parseInt(jucs.getColour(i)
751 if (newColours != null)
753 ucs = new UserColourScheme(newColours);
754 ucs.setName(jucs.getSchemeName());
757 ucs.setLowerCaseColours(lowerCase);
761 } catch (Exception ex)
763 // Could be Archive Jalview format
766 InputStreamReader in = new InputStreamReader(new FileInputStream(
769 jalview.binding.JalviewUserColours jucs = new jalview.binding.JalviewUserColours();
771 jucs = jucs.unmarshal(in);
773 newColours = new Color[jucs.getColourCount()];
775 for (int i = 0; i < 24; i++)
777 newColours[i] = new Color(Integer.parseInt(jucs.getColour(i)
780 if (newColours != null)
782 ucs = new UserColourScheme(newColours);
783 ucs.setName(jucs.getSchemeName());
785 } catch (Exception ex2)
787 ex2.printStackTrace();
790 if (newColours == null)
792 System.out.println("Error loading User ColourFile\n" + ex);
806 protected void savebutton_actionPerformed(ActionEvent e)
808 if (schemeName.getText().trim().length() < 1)
810 JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
811 .getString("label.user_colour_scheme_must_have_name"),
812 MessageManager.getString("label.no_name_colour_scheme"),
813 JvOptionPane.WARNING_MESSAGE);
817 if (userColourSchemes != null
818 && userColourSchemes.containsKey(schemeName.getText()))
820 int reply = JvOptionPane.showInternalConfirmDialog(Desktop.desktop,
821 MessageManager.formatMessage(
822 "label.colour_scheme_exists_overwrite", new Object[] {
823 schemeName.getText(), schemeName.getText() }),
824 MessageManager.getString("label.duplicate_scheme_name"),
825 JvOptionPane.YES_NO_OPTION);
826 if (reply != JvOptionPane.YES_OPTION)
831 userColourSchemes.remove(schemeName.getText());
833 JalviewFileChooser chooser = new JalviewFileChooser("jc",
834 "Jalview User Colours");
836 chooser.setFileView(new JalviewFileView());
837 chooser.setDialogTitle(MessageManager
838 .getString("label.save_colour_scheme"));
839 chooser.setToolTipText(MessageManager.getString("action.save"));
841 int value = chooser.showSaveDialog(this);
843 if (value == JalviewFileChooser.APPROVE_OPTION)
845 String choice = chooser.getSelectedFile().getPath();
846 String defaultColours = jalview.bin.Cache.getDefault(
847 "USER_DEFINED_COLOURS", choice);
848 if (defaultColours.indexOf(choice) == -1)
850 if (defaultColours.length() > 0)
852 defaultColours = defaultColours.concat("|");
854 defaultColours = defaultColours.concat(choice);
857 userColourSchemes.put(schemeName.getText(), getSchemeFromButtons());
859 ap.alignFrame.updateUserColourMenu();
861 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS", defaultColours);
863 jalview.schemabinding.version2.JalviewUserColours ucs = new jalview.schemabinding.version2.JalviewUserColours();
865 ucs.setSchemeName(schemeName.getText());
868 PrintWriter out = new PrintWriter(new OutputStreamWriter(
869 new FileOutputStream(choice), "UTF-8"));
871 for (int i = 0; i < buttonPanel.getComponentCount(); i++)
873 JButton button = (JButton) buttonPanel.getComponent(i);
874 jalview.schemabinding.version2.Colour col = new jalview.schemabinding.version2.Colour();
875 col.setName(button.getText());
876 col.setRGB(jalview.util.Format.getHexString(button
883 } catch (Exception ex)
885 ex.printStackTrace();
897 protected void cancelButton_actionPerformed(ActionEvent e)
901 if (seqGroup != null)
903 seqGroup.cs = oldColourScheme;
907 ap.av.setGlobalColourScheme(oldColourScheme);
909 ap.paintAlignment(true);
914 jmol.setJalviewColourScheme(oldColourScheme);
919 frame.setClosed(true);
920 } catch (Exception ex)
925 static Hashtable userColourSchemes;
927 public static Hashtable getUserColourSchemes()
929 return userColourSchemes;
932 public static void initUserColourSchemes(String files)
934 userColourSchemes = new Hashtable();
936 if (files == null || files.length() == 0)
941 // In case colours can't be loaded, we'll remove them
942 // from the default list here.
943 StringBuffer coloursFound = new StringBuffer();
944 StringTokenizer st = new StringTokenizer(files, "|");
945 while (st.hasMoreElements())
947 String file = st.nextToken();
950 UserColourScheme ucs = loadColours(file);
953 if (coloursFound.length() > 0)
955 coloursFound.append("|");
957 coloursFound.append(file);
958 userColourSchemes.put(ucs.getName(), ucs);
960 } catch (Exception ex)
962 System.out.println("Error loading User ColourFile\n" + ex);
965 if (!files.equals(coloursFound.toString()))
967 if (coloursFound.toString().length() > 1)
969 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
970 coloursFound.toString());
974 jalview.bin.Cache.applicationProperties
975 .remove("USER_DEFINED_COLOURS");
980 public static void removeColourFromDefaults(String target)
982 // The only way to find colours by name is to load them in
983 // In case colours can't be loaded, we'll remove them
984 // from the default list here.
986 userColourSchemes = new Hashtable();
988 StringBuffer coloursFound = new StringBuffer();
989 StringTokenizer st = new StringTokenizer(
990 jalview.bin.Cache.getProperty("USER_DEFINED_COLOURS"), "|");
992 while (st.hasMoreElements())
994 String file = st.nextToken();
997 UserColourScheme ucs = loadColours(file);
998 if (ucs != null && !ucs.getName().equals(target))
1000 if (coloursFound.length() > 0)
1002 coloursFound.append("|");
1004 coloursFound.append(file);
1005 userColourSchemes.put(ucs.getName(), ucs);
1007 } catch (Exception ex)
1009 System.out.println("Error loading User ColourFile\n" + ex);
1013 if (coloursFound.toString().length() > 1)
1015 jalview.bin.Cache.setProperty("USER_DEFINED_COLOURS",
1016 coloursFound.toString());
1020 jalview.bin.Cache.applicationProperties
1021 .remove("USER_DEFINED_COLOURS");
1027 public void caseSensitive_actionPerformed(ActionEvent e)
1029 resetButtonPanel(caseSensitive.isSelected());
1030 lcaseColour.setEnabled(caseSensitive.isSelected());
1034 public void lcaseColour_actionPerformed(ActionEvent e)
1036 if (selectedButtons == null)
1038 selectedButtons = new ArrayList<JButton>();
1042 selectedButtons.clear();
1044 selectedButtons.add(lcaseColour);