1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.ui;
import org.eclipse.core.variables.IDynamicVariable;
import org.eclipse.core.variables.IStringVariable;
import org.eclipse.core.variables.VariablesPlugin;
import org.eclipse.debug.internal.core.IInternalDebugCoreConstants;
import org.eclipse.debug.internal.ui.DebugUIPlugin;
import org.eclipse.debug.internal.ui.IDebugHelpContextIds;
import org.eclipse.debug.internal.ui.SWTFactory;
import org.eclipse.debug.internal.ui.stringsubstitution.IArgumentSelector;
import org.eclipse.debug.internal.ui.stringsubstitution.StringSubstitutionMessages;
import org.eclipse.debug.internal.ui.stringsubstitution.StringVariableLabelProvider;
import org.eclipse.debug.internal.ui.stringsubstitution.StringVariablePresentationManager;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.ElementListSelectionDialog;
/**
* A dialog that prompts the user to choose and configure a string
* substitution variable.
* <p>
* Clients may instantiate this class.
* </p>
* @since 3.1
* @noextend This class is not intended to be subclassed by clients.
*/
public class StringVariableSelectionDialog extends ElementListSelectionDialog {
// button to configure variable's argument
private Button fArgumentButton;
// variable description
private Text fDescriptionText;
// the argument value
private Text fArgumentText;
private String fArgumentValue;
private Button fEditVariablesButton;
/**
* Constructs a new string substitution variable selection dialog.
*
* @param parent parent shell
*/
public StringVariableSelectionDialog(Shell parent) {
super(parent, new StringVariableLabelProvider());
setShellStyle(getShellStyle() | SWT.RESIZE);
setTitle(StringSubstitutionMessages.StringVariableSelectionDialog_2);
setMessage(StringSubstitutionMessages.StringVariableSelectionDialog_3);
setMultipleSelection(false);
setElements(VariablesPlugin.getDefault().getStringVariableManager().getVariables());
}
/**
* Returns the variable expression the user generated from this
* dialog, or <code>null</code> if none.
*
* @return variable expression the user generated from this
* dialog, or <code>null</code> if none
*/
public String getVariableExpression() {
Object[] selected = getResult();
if (selected != null && selected.length == 1) {
IStringVariable variable = (IStringVariable)selected[0];
StringBuffer buffer = new StringBuffer();
buffer.append("${"); //$NON-NLS-1$
buffer.append(variable.getName());
if (fArgumentValue != null && fArgumentValue.length() > 0) {
buffer.append(":"); //$NON-NLS-1$
buffer.append(fArgumentValue);
}
buffer.append("}"); //$NON-NLS-1$
return buffer.toString();
}
return null;
}
/* (non-Javadoc)
* @see org.eclipse.jface.dialogs.Dialog#createContents(org.eclipse.swt.widgets.Composite)
*/
protected Control createContents(Composite parent) {
Control ctrl = super.createContents(parent);
PlatformUI.getWorkbench().getHelpSystem().setHelp(ctrl, IDebugHelpContextIds.VARIABLE_SELECTION_DIALOG);
return ctrl;
}
/* (non-Javadoc)
* @see org.eclipse.jface.dialogs.Dialog#createDialogArea(org.eclipse.swt.widgets.Composite)
*/
protected Control createDialogArea(Composite parent) {
Control control = super.createDialogArea(parent);
createArgumentArea((Composite)control);
return control;
}
/**
* Creates an area to display a description of the selected variable
* and a button to configure the variable's argument.
*
* @param parent parent widget
*/
private void createArgumentArea(Composite parent) {
Composite container = SWTFactory.createComposite(parent, parent.getFont(), 2, 1, GridData.FILL_HORIZONTAL, 0, 0);
SWTFactory.createHorizontalSpacer(container, 1);
fEditVariablesButton = SWTFactory.createPushButton(container, StringSubstitutionMessages.StringVariableSelectionDialog_0, null, GridData.HORIZONTAL_ALIGN_END);
fEditVariablesButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
editVariables();
}
});
SWTFactory.createWrapLabel(container, StringSubstitutionMessages.StringVariableSelectionDialog_6, 2);
Composite args = SWTFactory.createComposite(container, container.getFont(), 2, 2, GridData.FILL_HORIZONTAL, 0, 0);
fArgumentText = new Text(args, SWT.BORDER);
fArgumentText.setFont(container.getFont());
fArgumentText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
fArgumentButton = SWTFactory.createPushButton(args, StringSubstitutionMessages.StringVariableSelectionDialog_7, null);
fArgumentButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
configureArgument();
}
});
SWTFactory.createWrapLabel(container, StringSubstitutionMessages.StringVariableSelectionDialog_8, 2);
fDescriptionText = new Text(container, SWT.BORDER | SWT.WRAP | SWT.V_SCROLL);
fDescriptionText.setFont(container.getFont());
fDescriptionText.setEditable(false);
GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.horizontalSpan = 2;
gd.heightHint = 50;
fDescriptionText.setLayoutData(gd);
}
/**
* Opens the preference dialog to the correct page an allows editing of variables
*/
protected void editVariables() {
final Display display = DebugUIPlugin.getStandardDisplay();
BusyIndicator.showWhile(display, new Runnable() {
public void run() {
SWTFactory.showPreferencePage("org.eclipse.debug.ui.StringVariablePreferencePage"); //$NON-NLS-1$
final IStringVariable[] elements = VariablesPlugin.getDefault().getStringVariableManager().getVariables();
display.asyncExec(new Runnable() {
public void run() {
setListElements(elements);
}
});
}
});
}
/**
* Configures the argument for the selected variable.
*/
protected void configureArgument() {
Object[] objects = getSelectedElements();
IStringVariable variable = (IStringVariable)objects[0];
IArgumentSelector selector = StringVariablePresentationManager.getDefault().getArgumentSelector(variable);
String value = selector.selectArgument(variable, getShell());
if (value != null) {
fArgumentText.setText(value);
}
}
/**
* Update variable description and argument button enablement.
*
* @see org.eclipse.ui.dialogs.AbstractElementListSelectionDialog#handleSelectionChanged()
*/
protected void handleSelectionChanged() {
super.handleSelectionChanged();
Object[] objects = getSelectedElements();
boolean buttonEnabled = false;
boolean argEnabled = false;
String text = null;
if (objects.length == 1) {
IStringVariable variable = (IStringVariable)objects[0];
IArgumentSelector selector = StringVariablePresentationManager.getDefault().getArgumentSelector(variable);
if (variable instanceof IDynamicVariable) {
argEnabled = ((IDynamicVariable)variable).supportsArgument();
}
buttonEnabled = argEnabled && selector != null;
text = variable.getDescription();
}
if (text == null) {
text = IInternalDebugCoreConstants.EMPTY_STRING;
}
fArgumentText.setEnabled(argEnabled);
fArgumentButton.setEnabled(buttonEnabled);
fDescriptionText.setText(text);
}
/* (non-Javadoc)
* @see org.eclipse.jface.dialogs.Dialog#okPressed()
*/
protected void okPressed() {
fArgumentValue = fArgumentText.getText().trim();
super.okPressed();
}
/**
* Returns the name of the section that this dialog stores its settings in
*
* @return String
*/
private String getDialogSettingsSectionName() {
return IDebugUIConstants.PLUGIN_ID + ".STRING_VARIABLE_SELECTION_DIALOG_SECTION"; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see org.eclipse.jface.dialogs.Dialog#getDialogBoundsSettings()
*/
protected IDialogSettings getDialogBoundsSettings() {
IDialogSettings settings = DebugUIPlugin.getDefault().getDialogSettings();
IDialogSettings section = settings.getSection(getDialogSettingsSectionName());
if (section == null) {
section = settings.addNewSection(getDialogSettingsSectionName());
}
return section;
}
}
|
