src/jalview/appletgui/UserDefinedColours.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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.appletgui;
  22
  23 import jalview.datamodel.SequenceGroup;
  24 import jalview.schemes.ColourSchemeI;
  25 import jalview.schemes.GraduatedColor;
  26 import jalview.schemes.ResidueProperties;
  27 import jalview.schemes.UserColourScheme;
  28 import jalview.util.MessageManager;
  29
  30 import java.awt.Button;
  31 import java.awt.Color;
  32 import java.awt.Component;
  33 import java.awt.Container;
  34 import java.awt.Dialog;
  35 import java.awt.Font;
  36 import java.awt.Frame;
  37 import java.awt.GridLayout;
  38 import java.awt.Label;
  39 import java.awt.Panel;
  40 import java.awt.Rectangle;
  41 import java.awt.Scrollbar;
  42 import java.awt.TextField;
  43 import java.awt.event.ActionEvent;
  44 import java.awt.event.ActionListener;
  45 import java.awt.event.AdjustmentEvent;
  46 import java.awt.event.AdjustmentListener;
  47 import java.awt.event.MouseEvent;
  48 import java.util.Vector;
  49
  50 public class UserDefinedColours extends Panel implements ActionListener,
  51         AdjustmentListener
  52 {
  53
  54   AlignmentPanel ap;
  55
  56   SequenceGroup seqGroup;
  57
  58   Button selectedButton;
  59
  60   Vector oldColours = new Vector();
  61
  62   ColourSchemeI oldColourScheme;
  63
  64   Frame frame;
  65
  66   MCview.AppletPDBCanvas pdbcanvas;
  67
  68   AppletJmol jmol;
  69
  70   Dialog dialog;
  71
  72   Object caller;
  73
  74   String originalLabel;
  75
  76   Object originalColour;
  77
  78   int R = 0, G = 0, B = 0;
  79
  80   public ColourSchemeI loadDefaultColours()
  81   {
  82     // NOT IMPLEMENTED YET IN APPLET VERSION
  83     return null;
  84   }
  85
  86   public UserDefinedColours(AlignmentPanel ap, SequenceGroup sg)
  87   {
  88     this.ap = ap;
  89     seqGroup = sg;
  90
  91     if (seqGroup != null)
  92     {
  93       oldColourScheme = seqGroup.cs;
  94     }
  95     else
  96     {
  97       oldColourScheme = ap.av.getGlobalColourScheme();
  98     }
  99
 100     init();
 101   }
 102
 103   public UserDefinedColours(MCview.AppletPDBCanvas pdb)
 104   {
 105     this.pdbcanvas = pdb;
 106     init();
 107   }
 108
 109   public UserDefinedColours(AppletJmol jmol)
 110   {
 111     this.jmol = jmol;
 112     init();
 113   }
 114
 115   public UserDefinedColours(FeatureRenderer fr, Frame alignframe)
 116   {
 117     caller = fr;
 118     originalColour = fr.colourPanel.getBackground();
 119     originalLabel = "Feature Colour";
 120     setForDialog("Select Feature Colour", alignframe);
 121     setTargetColour(fr.colourPanel.getBackground());
 122     dialog.setVisible(true);
 123   }
 124
 125   public UserDefinedColours(Component caller, Color col1, Frame alignframe)
 126   {
 127     this(caller, col1, alignframe, "Select Colour");
 128   }
 129
 130   /**
 131    * Makes a dialog to choose the colour
 132    *
 133    * @param caller
 134    *          - handles events
 135    * @param col1
 136    *          - original colour
 137    * @param alignframe
 138    *          - the parent Frame for the dialog
 139    * @param title
 140    *          - window title
 141    */
 142   public UserDefinedColours(Component caller, Color col1, Frame alignframe,
 143           String title)
 144   {
 145     this.caller = caller;
 146     originalColour = col1;
 147     originalLabel = title;
 148     setForDialog(title, alignframe);
 149     setTargetColour(col1);
 150     dialog.setVisible(true);
 151   }
 152
 153   /**
 154    * feature colour chooser
 155    *
 156    * @param caller
 157    * @param label
 158    * @param colour
 159    */
 160   public UserDefinedColours(Object caller, String label, Color colour)
 161   {
 162     this(caller, label, colour, colour);
 163   }
 164
 165   /**
 166    * feature colour chooser when changing style to single color
 167    *
 168    * @param me
 169    * @param type
 170    * @param graduatedColor
 171    */
 172   public UserDefinedColours(FeatureSettings me, String type,
 173           GraduatedColor graduatedColor)
 174   {
 175     this(me, type, graduatedColor, graduatedColor.getMaxColor());
 176   }
 177
 178   private UserDefinedColours(Object caller, String label, Object ocolour,
 179           Color colour)
 180   {
 181     this.caller = caller;
 182     originalColour = ocolour;
 183     originalLabel = label;
 184     init();
 185     remove(buttonPanel);
 186
 187     setTargetColour(colour);
 188
 189     okcancelPanel.setBounds(new Rectangle(0, 113, 400, 35));
 190     frame.setTitle("User Defined Colours - " + label);
 191     frame.setSize(420, 200);
 192   }
 193
 194   void setForDialog(String title, Container alignframe)
 195   {
 196     init();
 197     frame.setVisible(false);
 198     remove(buttonPanel);
 199     if (alignframe instanceof Frame)
 200     {
 201       dialog = new Dialog((Frame) alignframe, title, true);
 202     }
 203     else
 204     {
 205       // if (alignframe instanceof JVDialog){
 206       // // not 1.1 compatible!
 207       // dialog = new Dialog(((JVDialog)alignframe), title, true);
 208       // } else {
 209       throw new Error("Unsupported owner for User Colour scheme dialog.");
 210     }
 211
 212     dialog.add(this);
 213     this.setSize(400, 123);
 214     okcancelPanel.setBounds(new Rectangle(0, 123, 400, 35));
 215     int height = 160 + alignframe.getInsets().top + getInsets().bottom;
 216     int width = 400;
 217
 218     dialog.setBounds(alignframe.getBounds().x
 219             + (alignframe.getSize().width - width) / 2,
 220             alignframe.getBounds().y
 221                     + (alignframe.getSize().height - height) / 2, width,
 222             height);
 223
 224   }
 225
 226   public void actionPerformed(ActionEvent evt)
 227   {
 228     if (evt.getSource() == okButton)
 229     {
 230       okButton_actionPerformed();
 231     }
 232     else if (evt.getSource() == applyButton)
 233     {
 234       applyButton_actionPerformed();
 235     }
 236     else if (evt.getSource() == cancelButton)
 237     {
 238       cancelButton_actionPerformed();
 239     }
 240     else if (evt.getSource() == rText)
 241     {
 242       rText_actionPerformed();
 243     }
 244     else if (evt.getSource() == gText)
 245     {
 246       gText_actionPerformed();
 247     }
 248     else if (evt.getSource() == bText)
 249     {
 250       bText_actionPerformed();
 251     }
 252   }
 253
 254   public void adjustmentValueChanged(AdjustmentEvent evt)
 255   {
 256     if (evt.getSource() == rScroller)
 257     {
 258       rScroller_adjustmentValueChanged();
 259     }
 260     else if (evt.getSource() == gScroller)
 261     {
 262       gScroller_adjustmentValueChanged();
 263     }
 264     else if (evt.getSource() == bScroller)
 265     {
 266       bScroller_adjustmentValueChanged();
 267     }
 268   }
 269
 270   void init()
 271   {
 272     try
 273     {
 274       jbInit();
 275     } catch (Exception e)
 276     {
 277       e.printStackTrace();
 278     }
 279     frame = new Frame();
 280     frame.add(this);
 281     jalview.bin.JalviewLite.addFrame(frame, MessageManager.getString("label.user_defined_colours"), 420,
 282             345);
 283
 284     if (seqGroup != null)
 285     {
 286       frame.setTitle(frame.getTitle() + " (" + seqGroup.getName() + ")");
 287     }
 288
 289     for (int i = 0; i < 20; i++)
 290     {
 291       makeButton(ResidueProperties.aa2Triplet.get(ResidueProperties.aa[i])
 292               + "", ResidueProperties.aa[i]);
 293     }
 294
 295     makeButton("B", "B");
 296     makeButton("Z", "Z");
 297     makeButton("X", "X");
 298     makeButton("Gap", "'.','-',' '");
 299
 300     validate();
 301   }
 302
 303   protected void rText_actionPerformed()
 304   {
 305     try
 306     {
 307       int i = Integer.parseInt(rText.getText());
 308       rScroller.setValue(i);
 309       rScroller_adjustmentValueChanged();
 310     } catch (NumberFormatException ex)
 311     {
 312     }
 313   }
 314
 315   protected void gText_actionPerformed()
 316   {
 317     try
 318     {
 319       int i = Integer.parseInt(gText.getText());
 320       gScroller.setValue(i);
 321       gScroller_adjustmentValueChanged();
 322     } catch (NumberFormatException ex)
 323     {
 324     }
 325
 326   }
 327
 328   protected void bText_actionPerformed()
 329   {
 330     try
 331     {
 332       int i = Integer.parseInt(bText.getText());
 333       bScroller.setValue(i);
 334       bScroller_adjustmentValueChanged();
 335     } catch (NumberFormatException ex)
 336     {
 337     }
 338
 339   }
 340
 341   protected void rScroller_adjustmentValueChanged()
 342   {
 343     R = rScroller.getValue();
 344     rText.setText(R + "");
 345     colourChanged();
 346   }
 347
 348   protected void gScroller_adjustmentValueChanged()
 349   {
 350     G = gScroller.getValue();
 351     gText.setText(G + "");
 352     colourChanged();
 353   }
 354
 355   protected void bScroller_adjustmentValueChanged()
 356   {
 357     B = bScroller.getValue();
 358     bText.setText(B + "");
 359     colourChanged();
 360   }
 361
 362   public void colourChanged()
 363   {
 364     Color col = new Color(R, G, B);
 365     target.setBackground(col);
 366     target.repaint();
 367
 368     if (selectedButton != null)
 369     {
 370       selectedButton.setBackground(col);
 371       selectedButton.repaint();
 372     }
 373   }
 374
 375   void setTargetColour(Color col)
 376   {
 377     R = col.getRed();
 378     G = col.getGreen();
 379     B = col.getBlue();
 380
 381     rScroller.setValue(R);
 382     gScroller.setValue(G);
 383     bScroller.setValue(B);
 384     rText.setText(R + "");
 385     gText.setText(G + "");
 386     bText.setText(B + "");
 387     colourChanged();
 388   }
 389
 390   public void colourButtonPressed(MouseEvent e)
 391   {
 392     selectedButton = (Button) e.getSource();
 393     setTargetColour(selectedButton.getBackground());
 394   }
 395
 396   void makeButton(String label, String aa)
 397   {
 398     final Button button = new Button();
 399     Color col = Color.white;
 400     if (oldColourScheme != null)
 401     {
 402       try
 403       {
 404         col = oldColourScheme.findColour(aa.charAt(0), -1, null);
 405       } catch (Exception ex)
 406       {
 407       }
 408     }
 409     button.setBackground(col);
 410     oldColours.addElement(col);
 411     button.setLabel(label);
 412     button.setForeground(col.darker().darker().darker());
 413     button.setFont(new java.awt.Font("Verdana", 1, 10));
 414     button.addMouseListener(new java.awt.event.MouseAdapter()
 415     {
 416       public void mousePressed(MouseEvent e)
 417       {
 418         colourButtonPressed(e);
 419       }
 420     });
 421
 422     buttonPanel.add(button, null);
 423   }
 424
 425   protected void okButton_actionPerformed()
 426   {
 427     applyButton_actionPerformed();
 428     if (dialog != null)
 429       dialog.setVisible(false);
 430
 431     frame.setVisible(false);
 432   }
 433
 434   public Color getColor()
 435   {
 436     return new Color(R, G, B);
 437   }
 438
 439   protected void applyButton_actionPerformed()
 440   {
 441     if (caller != null)
 442     {
 443       if (caller instanceof FeatureSettings)
 444       {
 445         ((FeatureSettings) caller).setUserColour(originalLabel, getColor());
 446       }
 447       else if (caller instanceof AnnotationColourChooser)
 448       {
 449         if (originalLabel.equals("Min Colour"))
 450         {
 451           ((AnnotationColourChooser) caller)
 452                   .minColour_actionPerformed(getColor());
 453         }
 454         else
 455         {
 456           ((AnnotationColourChooser) caller)
 457                   .maxColour_actionPerformed(getColor());
 458         }
 459       }
 460       else if (caller instanceof FeatureRenderer)
 461       {
 462         ((FeatureRenderer) caller).colourPanel.updateColor(getColor());
 463       }
 464       else if (caller instanceof FeatureColourChooser)
 465       {
 466         if (originalLabel.indexOf("inimum") > -1)
 467         {
 468           ((FeatureColourChooser) caller)
 469                   .minColour_actionPerformed(getColor());
 470         }
 471         else
 472         {
 473           ((FeatureColourChooser) caller)
 474                   .maxColour_actionPerformed(getColor());
 475         }
 476       }
 477
 478       return;
 479     }
 480
 481     Color[] newColours = new Color[24];
 482     for (int i = 0; i < 24; i++)
 483     {
 484       Button button = (Button) buttonPanel.getComponent(i);
 485       newColours[i] = button.getBackground();
 486     }
 487
 488     UserColourScheme ucs = new UserColourScheme(newColours);
 489     if (ap != null)
 490     {
 491       ucs.setThreshold(0, ap.av.getIgnoreGapsConsensus());
 492     }
 493
 494     if (ap != null)
 495     {
 496       if (seqGroup != null)
 497       {
 498         seqGroup.cs = ucs;
 499       }
 500       else
 501       {
 502         ap.av.setGlobalColourScheme(ucs);
 503       }
 504       ap.seqPanel.seqCanvas.img = null;
 505       ap.paintAlignment(true);
 506     }
 507     else if (jmol != null)
 508     {
 509       jmol.setJalviewColourScheme(ucs);
 510     }
 511     else if (pdbcanvas != null)
 512     {
 513       pdbcanvas.setColours(ucs);
 514     }
 515   }
 516
 517   protected void cancelButton_actionPerformed()
 518   {
 519     if (caller != null)
 520     {
 521       if (caller instanceof FeatureSettings)
 522       {
 523         ((FeatureSettings) caller).setUserColour(originalLabel,
 524                 originalColour);
 525       }
 526       else if (caller instanceof AnnotationColourChooser)
 527       {
 528         if (originalLabel.equals("Min Colour"))
 529         {
 530           ((AnnotationColourChooser) caller)
 531                   .minColour_actionPerformed((Color) originalColour);
 532         }
 533         else
 534         {
 535           ((AnnotationColourChooser) caller)
 536                   .maxColour_actionPerformed((Color) originalColour);
 537         }
 538       }
 539       else if (caller instanceof FeatureRenderer)
 540       {
 541         ((FeatureRenderer) caller).colourPanel.updateColor(originalColour);
 542
 543       }
 544
 545       else if (caller instanceof FeatureColourChooser)
 546       {
 547         if (originalLabel.indexOf("inimum") > -1)
 548         {
 549           ((FeatureColourChooser) caller)
 550                   .minColour_actionPerformed((Color) originalColour);
 551         }
 552         else
 553         {
 554           ((FeatureColourChooser) caller)
 555                   .maxColour_actionPerformed((Color) originalColour);
 556         }
 557       }
 558       if (dialog != null)
 559         dialog.setVisible(false);
 560
 561       frame.setVisible(false);
 562       return;
 563     }
 564
 565     Color[] newColours = new Color[24];
 566     for (int i = 0; i < 24; i++)
 567     {
 568       newColours[i] = (Color) oldColours.elementAt(i);
 569       buttonPanel.getComponent(i).setBackground(newColours[i]);
 570     }
 571
 572     UserColourScheme ucs = new UserColourScheme(newColours);
 573
 574     if (ap != null)
 575     {
 576       if (seqGroup != null)
 577       {
 578         seqGroup.cs = ucs;
 579       }
 580       else
 581       {
 582         ap.av.setGlobalColourScheme(ucs);
 583       }
 584       ap.paintAlignment(true);
 585     }
 586     else if (jmol != null)
 587     {
 588       jmol.setJalviewColourScheme(ucs);
 589     }
 590     else if (pdbcanvas != null)
 591     {
 592       pdbcanvas.pdb.setColours(ucs);
 593     }
 594
 595     frame.setVisible(false);
 596   }
 597
 598   protected Panel buttonPanel = new Panel();
 599
 600   protected GridLayout gridLayout = new GridLayout();
 601
 602   Panel okcancelPanel = new Panel();
 603
 604   protected Button okButton = new Button();
 605
 606   protected Button applyButton = new Button();
 607
 608   protected Button cancelButton = new Button();
 609
 610   protected Scrollbar rScroller = new Scrollbar();
 611
 612   Label label1 = new Label();
 613
 614   protected TextField rText = new TextField();
 615
 616   Label label4 = new Label();
 617
 618   protected Scrollbar gScroller = new Scrollbar();
 619
 620   protected TextField gText = new TextField();
 621
 622   Label label5 = new Label();
 623
 624   protected Scrollbar bScroller = new Scrollbar();
 625
 626   protected TextField bText = new TextField();
 627
 628   protected Panel target = new Panel();
 629
 630   private void jbInit() throws Exception
 631   {
 632     this.setLayout(null);
 633     buttonPanel.setLayout(gridLayout);
 634     gridLayout.setColumns(6);
 635     gridLayout.setRows(4);
 636     okButton.setFont(new java.awt.Font("Verdana", 0, 11));
 637     okButton.setLabel(MessageManager.getString("action.ok"));
 638     okButton.addActionListener(this);
 639     applyButton.setFont(new java.awt.Font("Verdana", 0, 11));
 640     applyButton.setLabel(MessageManager.getString("action.apply"));
 641     applyButton.addActionListener(this);
 642     cancelButton.setFont(new java.awt.Font("Verdana", 0, 11));
 643     cancelButton.setLabel(MessageManager.getString("action.cancel"));
 644     cancelButton.addActionListener(this);
 645     this.setBackground(new Color(212, 208, 223));
 646     okcancelPanel.setBounds(new Rectangle(0, 265, 400, 35));
 647     buttonPanel.setBounds(new Rectangle(0, 123, 400, 142));
 648     rScroller.setMaximum(256);
 649     rScroller.setMinimum(0);
 650     rScroller.setOrientation(0);
 651     rScroller.setUnitIncrement(1);
 652     rScroller.setVisibleAmount(1);
 653     rScroller.setBounds(new Rectangle(36, 27, 119, 19));
 654     rScroller.addAdjustmentListener(this);
 655     label1.setAlignment(Label.RIGHT);
 656     label1.setText("R");
 657     label1.setBounds(new Rectangle(19, 30, 16, 15));
 658     rText.setFont(new java.awt.Font("Dialog", Font.PLAIN, 10));
 659     rText.setText("0        ");
 660     rText.setBounds(new Rectangle(156, 27, 53, 19));
 661     rText.addActionListener(this);
 662     label4.setAlignment(Label.RIGHT);
 663     label4.setText("G");
 664     label4.setBounds(new Rectangle(15, 56, 20, 15));
 665     gScroller.setMaximum(256);
 666     gScroller.setMinimum(0);
 667     gScroller.setOrientation(0);
 668     gScroller.setUnitIncrement(1);
 669     gScroller.setVisibleAmount(1);
 670     gScroller.setBounds(new Rectangle(35, 52, 120, 20));
 671     gScroller.addAdjustmentListener(this);
 672     gText.setFont(new java.awt.Font("Dialog", Font.PLAIN, 10));
 673     gText.setText("0        ");
 674     gText.setBounds(new Rectangle(156, 52, 53, 20));
 675     gText.addActionListener(this);
 676     label5.setAlignment(Label.RIGHT);
 677     label5.setText("B");
 678     label5.setBounds(new Rectangle(14, 82, 20, 15));
 679     bScroller.setMaximum(256);
 680     bScroller.setMinimum(0);
 681     bScroller.setOrientation(0);
 682     bScroller.setUnitIncrement(1);
 683     bScroller.setVisibleAmount(1);
 684     bScroller.setBounds(new Rectangle(35, 78, 120, 20));
 685     bScroller.addAdjustmentListener(this);
 686     bText.setFont(new java.awt.Font("Dialog", Font.PLAIN, 10));
 687     bText.setText("0        ");
 688     bText.setBounds(new Rectangle(157, 78, 52, 20));
 689     bText.addActionListener(this);
 690     target.setBackground(Color.black);
 691     target.setBounds(new Rectangle(229, 26, 134, 79));
 692     this.add(okcancelPanel, null);
 693     okcancelPanel.add(okButton, null);
 694     okcancelPanel.add(applyButton, null);
 695     okcancelPanel.add(cancelButton, null);
 696     this.add(buttonPanel, null);
 697     this.add(target, null);
 698     this.add(gScroller);
 699     this.add(rScroller);
 700     this.add(bScroller);
 701     this.add(label5);
 702     this.add(label4);
 703     this.add(label1);
 704     this.add(gText);
 705     this.add(rText);
 706     this.add(bText);
 707   }
 708
 709 }