src/jalview/gui/UserDefinedColours.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.api.structures.JalviewStructureDisplayI;
  24 import jalview.bin.Cache;
  25 import jalview.datamodel.SequenceGroup;
  26 import jalview.io.JalviewFileChooser;
  27 import jalview.io.JalviewFileView;
  28 import jalview.jbgui.GUserDefinedColours;
  29 import jalview.schemabinding.version2.Colour;
  30 import jalview.schemabinding.version2.JalviewUserColours;
  31 import jalview.schemes.ColourSchemeI;
  32 import jalview.schemes.ColourSchemes;
  33 import jalview.schemes.ResidueProperties;
  34 import jalview.schemes.UserColourScheme;
  35 import jalview.util.ColorUtils;
  36 import jalview.util.Format;
  37 import jalview.util.MessageManager;
  38
  39 import java.awt.Color;
  40 import java.awt.Font;
  41 import java.awt.Insets;
  42 import java.awt.event.ActionEvent;
  43 import java.awt.event.MouseAdapter;
  44 import java.awt.event.MouseEvent;
  45 import java.io.File;
  46 import java.io.FileOutputStream;
  47 import java.io.OutputStreamWriter;
  48 import java.io.PrintWriter;
  49 import java.util.ArrayList;
  50 import java.util.List;
  51
  52 import javax.swing.JButton;
  53 import javax.swing.JInternalFrame;
  54 import javax.swing.event.ChangeEvent;
  55 import javax.swing.event.ChangeListener;
  56
  57 /**
  58  * This panel allows the user to assign colours to Amino Acid residue codes, and
  59  * save the colour scheme.
  60  *
  61  * @author Andrew Waterhouse
  62  * @author Mungo Carstairs
  63  */
  64 public class UserDefinedColours extends GUserDefinedColours implements
  65         ChangeListener
  66 {
  67   private static final Font VERDANA_BOLD_10 = new Font("Verdana",
  68           Font.BOLD, 10);
  69
  70   public static final String USER_DEFINED_COLOURS = "USER_DEFINED_COLOURS";
  71
  72   private static final String LAST_DIRECTORY = "LAST_DIRECTORY";
  73
  74   private static final int MY_FRAME_HEIGHT = 420;
  75
  76   private static final int MY_FRAME_WIDTH = 810;
  77
  78   private static final int MY_FRAME_WIDTH_CASE_SENSITIVE = 970;
  79
  80   AlignmentPanel ap;
  81
  82   SequenceGroup seqGroup;
  83
  84   List<JButton> selectedButtons;
  85
  86   ColourSchemeI oldColourScheme;
  87
  88   JInternalFrame frame;
  89
  90   JalviewStructureDisplayI structureViewer;
  91
  92   List<JButton> upperCaseButtons;
  93
  94   List<JButton> lowerCaseButtons;
  95
  96   /**
  97    * Creates a new UserDefinedColours object.
  98    *
  99    * @param ap
 100    * @param sg
 101    */
 102   public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg)
 103   {
 104     super();
 105
 106     lcaseColour.setEnabled(false);
 107
 108     this.ap = ap;
 109     seqGroup = sg;
 110
 111     if (seqGroup != null)
 112     {
 113       oldColourScheme = seqGroup.cs;
 114     }
 115     else
 116     {
 117       oldColourScheme = ap.av.getGlobalColourScheme();
 118     }
 119
 120     if (oldColourScheme instanceof UserColourScheme)
 121     {
 122       schemeName.setText(oldColourScheme.getSchemeName());
 123       if (((UserColourScheme) oldColourScheme).getLowerCaseColours() != null)
 124       {
 125         caseSensitive.setSelected(true);
 126         lcaseColour.setEnabled(true);
 127         resetButtonPanel(true);
 128       }
 129       else
 130       {
 131         resetButtonPanel(false);
 132       }
 133     }
 134     else
 135     {
 136       resetButtonPanel(false);
 137     }
 138
 139     showFrame();
 140   }
 141
 142   public UserDefinedColours(JalviewStructureDisplayI viewer,
 143           ColourSchemeI oldcs)
 144   {
 145     super();
 146     this.structureViewer = viewer;
 147
 148     colorChooser.getSelectionModel().addChangeListener(this);
 149
 150     oldColourScheme = oldcs;
 151
 152     if (oldColourScheme instanceof UserColourScheme)
 153     {
 154       schemeName.setText(((UserColourScheme) oldColourScheme)
 155               .getSchemeName());
 156     }
 157
 158     resetButtonPanel(false);
 159
 160     showFrame();
 161
 162   }
 163
 164   void showFrame()
 165   {
 166     colorChooser.getSelectionModel().addChangeListener(this);
 167     frame = new JInternalFrame();
 168     frame.setContentPane(this);
 169     Desktop.addInternalFrame(frame,
 170             MessageManager.getString("label.user_defined_colours"),
 171             MY_FRAME_WIDTH, MY_FRAME_HEIGHT, true);
 172
 173     if (seqGroup != null)
 174     {
 175       frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")");
 176     }
 177   }
 178
 179   /**
 180    * Rebuilds the panel with coloured buttons for residues. If not case
 181    * sensitive colours, show 3-letter amino acid code as button text. If case
 182    * sensitive, just show the single letter code, in order to make space for the
 183    * additional buttons.
 184    *
 185    * @param isCaseSensitive
 186    */
 187   void resetButtonPanel(boolean isCaseSensitive)
 188   {
 189     buttonPanel.removeAll();
 190
 191     if (upperCaseButtons == null)
 192     {
 193       upperCaseButtons = new ArrayList<JButton>();
 194     }
 195
 196     for (int i = 0; i < 20; i++)
 197     {
 198       String label = isCaseSensitive ? ResidueProperties.aa[i]
 199               : ResidueProperties.aa2Triplet.get(ResidueProperties.aa[i])
 200                       .toString();
 201       JButton button = makeButton(label, ResidueProperties.aa[i],
 202               upperCaseButtons, i);
 203       buttonPanel.add(button);
 204     }
 205
 206     buttonPanel.add(makeButton("B", "B", upperCaseButtons, 20));
 207     buttonPanel.add(makeButton("Z", "Z", upperCaseButtons, 21));
 208     buttonPanel.add(makeButton("X", "X", upperCaseButtons, 22));
 209     buttonPanel.add(makeButton("Gap", "-", upperCaseButtons, 23));
 210
 211     if (!isCaseSensitive)
 212     {
 213       gridLayout.setRows(6);
 214       gridLayout.setColumns(4);
 215     }
 216     else
 217     {
 218       gridLayout.setRows(7);
 219       int cols = 7;
 220       gridLayout.setColumns(cols + 1);
 221
 222       if (lowerCaseButtons == null)
 223       {
 224         lowerCaseButtons = new ArrayList<JButton>();
 225       }
 226
 227       for (int i = 0; i < 20; i++)
 228       {
 229         int row = i / cols + 1;
 230         int index = (row * cols) + i;
 231         JButton button = makeButton(ResidueProperties.aa[i].toLowerCase(),
 232                 ResidueProperties.aa[i].toLowerCase(), lowerCaseButtons, i);
 233
 234         buttonPanel.add(button, index);
 235       }
 236     }
 237
 238     if (isCaseSensitive)
 239     {
 240       buttonPanel.add(makeButton("b", "b", lowerCaseButtons, 20));
 241       buttonPanel.add(makeButton("z", "z", lowerCaseButtons, 21));
 242       buttonPanel.add(makeButton("x", "x", lowerCaseButtons, 22));
 243     }
 244
 245     // JAL-1360 widen the frame dynamically to accommodate case-sensitive AA
 246     // codes
 247     if (this.frame != null)
 248     {
 249       int newWidth = isCaseSensitive ? MY_FRAME_WIDTH_CASE_SENSITIVE
 250               : MY_FRAME_WIDTH;
 251       this.frame.setSize(newWidth, this.frame.getHeight());
 252     }
 253
 254     buttonPanel.validate();
 255     validate();
 256   }
 257
 258   /**
 259    * DOCUMENT ME!
 260    *
 261    * @param evt
 262    *          DOCUMENT ME!
 263    */
 264   @Override
 265   public void stateChanged(ChangeEvent evt)
 266   {
 267     if (selectedButtons != null)
 268     {
 269       JButton button = null;
 270       final Color newColour = colorChooser.getColor();
 271       for (int i = 0; i < selectedButtons.size(); i++)
 272       {
 273         button = selectedButtons.get(i);
 274         button.setBackground(newColour);
 275         button.setForeground(ColorUtils.brighterThan(newColour));
 276       }
 277       if (button == lcaseColour)
 278       {
 279         for (int i = 0; i < lowerCaseButtons.size(); i++)
 280         {
 281           button = lowerCaseButtons.get(i);
 282           button.setBackground(newColour);
 283           button.setForeground(ColorUtils.brighterThan(button
 284                   .getBackground()));
 285         }
 286       }
 287     }
 288   }
 289
 290   /**
 291    * Performs actions when a residue button is clicked. This manages the button
 292    * selection set (highlighted by brighter foreground text).
 293    * <p>
 294    * On select button(s) with Ctrl/click or Shift/click: set button foreground
 295    * text to brighter than background.
 296    * <p>
 297    * On unselect button(s) with Ctrl/click on selected, or click to release
 298    * current selection: reset foreground text to darker than background.
 299    * <p>
 300    * Simple click: clear selection (resetting foreground to darker); set clicked
 301    * button foreground to brighter
 302    * <p>
 303    * Finally, synchronize the colour chooser to the colour of the first button
 304    * in the selected set.
 305    *
 306    * @param e
 307    */
 308   public void colourButtonPressed(MouseEvent e)
 309   {
 310     if (selectedButtons == null)
 311     {
 312       selectedButtons = new ArrayList<JButton>();
 313     }
 314
 315     JButton pressed = (JButton) e.getSource();
 316
 317     if (e.isShiftDown())
 318     {
 319       JButton start, end = (JButton) e.getSource();
 320       if (selectedButtons.size() > 0)
 321       {
 322         start = selectedButtons.get(selectedButtons.size() - 1);
 323       }
 324       else
 325       {
 326         start = (JButton) e.getSource();
 327       }
 328
 329       int startIndex = 0, endIndex = 0;
 330       for (int b = 0; b < buttonPanel.getComponentCount(); b++)
 331       {
 332         if (buttonPanel.getComponent(b) == start)
 333         {
 334           startIndex = b;
 335         }
 336         if (buttonPanel.getComponent(b) == end)
 337         {
 338           endIndex = b;
 339         }
 340       }
 341
 342       if (startIndex > endIndex)
 343       {
 344         int temp = startIndex;
 345         startIndex = endIndex;
 346         endIndex = temp;
 347       }
 348
 349       for (int b = startIndex; b <= endIndex; b++)
 350       {
 351         JButton button = (JButton) buttonPanel.getComponent(b);
 352         if (!selectedButtons.contains(button))
 353         {
 354           button.setForeground(ColorUtils.brighterThan(button
 355                   .getBackground()));
 356           selectedButtons.add(button);
 357         }
 358       }
 359     }
 360     else if (!e.isControlDown())
 361     {
 362       for (int b = 0; b < selectedButtons.size(); b++)
 363       {
 364         JButton button = selectedButtons.get(b);
 365         button.setForeground(ColorUtils.darkerThan(button.getBackground()));
 366       }
 367       selectedButtons.clear();
 368       pressed.setForeground(ColorUtils.brighterThan(pressed.getBackground()));
 369       selectedButtons.add(pressed);
 370
 371     }
 372     else if (e.isControlDown())
 373     {
 374       if (selectedButtons.contains(pressed))
 375       {
 376         pressed.setForeground(ColorUtils.darkerThan(pressed.getBackground()));
 377         selectedButtons.remove(pressed);
 378       }
 379       else
 380       {
 381         pressed.setForeground(ColorUtils.brighterThan(pressed
 382                 .getBackground()));
 383         selectedButtons.add(pressed);
 384       }
 385     }
 386
 387     if (selectedButtons.size() > 0)
 388     {
 389       colorChooser.setColor((selectedButtons.get(0)).getBackground());
 390     }
 391   }
 392
 393   /**
 394    * A helper method to update or make a colour button, whose background colour
 395    * is the associated colour, and text colour a darker shade of the same. If
 396    * the button is already in the list, then its text and margins are updated,
 397    * if not then it is created and added. This method supports toggling between
 398    * case-sensitive and case-insensitive button panels. The case-sensitive
 399    * version has abbreviated button text in order to fit in more buttons.
 400    *
 401    * @param label
 402    * @param residue
 403    * @param the
 404    *          list of buttons
 405    * @param buttonIndex
 406    *          the button's position in the list
 407    */
 408   JButton makeButton(String label, String residue, List<JButton> buttons,
 409           int buttonIndex)
 410   {
 411     final JButton button;
 412     Color col;
 413
 414     if (buttonIndex < buttons.size())
 415     {
 416       button = buttons.get(buttonIndex);
 417       col = button.getBackground();
 418     }
 419     else
 420     {
 421       button = new JButton();
 422       button.addMouseListener(new MouseAdapter()
 423       {
 424         @Override
 425         public void mouseClicked(MouseEvent e)
 426         {
 427           colourButtonPressed(e);
 428         }
 429       });
 430
 431       buttons.add(button);
 432
 433       /*
 434        * make initial button colour that of the current colour scheme,
 435        * if it is a simple per-residue colouring, else white
 436        */
 437       col = Color.white;
 438       if (oldColourScheme != null && oldColourScheme.isSimple())
 439       {
 440         col = oldColourScheme.findColour(residue.charAt(0));
 441       }
 442     }
 443
 444     if (caseSensitive.isSelected())
 445     {
 446       button.setMargin(new Insets(2, 2, 2, 2));
 447     }
 448     else
 449     {
 450       button.setMargin(new Insets(2, 14, 2, 14));
 451     }
 452
 453     button.setOpaque(true); // required for the next line to have effect
 454     button.setBackground(col);
 455     button.setText(label);
 456     button.setForeground(ColorUtils.darkerThan(col));
 457     button.setFont(VERDANA_BOLD_10);
 458
 459     return button;
 460   }
 461
 462   /**
 463    * On 'OK', check that at least one colour has been assigned to a residue (and
 464    * if not issue a warning), and apply the chosen colour scheme and close the
 465    * panel.
 466    */
 467   @Override
 468   protected void okButton_actionPerformed()
 469   {
 470     if (isNoSelectionMade())
 471     {
 472       JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager
 473               .getString("label.no_colour_selection_in_scheme"),
 474               MessageManager.getString("label.no_colour_selection_warn"),
 475               JvOptionPane.WARNING_MESSAGE);
 476     }
 477     else
 478     {
 479       applyButton_actionPerformed();
 480
 481       try
 482       {
 483         frame.setClosed(true);
 484       } catch (Exception ex)
 485       {
 486       }
 487     }
 488   }
 489
 490   /**
 491    * Returns true if the user has not made any colour selection (including if
 492    * 'case-sensitive' selected and no lower-case colour chosen).
 493    *
 494    * @return
 495    */
 496   protected boolean isNoSelectionMade()
 497   {
 498     final boolean noUpperCaseSelected = upperCaseButtons == null
 499             || upperCaseButtons.isEmpty();
 500     final boolean noLowerCaseSelected = caseSensitive.isSelected()
 501             && (lowerCaseButtons == null || lowerCaseButtons.isEmpty());
 502     final boolean noSelectionMade = noUpperCaseSelected
 503             || noLowerCaseSelected;
 504     return noSelectionMade;
 505   }
 506
 507   /**
 508    * Applies the current colour scheme to the alignment, sequence group or
 509    * structure view.
 510    */
 511   @Override
 512   protected void applyButton_actionPerformed()
 513   {
 514     if (isNoSelectionMade())
 515     {
 516       JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager
 517               .getString("label.no_colour_selection_in_scheme"),
 518               MessageManager.getString("label.no_colour_selection_warn"),
 519               JvOptionPane.WARNING_MESSAGE);
 520
 521     }
 522     UserColourScheme ucs = getSchemeFromButtons();
 523
 524     if (seqGroup != null)
 525     {
 526       seqGroup.cs = ucs;
 527       ap.paintAlignment(true);
 528     }
 529     else if (ap != null)
 530     {
 531       ap.alignFrame.changeColour(ucs);
 532     }
 533     else if (structureViewer != null)
 534     {
 535       structureViewer.setJalviewColourScheme(ucs);
 536     }
 537   }
 538
 539   UserColourScheme getSchemeFromButtons()
 540   {
 541
 542     Color[] newColours = new Color[24];
 543
 544     int length = upperCaseButtons.size();
 545     if (length < 24)
 546     {
 547       int i = 0;
 548       for (JButton btn : upperCaseButtons)
 549       {
 550         newColours[i] = btn.getBackground();
 551         i++;
 552       }
 553     }
 554     else
 555     {
 556       for (int i = 0; i < 24; i++)
 557       {
 558         JButton button = upperCaseButtons.get(i);
 559         newColours[i] = button.getBackground();
 560       }
 561     }
 562
 563     UserColourScheme ucs = new UserColourScheme(newColours);
 564     ucs.setName(schemeName.getText());
 565
 566     if (caseSensitive.isSelected())
 567     {
 568       newColours = new Color[23];
 569       length = lowerCaseButtons.size();
 570       if (length < 23)
 571       {
 572         int i = 0;
 573         for (JButton btn : lowerCaseButtons)
 574         {
 575           newColours[i] = btn.getBackground();
 576           i++;
 577         }
 578       }
 579       else
 580       {
 581         for (int i = 0; i < 23; i++)
 582         {
 583           JButton button = lowerCaseButtons.get(i);
 584           newColours[i] = button.getBackground();
 585         }
 586       }
 587       ucs.setLowerCaseColours(newColours);
 588     }
 589
 590     if (ap != null)
 591     {
 592       ucs.setThreshold(0, ap.av.isIgnoreGapsConsensus());
 593     }
 594
 595     return ucs;
 596   }
 597
 598   /**
 599    * DOCUMENT ME!
 600    *
 601    * @param e
 602    *          DOCUMENT ME!
 603    */
 604   @Override
 605   protected void loadbutton_actionPerformed(ActionEvent e)
 606   {
 607     upperCaseButtons = new ArrayList<JButton>();
 608     lowerCaseButtons = new ArrayList<JButton>();
 609
 610     JalviewFileChooser chooser = new JalviewFileChooser("jc",
 611             "Jalview User Colours");
 612     chooser.setFileView(new JalviewFileView());
 613     chooser.setDialogTitle(MessageManager
 614             .getString("label.load_colour_scheme"));
 615     chooser.setToolTipText(MessageManager.getString("action.load"));
 616
 617     int value = chooser.showOpenDialog(this);
 618
 619     if (value != JalviewFileChooser.APPROVE_OPTION)
 620     {
 621       return;
 622     }
 623     File choice = chooser.getSelectedFile();
 624     Cache.setProperty(LAST_DIRECTORY, choice.getParent());
 625
 626     UserColourScheme ucs = ColourSchemes.loadColourScheme(choice
 627             .getAbsolutePath());
 628     Color[] colors = ucs.getColours();
 629     schemeName.setText(ucs.getSchemeName());
 630
 631     if (ucs.getLowerCaseColours() != null)
 632     {
 633       caseSensitive.setSelected(true);
 634       lcaseColour.setEnabled(true);
 635       resetButtonPanel(true);
 636       for (int i = 0; i < lowerCaseButtons.size(); i++)
 637       {
 638         JButton button = lowerCaseButtons.get(i);
 639         button.setBackground(ucs.getLowerCaseColours()[i]);
 640       }
 641     }
 642     else
 643     {
 644       caseSensitive.setSelected(false);
 645       lcaseColour.setEnabled(false);
 646       resetButtonPanel(false);
 647     }
 648
 649     for (int i = 0; i < upperCaseButtons.size(); i++)
 650     {
 651       JButton button = upperCaseButtons.get(i);
 652       button.setBackground(colors[i]);
 653     }
 654
 655     addNewColourScheme(choice.getPath());
 656   }
 657
 658   /**
 659    * Loads the user-defined colour scheme from the first file listed in property
 660    * "USER_DEFINED_COLOURS". If this fails, returns an all-white colour scheme.
 661    *
 662    * @return
 663    */
 664   public static UserColourScheme loadDefaultColours()
 665   {
 666     UserColourScheme ret = null;
 667
 668     String colours = Cache.getProperty(USER_DEFINED_COLOURS);
 669     if (colours != null)
 670     {
 671       if (colours.indexOf("|") > -1)
 672       {
 673         colours = colours.substring(0, colours.indexOf("|"));
 674       }
 675       ret = ColourSchemes.loadColourScheme(colours);
 676     }
 677
 678     if (ret == null)
 679     {
 680       ret = new UserColourScheme("white");
 681     }
 682
 683     return ret;
 684   }
 685
 686   /**
 687    * DOCUMENT ME!
 688    *
 689    * @param e
 690    *          DOCUMENT ME!
 691    */
 692   @Override
 693   protected void savebutton_actionPerformed(ActionEvent e)
 694   {
 695     String name = schemeName.getText().trim();
 696     if (name.length() < 1)
 697     {
 698       JvOptionPane.showInternalMessageDialog(Desktop.desktop, MessageManager
 699               .getString("label.user_colour_scheme_must_have_name"),
 700               MessageManager.getString("label.no_name_colour_scheme"),
 701               JvOptionPane.WARNING_MESSAGE);
 702       return;
 703     }
 704
 705     if (ColourSchemes.getInstance().nameExists(name))
 706     {
 707       int reply = JvOptionPane.showInternalConfirmDialog(Desktop.desktop,
 708               MessageManager.formatMessage(
 709                       "label.colour_scheme_exists_overwrite", new Object[] {
 710                           name, name }),
 711               MessageManager.getString("label.duplicate_scheme_name"),
 712               JvOptionPane.YES_NO_OPTION);
 713       if (reply != JvOptionPane.YES_OPTION)
 714       {
 715         return;
 716       }
 717       ColourSchemes.getInstance().removeColourScheme(name);
 718     }
 719     JalviewFileChooser chooser = new JalviewFileChooser("jc",
 720             "Jalview User Colours");
 721
 722     JalviewFileView fileView = new JalviewFileView();
 723     chooser.setFileView(fileView);
 724     chooser.setDialogTitle(MessageManager
 725             .getString("label.save_colour_scheme"));
 726     chooser.setToolTipText(MessageManager.getString("action.save"));
 727
 728     int value = chooser.showSaveDialog(this);
 729
 730     if (value == JalviewFileChooser.APPROVE_OPTION)
 731     {
 732       File file = chooser.getSelectedFile();
 733       addNewColourScheme(file.getPath());
 734       saveToFile(file);
 735     }
 736   }
 737
 738   /**
 739    * Adds the current colour scheme to the Jalview properties file so it is
 740    * loaded on next startup, and updates the Colour menu in the parent
 741    * AlignFrame (if there is one). Note this action does not including applying
 742    * the colour scheme.
 743    *
 744    * @param filePath
 745    */
 746   protected void addNewColourScheme(String filePath)
 747   {
 748     /*
 749      * update the delimited list of user defined colour files in
 750      * Jalview property USER_DEFINED_COLOURS
 751      */
 752     String defaultColours = Cache
 753             .getDefault(USER_DEFINED_COLOURS, filePath);
 754     if (defaultColours.indexOf(filePath) == -1)
 755     {
 756       if (defaultColours.length() > 0)
 757       {
 758         defaultColours = defaultColours.concat("|");
 759       }
 760       defaultColours = defaultColours.concat(filePath);
 761     }
 762     Cache.setProperty(USER_DEFINED_COLOURS, defaultColours);
 763
 764     /*
 765      * construct and register the colour scheme
 766      */
 767     UserColourScheme ucs = getSchemeFromButtons();
 768     ColourSchemes.getInstance().registerColourScheme(ucs);
 769
 770     /*
 771      * update the Colour menu items
 772      */
 773     if (ap != null)
 774     {
 775       ap.alignFrame.buildColourMenu();
 776     }
 777   }
 778
 779   /**
 780    * Saves the colour scheme to file in XML format
 781    *
 782    * @param path
 783    */
 784   protected void saveToFile(File toFile)
 785   {
 786     /*
 787      * build a Java model of colour scheme as XML, and
 788      * marshal to file
 789      */
 790     JalviewUserColours ucs = new JalviewUserColours();
 791     ucs.setSchemeName(schemeName.getText());
 792     try
 793     {
 794       PrintWriter out = new PrintWriter(new OutputStreamWriter(
 795               new FileOutputStream(toFile), "UTF-8"));
 796
 797       for (int i = 0; i < buttonPanel.getComponentCount(); i++)
 798       {
 799         JButton button = (JButton) buttonPanel.getComponent(i);
 800         Colour col = new Colour();
 801         col.setName(button.getText());
 802         col.setRGB(Format.getHexString(button.getBackground()));
 803         ucs.addColour(col);
 804       }
 805       ucs.marshal(out);
 806       out.close();
 807     } catch (Exception ex)
 808     {
 809       ex.printStackTrace();
 810     }
 811   }
 812
 813   /**
 814    * On cancel, restores the colour scheme before the dialogue was opened
 815    *
 816    * @param e
 817    */
 818   @Override
 819   protected void cancelButton_actionPerformed(ActionEvent e)
 820   {
 821     if (ap != null)
 822     {
 823       if (seqGroup != null)
 824       {
 825         seqGroup.cs = oldColourScheme;
 826       }
 827       else
 828       {
 829         ap.alignFrame.changeColour(oldColourScheme);
 830       }
 831       ap.paintAlignment(true);
 832     }
 833
 834     if (structureViewer != null)
 835     {
 836       structureViewer.setJalviewColourScheme(oldColourScheme);
 837     }
 838
 839     try
 840     {
 841       frame.setClosed(true);
 842     } catch (Exception ex)
 843     {
 844     }
 845   }
 846
 847   @Override
 848   public void caseSensitive_actionPerformed(ActionEvent e)
 849   {
 850     resetButtonPanel(caseSensitive.isSelected());
 851     lcaseColour.setEnabled(caseSensitive.isSelected());
 852   }
 853
 854   @Override
 855   public void lcaseColour_actionPerformed(ActionEvent e)
 856   {
 857     if (selectedButtons == null)
 858     {
 859       selectedButtons = new ArrayList<JButton>();
 860     }
 861     else
 862     {
 863       selectedButtons.clear();
 864     }
 865     selectedButtons.add(lcaseColour);
 866   }
 867 }