blob: 6f2805acce7d2ed50f3778cb6fda7fd953b34863 (
plain) (
blame)
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
|
/****************************************************************************
* Copyright (c) 2008 Atos Origin.
*
* 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:
* Thibault Landre (Atos Origin) - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.preferences.pages;
import java.util.HashSet;
import java.util.Set;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ProjectScope;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferencePage;
import org.eclipse.papyrus.preferences.Activator;
import org.eclipse.papyrus.preferences.pages.internal.VisiblePageSingleton;
import org.eclipse.papyrus.preferences.ui.AbstractGroup;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;
import org.eclipse.ui.IWorkbenchPropertyPage;
import org.eclipse.ui.preferences.ScopedPreferenceStore;
/**
* An abstract implementation of a Preference page.
*
* This preference page allows clients to define preference page in the preference of Eclipse, and
* in the properties of a project in the workspace.
* <p>
* Clients must implement :
* <ul>
* <li><code>getBundleId()</code> method in order to define the preference scope (Project or Instance) of the preference page.</li>
* <li><code>createPageContents()</code> method to populate the preference page with the different {@link AbstractGroup}. </br>Each group added has to
* be declared through the <code>addAbstractGroup(AbstractGroup fe)</code> method</li>
* </ul>
* </p>
*/
public abstract class AbstractPapyrusPreferencePage extends PreferencePage implements IWorkbenchPreferencePage, IWorkbenchPropertyPage {
private IProject project;
private Set<AbstractGroup> groupSet;
private String key;
/**
* @see org.eclipse.ui.IWorkbenchPropertyPage#getElement()
*/
public IAdaptable getElement() {
return project;
}
protected void setPreferenceKey(String aKey) {
this.key = aKey;
}
protected String getPreferenceKey() {
return this.key;
}
public IPreferenceStore getPreferenceStore() {
return Activator.getDefault().getPreferenceStore();
}
/**
* @see org.eclipse.ui.IWorkbenchPropertyPage#setElement(org.eclipse.core.runtime.IAdaptable)
*/
public void setElement(IAdaptable element) {
project = (IProject)element.getAdapter(IResource.class);
}
/**
* @see org.eclipse.jface.preference.PreferencePage#doGetPreferenceStore()
*/
protected IPreferenceStore doGetPreferenceStore() {
IPreferenceStore store;
if(project != null) {
store = new ScopedPreferenceStore(new ProjectScope(project), getBundleId());
} else {
store = new ScopedPreferenceStore(new InstanceScope(), getBundleId());
}
return store;
}
/**
* Initializes this preference page for the given workbench.
*
* @param workbench
* the workbench
*
* @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
*
*/
public void init(IWorkbench workbench) {
// Do nothing
}
/**
* Create the Papyrus preference page and inits the different fields editor contained in the
* page.
* <p>
* This method shouldn't be overriden by sub-classes
* </p>
* {@inheritDoc}
*/
@Override
protected Control createContents(Composite parent) {
// Create the container composite
Composite container = new Composite(parent, SWT.NONE);
GridLayout containerLayout = new GridLayout();
container.setLayout(containerLayout);
createPageContents(container);
initGroup();
return container;
}
/**
* Populate the preference page with the different field editor.
* <p>
* Each field added has to be declared through the <code>addEditorFields(FieldEditor fe)</code> method
* </p>
*
* @param parent
* the parent composite
*/
protected abstract void createPageContents(Composite parent);
/**
* Add the given field editor to the page.
*/
protected void addAbstractGroup(AbstractGroup fe) {
if(groupSet == null) {
groupSet = new HashSet<AbstractGroup>();
}
groupSet.add(fe);
}
public boolean performOk() {
VisiblePageSingleton.getInstance().store();
return super.performOk();
}
/**
* Stores the values of the fields contained in this page into the preference store.
*/
protected void storePreferences() {
if(groupSet != null) {
for(AbstractGroup gs : groupSet) {
gs.storePreferences();
}
}
}
/**
* Store all preferences
*/
public void storeAllPreferences() {
storePreferences();
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.preference.PreferencePage#performDefaults()
*/
protected void performDefaults() {
loadDefaultPreferences();
super.performDefaults();
}
/**
* Load the default preferences of the fields contained in this page
*/
private void loadDefaultPreferences() {
if(groupSet != null) {
for(AbstractGroup gs : groupSet) {
gs.loadDefault();
}
}
}
/**
* Init groups contained in this page.
*/
private void initGroup() {
if(groupSet != null) {
for(AbstractGroup gs : groupSet) {
gs.setPreferenceStore(getPreferenceStore());
gs.load();
}
}
}
@Override
public void dispose() {
super.dispose();
if(groupSet != null) {
for(AbstractGroup gs : groupSet) {
gs.dispose();
}
}
}
@Override
public void setVisible(boolean visible) {
// TODO Auto-generated method stub
if(visible == true) {
VisiblePageSingleton.getInstance().setVisiblePage(this);
initGroup();
}
super.setVisible(visible);
}
/**
* The bundle ID used to defined the preference store
*
* @return String
*/
protected abstract String getBundleId();
}
|
