From 44ae47f5c64def4c4895bd61fdc08258c0854dc9 Mon Sep 17 00:00:00 2001 From: metasim Date: Tue, 16 Jan 2001 19:21:20 +0000 Subject: [PATCH] Added editor for properties of type 'File'. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268471 13f79535-47bb-0310-9956-ffa450edef68 --- .../ant/gui/customizer/DynamicCustomizer.java | 76 +++++- .../gui/customizer/FilePropertyEditor.java | 232 ++++++++++++++++++ 2 files changed, 305 insertions(+), 3 deletions(-) create mode 100644 src/antidote/org/apache/tools/ant/gui/customizer/FilePropertyEditor.java diff --git a/src/antidote/org/apache/tools/ant/gui/customizer/DynamicCustomizer.java b/src/antidote/org/apache/tools/ant/gui/customizer/DynamicCustomizer.java index 386d93aa6..80af93c9d 100644 --- a/src/antidote/org/apache/tools/ant/gui/customizer/DynamicCustomizer.java +++ b/src/antidote/org/apache/tools/ant/gui/customizer/DynamicCustomizer.java @@ -58,6 +58,7 @@ import java.lang.reflect.*; import java.beans.*; import javax.swing.*; import java.util.*; +import java.io.File; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.Component; @@ -85,6 +86,8 @@ public class DynamicCustomizer extends JPanel implements Customizer { Double.class, DoublePropertyEditor.class); PropertyEditorManager.registerEditor( Properties.class, PropertiesPropertyEditor.class); + PropertyEditorManager.registerEditor( + File.class, FilePropertyEditor.class); } /** Property name that PropertyDescriptors can save in their property @@ -110,8 +113,6 @@ public class DynamicCustomizer extends JPanel implements Customizer { /** Flag to trun off event propogation. */ private boolean _squelchChangeEvents = false; - - /** * Standard constructor. * @@ -364,6 +365,75 @@ public class DynamicCustomizer extends JPanel implements Customizer { } } + /** Class for testing this. */ + private static class TestClass { + private String _String = null; + private String[] _StringArray = null; + private int _int = 0; + private Integer _Integer = null; + private double _double = 0; + private Double _Double = null; + private Properties _Properties = null; + private File _File = null; + + public void setString(String string) { + _String = string; + } + public String getString() { + return _String; + } + + public void setStringArray(String[] array) { + _StringArray = array; + } + public String[] getStringArray() { + return _StringArray; + } + + public void setInt(int val) { + _int = val; + } + public int getInt() { + return _int; + } + + public void setInteger(Integer val) { + _Integer = val; + } + public Integer getInteger() { + return _Integer; + } + + public void setDoub(double val) { + _double = val; + } + public double getDoub() { + return _double; + } + + public void setDouble(Double val) { + _Double = val; + } + public Double getDouble() { + return _Double; + } + + public void setProperties(Properties props) { + _Properties = props; + } + public Properties getProperties() { + return _Properties; + } + + public void setFile(File f) { + _File = f; + } + public File getFile() { + return _File; + } + } + + /** * Test code. * @@ -372,7 +442,7 @@ public class DynamicCustomizer extends JPanel implements Customizer { public static void main(String[] args) { try { - Class c = Class.forName(args[0]); + Class c = args.length > 0 ? Class.forName(args[0]) : TestClass.class; JFrame f = new JFrame(c.getName()); DynamicCustomizer custom = new DynamicCustomizer(c); diff --git a/src/antidote/org/apache/tools/ant/gui/customizer/FilePropertyEditor.java b/src/antidote/org/apache/tools/ant/gui/customizer/FilePropertyEditor.java new file mode 100644 index 000000000..db72e031f --- /dev/null +++ b/src/antidote/org/apache/tools/ant/gui/customizer/FilePropertyEditor.java @@ -0,0 +1,232 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2001 The Apache Software Foundation. All rights + * reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. The end-user documentation included with the redistribution, if + * any, must include the following acknowlegement: + * "This product includes software developed by the + * Apache Software Foundation (http://www.apache.org/)." + * Alternately, this acknowlegement may appear in the software itself, + * if and wherever such third-party acknowlegements normally appear. + * + * 4. The names "The Jakarta Project", "Ant", and "Apache Software + * Foundation" must not be used to endorse or promote products derived + * from this software without prior written permission. For written + * permission, please contact apache@apache.org. + * + * 5. Products derived from this software may not be called "Apache" + * nor may "Apache" appear in their names without prior written + * permission of the Apache Group. + * + * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * ==================================================================== + * + * This software consists of voluntary contributions made by many + * individuals on behalf of the Apache Software Foundation. For more + * information on the Apache Software Foundation, please see + * . + */ +package org.apache.tools.ant.gui.customizer; + +import javax.swing.*; +import javax.swing.filechooser.FileFilter; +import java.awt.Component; +import java.awt.BorderLayout; +import java.awt.event.ActionListener; +import java.awt.event.ActionEvent; +import javax.swing.border.BevelBorder; +import java.io.File; + + +/** + * Custom property editor for File types. + * + * @version $Revision$ + * @author Simeon Fitch + */ +public class FilePropertyEditor extends AbstractPropertyEditor { + /** Area for typing in the file name. */ + private JTextField _widget = null; + /** Container for the editor. */ + private JPanel _container = null; + /** Default path. */ + private String _path = null; + /** File filter to use. */ + private FileFilter _filter = null; + + /** + * Default ctor. + * + */ + public FilePropertyEditor() { + _container = new JPanel(new BorderLayout()); + + + _widget = new JTextField() { + public boolean isManagingFocus() { + return false; + } + }; + + _widget.addFocusListener(new FocusHandler(this)); + + _container.add(_widget, BorderLayout.CENTER); + + JButton b = new JButton("Browse..."); + b.addActionListener(new ActionHandler()); + _container.add(b, BorderLayout.EAST); + } + + /** + * Get the child editing component. Uses JComponent so we can have tool + * tips, etc. + * + * @return Child editing component. + */ + protected Component getChild() { + return _container; + } + + /** + * File filter to use with chooser. + * + * @param filter File filter. + */ + public void setFileFilter(FileFilter filter) { + _filter = filter; + } + + /** + * This method is intended for use when generating Java code to set + * the value of the property. It should return a fragment of Java code + * that can be used to initialize a variable with the current property + * value. + *

+ * Example results are "2", "new Color(127,127,34)", "Color.orange", etc. + * + * @return A fragment of Java code representing an initializer for the + * current value. + */ + public String getJavaInitializationString() { + return "new File(" + getAsText() + ")"; + } + + /** + * Set (or change) the object that is to be edited. Builtin types such + * as "int" must be wrapped as the corresponding object type such as + * "java.lang.Integer". + * + * @param value The new target object to be edited. Note that this + * object should not be modified by the PropertyEditor, rather + * the PropertyEditor should create a new object to hold any + * modified value. + */ + public void setValue(Object value) { + if(value == null) { + value = new File(""); + } + + if(!(value instanceof File)) { + throw new IllegalArgumentException( + value.getClass().getName() + " is not of type File"); + } + + Object old = _widget.getText(); + + _widget.setText(((File)value).getPath()); + } + + /** + * @return The value of the property. Builtin types + * such as "int" will be wrapped as the corresponding + * object type such as "java.lang.Integer". */ + public Object getValue() { + File retval = null; + retval = new File(_widget.getText()); + return retval; + } + + /** + * Set the property value by parsing a given String. May raise + * java.lang.IllegalArgumentException if either the String is + * badly formatted or if this kind of property can't be expressed + * as text. + * @param text The string to be parsed. + */ + public void setAsText(String text) throws IllegalArgumentException { + File f = new File(text); + _widget.setText(f.getPath()); + } + + /** + * @return The property value as a human editable string. + *

Returns null if the value can't be expressed + * as an editable string. + *

If a non-null value is returned, then the PropertyEditor should + * be prepared to parse that string back in setAsText(). + */ + public String getAsText() { + return new File(_widget.getText()).getAbsolutePath(); + } + + /** + * Set the default path for the file chooser + * + * @param path default path + */ + public void setDefaultPath(String path) { + _path = path; + } + + /** Handler for presses of the browse button. */ + private class ActionHandler implements ActionListener { + public void actionPerformed(ActionEvent e) { + JFileChooser chooser = null; + if(_widget.getText().length() > 0) { + chooser = new JFileChooser(_widget.getText()); + } + else if(_path != null) { + chooser = new JFileChooser(_path); + } + else { + chooser = new JFileChooser(); + } + _filter = (_filter == null ? + chooser.getAcceptAllFileFilter() : _filter); + chooser.setFileFilter(_filter); + chooser.setFileSelectionMode(JFileChooser.FILES_AND_DIRECTORIES); + if(chooser.showDialog(getChild(), "Select") == + JFileChooser.APPROVE_OPTION) { + setValue(chooser.getSelectedFile()); + } + } + } + +} + +