KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > ui > config > ButtonComponent


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2006 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.ui.config;
35
36 import javax.swing.*;
37 import edu.rice.cs.drjava.config.*;
38 import edu.rice.cs.drjava.*;
39 import java.awt.*;
40 import java.awt.event.*;
41
42
43 /**
44  * Button component to perform some action. Nothing gets saved.
45  */
46 public class ButtonComponent extends OptionComponent<Object JavaDoc> {
47   protected JButton _jb;
48
49   /**
50    * Constructs a new ButtonComponent.
51    * @param l the listener that gets executed when the button is pressed
52    * @param text the text to display with the option
53    * @param parent the parent frame
54    */
55   public ButtonComponent(ActionListener l, String JavaDoc text, Frame parent) {
56     super(null, "", parent);
57     _jb = new JButton(text);
58     _jb.addActionListener(l);
59     _jb.addActionListener(new ActionListener() {
60       public void actionPerformed(ActionEvent e) { notifyChangeListeners(); }
61     });
62   }
63
64   /**
65    * Constructs a new ButtonComponent with a tooltip description.
66    * @param l the listener that gets executed when the button is pressed
67    * @param text the text to display with the option
68    * @param parent the parent frame
69    * @param description text to show in a tooltip over
70    */
71   public ButtonComponent(ActionListener l, String JavaDoc text, Frame parent, String JavaDoc description) {
72     this(l, text, parent);
73     setDescription(description);
74   }
75
76   /**
77    * Sets the tooltip description text for this option.
78    * @param description the tooltip text
79    */
80   public void setDescription(String JavaDoc description) {
81     _jb.setToolTipText(description);
82     _label.setToolTipText(description);
83   }
84
85   /**
86    * Updates the config object with the new setting.
87    * @return true if the new value is set successfully
88    */
89   public boolean updateConfig() {
90     // nothing to do
91 return true;
92   }
93   
94   /**
95    * Displays the given value.
96    */
97   public void setValue(Object JavaDoc value) {
98     // nothing to do
99 }
100   
101   /**
102    * Return's this OptionComponent's configurable component.
103    */
104   public JComponent getComponent() { return _jb; }
105 }
106
Popular Tags