annotate dwtx/jface/preference/StringButtonFieldEditor.d @ 34:b3c8e32d406f

preference
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Apr 2008 01:45:47 +0200
parents
children ea8ff534f622
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 * Thierry Lach - thierry.lach@bbdodetroit.com - Fix for Bug 37155
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Port to the D programming language:
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 * Frank Benoit <benoit@tionex.de>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 *******************************************************************************/
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 module dwtx.jface.preference.StringButtonFieldEditor;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwtx.jface.preference.StringFieldEditor;
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.events.DisposeEvent;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import dwt.events.DisposeListener;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.events.SelectionAdapter;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.events.SelectionEvent;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.graphics.Point;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import dwt.layout.GridData;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import dwt.widgets.Button;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 import dwt.widgets.Composite;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 import dwt.widgets.Shell;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 import dwtx.core.runtime.Assert;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 import dwtx.jface.dialogs.IDialogConstants;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 import dwtx.jface.resource.JFaceResources;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 import dwt.dwthelper.utils;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * An abstract field editor for a string type preference that presents
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * a string input field with a change button to its right to edit the
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * input field's content. When the user presses the change button, the
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * abstract framework method <code>changePressed()</code> gets called
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * to compute a new string.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 public abstract class StringButtonFieldEditor : StringFieldEditor {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * The change button, or <code>null</code> if none
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * (before creation and after disposal).
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 private Button changeButton;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * The text for the change button, or <code>null</code> if missing.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 private String changeButtonText;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * Creates a new string button field editor
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 protected this() {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * Creates a string button field editor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * @param name the name of the preference this field editor works on
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * @param labelText the label text of the field editor
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * @param parent the parent of the field editor's control
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 protected this(String name, String labelText,
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 Composite parent) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 init(name, labelText);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 createControl(parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * Method declared on FieldEditor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 protected void adjustForNumColumns(int numColumns) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 (cast(GridData) getTextControl().getLayoutData()).horizontalSpan = numColumns - 2;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * Notifies that this field editor's change button has been pressed.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * <p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * Subclasses must implement this method to provide a corresponding
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * new string for the text field. If the returned value is <code>null</code>,
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * the currently displayed value remains.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * </p>
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * @return the new string to display, or <code>null</code> to leave the
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * old string showing
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 protected abstract String changePressed();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * Method declared on StringFieldEditor (and FieldEditor).
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 protected void doFillIntoGrid(Composite parent, int numColumns) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 super.doFillIntoGrid(parent, numColumns - 1);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 changeButton = getChangeControl(parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 GridData gd = new GridData();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 gd.horizontalAlignment = GridData.FILL;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 int widthHint = convertHorizontalDLUsToPixels(changeButton,
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 IDialogConstants.BUTTON_WIDTH);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 gd.widthHint = Math.max(widthHint, changeButton.computeSize(
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 DWT.DEFAULT, DWT.DEFAULT, true).x);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 changeButton.setLayoutData(gd);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 * Get the change control. Create it in parent if required.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * @param parent
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * @return Button
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 protected Button getChangeControl(Composite parent) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 if (changeButton is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 changeButton = new Button(parent, DWT.PUSH);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 if (changeButtonText is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 changeButtonText = JFaceResources.getString("openChange"); //$NON-NLS-1$
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 changeButton.setText(changeButtonText);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 changeButton.setFont(parent.getFont());
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 changeButton.addSelectionListener(new class SelectionAdapter {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 public void widgetSelected(SelectionEvent evt) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 String newValue = changePressed();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 if (newValue !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 setStringValue(newValue);
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 changeButton.addDisposeListener(new class DisposeListener {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 public void widgetDisposed(DisposeEvent event) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 changeButton = null;
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 } else {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 checkParent(changeButton, parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 return changeButton;
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 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 * Method declared on FieldEditor.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 public int getNumberOfControls() {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 return 3;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 * Returns this field editor's shell.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 * @return the shell
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 protected Shell getShell() {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 if (changeButton is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 return null;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 return changeButton.getShell();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 /**
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 * Sets the text of the change button.
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161 *
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 * @param text the new text
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164 public void setChangeButtonText(String text) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 Assert.isNotNull(text);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
166 changeButtonText = text;
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
167 if (changeButton !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
168 changeButton.setText(text);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
169 Point prefSize = changeButton.computeSize(DWT.DEFAULT, DWT.DEFAULT);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
170 GridData data = cast(GridData)changeButton.getLayoutData();
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
171 data.widthHint = Math.max(DWT.DEFAULT, prefSize.x);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
172 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
173 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
174
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
175 /* (non-Javadoc)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
176 * @see dwtx.jface.preference.FieldEditor#setEnabled(bool, dwt.widgets.Composite)
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
177 */
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
178 public void setEnabled(bool enabled, Composite parent) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
179 super.setEnabled(enabled, parent);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
180 if (changeButton !is null) {
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
181 changeButton.setEnabled(enabled);
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
182 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
183 }
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
184
b3c8e32d406f preference
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
185 }