001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.ui.config;
038:
039: import javax.swing.*;
040: import java.awt.*;
041:
042: import java.io.Serializable;
043: import java.util.ArrayList;
044: import java.util.Vector;
045:
046: import edu.rice.cs.drjava.config.*;
047: import edu.rice.cs.drjava.DrJava;
048: import edu.rice.cs.util.Lambda;
049: import edu.rice.cs.util.swing.Utilities;
050:
051: /** The graphical form of an Option. Provides a way to see the values of Option
052: * while running DrJava and perform live updating of Options.
053: * @version $Id: OptionComponent.java 4292 2007-12-27 16:00:45Z mgricken $
054: */
055: public abstract class OptionComponent<T> implements Serializable {
056: protected final Option<T> _option;
057: protected final JLabel _label;
058: protected final Frame _parent;
059:
060: public OptionComponent(Option<T> option, String labelText,
061: Frame parent) {
062: _option = option;
063: _label = new JLabel(labelText);
064: _label.setHorizontalAlignment(JLabel.RIGHT);
065: _parent = parent;
066: if (option != null) {
067: DrJava.getConfig().addOptionListener(option,
068: new OptionListener<T>() {
069: public void optionChanged(OptionEvent<T> oe) {
070: resetToCurrent();
071: }
072: });
073: }
074: }
075:
076: /** Special constructor for degenerate option components does not take an option.
077: * @param labelText Text for descriptive label of this option.
078: * @param parent The parent frame.
079: */
080: public OptionComponent(String labelText, Frame parent) {
081: this (null, labelText, parent);
082: }
083:
084: public Option<T> getOption() {
085: return _option;
086: }
087:
088: public String getLabelText() {
089: return _label.getText();
090: }
091:
092: public JLabel getLabel() {
093: return _label;
094: }
095:
096: /** Returns the JComponent to display for this OptionComponent. */
097: public abstract JComponent getComponent();
098:
099: /** Sets the detailed description text for all components in this OptionComponent.
100: * Should be called by subclasses that wish to display a description.
101: * @param description the description of the component
102: */
103: public abstract void setDescription(String description);
104:
105: /**
106: * Updates the appropriate configuration option with the new value
107: * if different from the old value and legal. Any changes should be
108: * done immediately such that current and future references to the Option
109: * should reflect the changes.
110: * @return false, if value is invalid; otherwise true.
111: */
112: public abstract boolean updateConfig();
113:
114: /** Resets the entry field to reflect the actual stored value for the option. */
115: public void resetToCurrent() {
116: if (_option != null) {
117: setValue(DrJava.getConfig().getSetting(_option));
118: }
119: }
120:
121: /**
122: * Resets the actual value of the component to the original default.
123: */
124: public void resetToDefault() {
125: if (_option != null) {
126: setValue(_option.getDefault());
127: notifyChangeListeners();
128: }
129: }
130:
131: /** Sets the value that is currently displayed by this component. */
132: public abstract void setValue(T value);
133:
134: public void showErrorMessage(String title, OptionParseException e) {
135: showErrorMessage(title, e.value, e.message);
136: }
137:
138: public void showErrorMessage(String title, String value,
139: String message) {
140: JOptionPane.showMessageDialog(_parent,
141: "There was an error in one of the options that you entered.\n"
142: + "Option: '" + getLabelText() + "'\n"
143: + "Your value: '" + value + "'\n" + "Error: "
144: + message, title, JOptionPane.WARNING_MESSAGE);
145: }
146:
147: /** Interface for change listener. */
148: public static interface ChangeListener extends
149: Lambda<Object, Object> {
150: public abstract Object apply(Object c);
151: }
152:
153: /** Adds a change listener to this component.
154: * @param listener listener to add
155: */
156: public void addChangeListener(ChangeListener listener) {
157: _changeListeners.add(listener);
158: }
159:
160: /** Removes a change listener to this component.
161: * @param listener listener to remove
162: */
163: public void removeChangeListener(ChangeListener listener) {
164: _changeListeners.remove(listener);
165: }
166:
167: /** Notify all change listeners of a change. */
168: protected void notifyChangeListeners() {
169: Utilities.invokeLater(new Runnable() {
170: public void run() {
171: // Make a copy of _changeListeners to prevent potential ConcurrentModificationException
172: ChangeListener[] listeners = _changeListeners
173: .toArray(new ChangeListener[_changeListeners
174: .size()]);
175: for (ChangeListener l : listeners)
176: l.apply(OptionComponent.this );
177: }
178: });
179: }
180:
181: /** List of change listeners. A volatile Vector is used here because a race involving operations on this field was
182: * encountered in MainFrameTest during _frame.pack() in initialization. It previously was a nonvolatile ArrayList. */
183: private volatile Vector<ChangeListener> _changeListeners = new Vector<ChangeListener>();
184: }
|