annotate dwtx/jface/preference/FileFieldEditor.d @ 43:ea8ff534f622

Fix override and super aliases
author Frank Benoit <benoit@tionex.de>
date Fri, 11 Apr 2008 01:24:25 +0200
parents b3c8e32d406f
children 3ed358ab21c9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.preference.FileFieldEditor;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.preference.StringButtonFieldEditor;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 // import java.io.File;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.DWT;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.widgets.Composite;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.widgets.FileDialog;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwtx.jface.resource.JFaceResources;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.dwthelper.utils;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import tango.io.FilePath;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import tango.io.FileSystem;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * A field editor for a file path type preference. A standard file
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * dialog appears when the user presses the change button.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 public class FileFieldEditor : StringButtonFieldEditor {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * List of legal file extension suffixes, or <code>null</code>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * for system defaults.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 private String[] extensions = null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * Indicates whether the path must be absolute;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * <code>false</code> by default.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 private bool enforceAbsolute = false;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * Creates a new file field editor
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 protected this() {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * Creates a file field editor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param name the name of the preference this field editor works on
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * @param labelText the label text of the field editor
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * @param parent the parent of the field editor's control
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 public this(String name, String labelText, Composite parent) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 this(name, labelText, false, parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * Creates a file field editor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * @param name the name of the preference this field editor works on
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * @param labelText the label text of the field editor
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * @param enforceAbsolute <code>true</code> if the file path
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * must be absolute, and <code>false</code> otherwise
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @param parent the parent of the field editor's control
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 public this(String name, String labelText,
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 bool enforceAbsolute, Composite parent) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 init(name, labelText);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 this.enforceAbsolute = enforceAbsolute;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 setErrorMessage(JFaceResources
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 .getString("FileFieldEditor.errorMessage"));//$NON-NLS-1$
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 setChangeButtonText(JFaceResources.getString("openBrowse"));//$NON-NLS-1$
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 setValidateStrategy(VALIDATE_ON_FOCUS_LOST);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 createControl(parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * Method declared on StringButtonFieldEditor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * Opens the file chooser dialog and returns the selected file.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 */
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 34
diff changeset
86 protected override String changePressed() {
34
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 auto f = new FilePath(getTextControl().getText());
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 if (!f.exists()) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 f = cast(FilePath)null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 auto d = getFile(f);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 if (d is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 return null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 return FileSystem.toAbsolute( d ).toString();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * Method declared on StringFieldEditor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * Checks whether the text input field specifies an existing file.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 */
43
ea8ff534f622 Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents: 34
diff changeset
103 protected override bool checkState() {
34
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 String msg = null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 String path = getTextControl().getText();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 if (path !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 path = path.trim();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 } else {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 path = "";//$NON-NLS-1$
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 if (path.length is 0) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 if (!isEmptyStringAllowed()) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 msg = getErrorMessage();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 } else {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 auto file = new FilePath(path);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 if (/+file.isFile()+/ file.exists && !file.isFolder ) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 if (enforceAbsolute && !file.isAbsolute()) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 msg = JFaceResources
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 .getString("FileFieldEditor.errorMessage2");//$NON-NLS-1$
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 } else {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 msg = getErrorMessage();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 if (msg !is null) { // error
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 showErrorMessage(msg);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 return false;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 // OK!
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 clearErrorMessage();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 return true;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 * Helper to open the file chooser dialog.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 * @param startingDirectory the directory to open the dialog on.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 * @return File The File the user selected or <code>null</code> if they
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 * do not.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 private FilePath getFile(FilePath startingDirectory) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 FileDialog dialog = new FileDialog(getShell(), DWT.OPEN);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 if (startingDirectory !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 dialog.setFileName(startingDirectory.path());
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 if (extensions !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 dialog.setFilterExtensions(extensions);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 String file = dialog.open();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 if (file !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 file = file.trim();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 if (file.length > 0) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 return new FilePath(file);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 return null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
166 * Sets this file field editor's file extension filter.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
167 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
168 * @param extensions a list of file extension, or <code>null</code>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
169 * to set the filter to the system's default value
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
170 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
171 public void setFileExtensions(String[] extensions) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
172 this.extensions = extensions;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
173 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
174 }