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
246
247
248
249
250
251
|
/*******************************************************************************
* Copyright (c) 2011, 2013 Wind River Systems, Inc. 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:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.ui.views.editor.pages;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.tcf.te.runtime.nls.Messages;
import org.eclipse.tcf.te.ui.jface.interfaces.IValidatingContainer;
import org.eclipse.tcf.te.ui.views.activator.UIPlugin;
import org.eclipse.tcf.te.ui.views.editor.Editor;
import org.eclipse.tcf.te.ui.views.interfaces.IEditorPage;
import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.editor.FormPage;
import org.eclipse.ui.forms.widgets.ScrolledForm;
import org.eclipse.ui.part.MultiPageSelectionProvider;
/**
* Abstract details editor page implementation.
*/
public abstract class AbstractEditorPage extends FormPage implements IEditorPage, IValidatingContainer {
// The unique page id
private String id;
private Composite messageComp = null;
private Label message = null;
private Label messageType = null;
/**
* Constructor.
*/
public AbstractEditorPage() {
super("", ""); // //$NON-NLS-1$ //$NON-NLS-2$
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.part.EditorPart#setInitializationData(org.eclipse.core.runtime.
* IConfigurationElement, java.lang.String, java.lang.Object)
*/
@Override
public void setInitializationData(IConfigurationElement config, String propertyName, Object data) {
super.setInitializationData(config, propertyName, data);
if (config != null) {
// Initialize the id field by reading the <id> extension attribute.
// Throws an exception if the id is empty or null.
id = config.getAttribute("id"); //$NON-NLS-1$
if (id == null || id.trim().length() == 0) {
IStatus status = new Status(IStatus.ERROR, UIPlugin.getUniqueIdentifier(),
NLS.bind(Messages.Extension_error_missingRequiredAttribute, "id", config.getContributor().getName())); //$NON-NLS-1$
UIPlugin.getDefault().getLog().log(status);
}
}
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.forms.editor.FormPage#getId()
*/
@Override
public String getId() {
return id;
}
/*
* (non-Javadoc)
* @see
* org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm)
*/
@Override
protected void createFormContent(IManagedForm managedForm) {
super.createFormContent(managedForm);
Assert.isNotNull(managedForm);
managedForm.setInput(getEditorInputNode());
messageComp = new Composite(managedForm.getForm().getForm().getHead(), SWT.NONE);
GridLayout gl = new GridLayout(2, false);
gl.marginHeight = 0;
gl.marginWidth = 0;
gl.marginLeft = 0;
gl.marginRight = 0;
messageComp.setLayout(gl);
messageType = new Label(messageComp, SWT.NONE);
GridData gd = new GridData(20, 20);
messageType.setLayoutData(gd);
message = new Label(messageComp, SWT.NONE);
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.part.EditorPart#setInput(org.eclipse.ui.IEditorInput)
*/
@Override
protected void setInput(IEditorInput input) {
super.setInput(input);
// Update the managed form too
if (getManagedForm() != null) {
getManagedForm().setInput(getEditorInputNode());
}
getSite().getSelectionProvider().setSelection(input != null ? new StructuredSelection(getEditorInputNode()) : null);
// The part name may change if the input changes
setPartName(getPartName());
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.part.EditorPart#setInputWithNotify(org.eclipse.ui.IEditorInput)
*/
@Override
protected void setInputWithNotify(IEditorInput input) {
super.setInputWithNotify(input);
// Update the managed form too
if (getManagedForm() != null) {
getManagedForm().setInput(getEditorInputNode());
}
getSite().getSelectionProvider().setSelection(input != null ? new StructuredSelection(getEditorInputNode()) : null);
// The part name may change if the input changes
setPartName(getPartName());
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.forms.editor.FormPage#setActive(boolean)
*/
@Override
public void setActive(boolean active) {
super.setActive(active);
if (!active) {
ISelection selection = getEditorInput() != null ? new StructuredSelection(getEditorInputNode()) : null;
getSite().getSelectionProvider().setSelection(selection);
if (getSite().getSelectionProvider() instanceof MultiPageSelectionProvider) {
SelectionChangedEvent changedEvent = new SelectionChangedEvent(getSite().getSelectionProvider(), selection);
((MultiPageSelectionProvider) getSite().getSelectionProvider()).firePostSelectionChanged(changedEvent);
}
}
}
/**
* Returns the node associated with the current editor input.
*
* @return The node or <code>null</code>.
*/
public Object getEditorInputNode() {
IEditorInput input = getEditorInput();
return input != null ? input.getAdapter(Object.class) : null;
}
/**
* Called from the parent properties editor <code>doSave(IProgressMonitor)</code> method.
*
* @param monitor The progress monitor or <code>null</code>
* @see Editor#doSave(IProgressMonitor)
*/
public void preDoSave(IProgressMonitor monitor) {
// do nothing
}
/**
* Called from the parent properties editor <code>doSave(IProgressMonitor)</code> method.
*
* @param monitor The progress monitor or <code>null</code>
* @see Editor#doSave(IProgressMonitor)
*/
public void postDoSave(IProgressMonitor monitor) {
// do nothing
}
/*
* (non-Javadoc)
* @see org.eclipse.tcf.te.ui.jface.interfaces.IValidatingContainer#validate()
*/
@Override
public final void validate() {
ValidationResult result = doValidate();
if (result != null)
setMessage(result.getMessage(), result.getMessageType());
else
setMessage(null, IMessageProvider.NONE);
}
/**
* Get the image for the given message type.
* @param messageType The message type.
* @return The image.
*/
protected Image getMessageImage(int messageType) {
switch (messageType) {
case IMessageProvider.INFORMATION:
return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_INFO);
case IMessageProvider.WARNING:
return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_WARNING);
case IMessageProvider.ERROR:
return JFaceResources.getImage(Dialog.DLG_IMG_MESSAGE_ERROR);
default:
return null;
}
}
/**
* Set a message to this editor page.
* @param message The message.
* @param messageType The message type.
*/
@Override
public void setMessage(String text, int type) {
if (getManagedForm() != null && messageComp != null && message != null && messageType != null) {
ScrolledForm form = getManagedForm().getForm();
if (text != null) {
messageType.setImage(getMessageImage(type));
message.setText(text);
form.setHeadClient(messageComp);
}
else {
form.setHeadClient(null);
}
}
}
/**
* Do the validation.
*
* @return The validation result or <code>null</code>.
*/
protected ValidationResult doValidate() {
return new ValidationResult();
}
}
|
