1 /*******************************************************************************
2 * Copyright (c) 2000, 2003 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Common Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/cpl-v10.html
9 * IBM Corporation - initial API and implementation
10 *******************************************************************************/
12 package net.sourceforge.phpdt.internal.ui.preferences;
14 import org.eclipse.jface.preference.IPreferenceStore;
15 import org.eclipse.jface.preference.PreferenceStore;
16 import org.eclipse.jface.text.Assert;
17 import org.eclipse.jface.util.IPropertyChangeListener;
18 import org.eclipse.jface.util.PropertyChangeEvent;
21 * An overlaying preference store.
23 public class OverlayPreferenceStore implements IPreferenceStore {
26 public static final class TypeDescriptor {
27 private TypeDescriptor() {
31 public static final TypeDescriptor BOOLEAN= new TypeDescriptor();
32 public static final TypeDescriptor DOUBLE= new TypeDescriptor();
33 public static final TypeDescriptor FLOAT= new TypeDescriptor();
34 public static final TypeDescriptor INT= new TypeDescriptor();
35 public static final TypeDescriptor LONG= new TypeDescriptor();
36 public static final TypeDescriptor STRING= new TypeDescriptor();
38 public static class OverlayKey {
40 TypeDescriptor fDescriptor;
43 public OverlayKey(TypeDescriptor descriptor, String key) {
44 fDescriptor= descriptor;
49 private class PropertyListener implements IPropertyChangeListener {
52 * @see IPropertyChangeListener#propertyChange(PropertyChangeEvent)
54 public void propertyChange(PropertyChangeEvent event) {
55 OverlayKey key= findOverlayKey(event.getProperty());
57 propagateProperty(fParent, key, fStore);
62 private IPreferenceStore fParent;
63 private IPreferenceStore fStore;
64 private OverlayKey[] fOverlayKeys;
66 private PropertyListener fPropertyListener;
67 private boolean fLoaded;
70 public OverlayPreferenceStore(IPreferenceStore parent, OverlayKey[] overlayKeys) {
72 fOverlayKeys= overlayKeys;
73 fStore= new PreferenceStore();
76 private OverlayKey findOverlayKey(String key) {
77 for (int i= 0; i < fOverlayKeys.length; i++) {
78 if (fOverlayKeys[i].fKey.equals(key))
79 return fOverlayKeys[i];
84 private boolean covers(String key) {
85 return (findOverlayKey(key) != null);
88 private void propagateProperty(IPreferenceStore orgin, OverlayKey key, IPreferenceStore target) {
90 if (orgin.isDefault(key.fKey)) {
91 if (!target.isDefault(key.fKey))
92 target.setToDefault(key.fKey);
96 TypeDescriptor d= key.fDescriptor;
99 boolean originValue= orgin.getBoolean(key.fKey);
100 boolean targetValue= target.getBoolean(key.fKey);
101 if (targetValue != originValue)
102 target.setValue(key.fKey, originValue);
104 } else if (DOUBLE == d) {
106 double originValue= orgin.getDouble(key.fKey);
107 double targetValue= target.getDouble(key.fKey);
108 if (targetValue != originValue)
109 target.setValue(key.fKey, originValue);
111 } else if (FLOAT == d) {
113 float originValue= orgin.getFloat(key.fKey);
114 float targetValue= target.getFloat(key.fKey);
115 if (targetValue != originValue)
116 target.setValue(key.fKey, originValue);
118 } else if (INT == d) {
120 int originValue= orgin.getInt(key.fKey);
121 int targetValue= target.getInt(key.fKey);
122 if (targetValue != originValue)
123 target.setValue(key.fKey, originValue);
125 } else if (LONG == d) {
127 long originValue= orgin.getLong(key.fKey);
128 long targetValue= target.getLong(key.fKey);
129 if (targetValue != originValue)
130 target.setValue(key.fKey, originValue);
132 } else if (STRING == d) {
134 String originValue= orgin.getString(key.fKey);
135 String targetValue= target.getString(key.fKey);
136 if (targetValue != null && originValue != null && !targetValue.equals(originValue))
137 target.setValue(key.fKey, originValue);
142 public void propagate() {
143 for (int i= 0; i < fOverlayKeys.length; i++)
144 propagateProperty(fStore, fOverlayKeys[i], fParent);
147 private void loadProperty(IPreferenceStore orgin, OverlayKey key, IPreferenceStore target, boolean forceInitialization) {
148 TypeDescriptor d= key.fDescriptor;
151 if (forceInitialization)
152 target.setValue(key.fKey, true);
153 target.setValue(key.fKey, orgin.getBoolean(key.fKey));
154 target.setDefault(key.fKey, orgin.getDefaultBoolean(key.fKey));
156 } else if (DOUBLE == d) {
158 if (forceInitialization)
159 target.setValue(key.fKey, 1.0D);
160 target.setValue(key.fKey, orgin.getDouble(key.fKey));
161 target.setDefault(key.fKey, orgin.getDefaultDouble(key.fKey));
163 } else if (FLOAT == d) {
165 if (forceInitialization)
166 target.setValue(key.fKey, 1.0F);
167 target.setValue(key.fKey, orgin.getFloat(key.fKey));
168 target.setDefault(key.fKey, orgin.getDefaultFloat(key.fKey));
170 } else if (INT == d) {
172 if (forceInitialization)
173 target.setValue(key.fKey, 1);
174 target.setValue(key.fKey, orgin.getInt(key.fKey));
175 target.setDefault(key.fKey, orgin.getDefaultInt(key.fKey));
177 } else if (LONG == d) {
179 if (forceInitialization)
180 target.setValue(key.fKey, 1L);
181 target.setValue(key.fKey, orgin.getLong(key.fKey));
182 target.setDefault(key.fKey, orgin.getDefaultLong(key.fKey));
184 } else if (STRING == d) {
186 if (forceInitialization)
187 target.setValue(key.fKey, "1"); //$NON-NLS-1$
188 target.setValue(key.fKey, orgin.getString(key.fKey));
189 target.setDefault(key.fKey, orgin.getDefaultString(key.fKey));
195 for (int i= 0; i < fOverlayKeys.length; i++)
196 loadProperty(fParent, fOverlayKeys[i], fStore, true);
202 public void loadDefaults() {
203 for (int i= 0; i < fOverlayKeys.length; i++)
204 setToDefault(fOverlayKeys[i].fKey);
207 public void start() {
208 if (fPropertyListener == null) {
209 fPropertyListener= new PropertyListener();
210 fParent.addPropertyChangeListener(fPropertyListener);
215 if (fPropertyListener != null) {
216 fParent.removePropertyChangeListener(fPropertyListener);
217 fPropertyListener= null;
222 * @see IPreferenceStore#addPropertyChangeListener(IPropertyChangeListener)
224 public void addPropertyChangeListener(IPropertyChangeListener listener) {
225 fStore.addPropertyChangeListener(listener);
229 * @see IPreferenceStore#removePropertyChangeListener(IPropertyChangeListener)
231 public void removePropertyChangeListener(IPropertyChangeListener listener) {
232 fStore.removePropertyChangeListener(listener);
236 * @see IPreferenceStore#firePropertyChangeEvent(String, Object, Object)
238 public void firePropertyChangeEvent(String name, Object oldValue, Object newValue) {
239 fStore.firePropertyChangeEvent(name, oldValue, newValue);
243 * @see IPreferenceStore#contains(String)
245 public boolean contains(String name) {
246 return fStore.contains(name);
250 * @see IPreferenceStore#getBoolean(String)
252 public boolean getBoolean(String name) {
253 return fStore.getBoolean(name);
257 * @see IPreferenceStore#getDefaultBoolean(String)
259 public boolean getDefaultBoolean(String name) {
260 return fStore.getDefaultBoolean(name);
264 * @see IPreferenceStore#getDefaultDouble(String)
266 public double getDefaultDouble(String name) {
267 return fStore.getDefaultDouble(name);
271 * @see IPreferenceStore#getDefaultFloat(String)
273 public float getDefaultFloat(String name) {
274 return fStore.getDefaultFloat(name);
278 * @see IPreferenceStore#getDefaultInt(String)
280 public int getDefaultInt(String name) {
281 return fStore.getDefaultInt(name);
285 * @see IPreferenceStore#getDefaultLong(String)
287 public long getDefaultLong(String name) {
288 return fStore.getDefaultLong(name);
292 * @see IPreferenceStore#getDefaultString(String)
294 public String getDefaultString(String name) {
295 return fStore.getDefaultString(name);
299 * @see IPreferenceStore#getDouble(String)
301 public double getDouble(String name) {
302 return fStore.getDouble(name);
306 * @see IPreferenceStore#getFloat(String)
308 public float getFloat(String name) {
309 return fStore.getFloat(name);
313 * @see IPreferenceStore#getInt(String)
315 public int getInt(String name) {
316 return fStore.getInt(name);
320 * @see IPreferenceStore#getLong(String)
322 public long getLong(String name) {
323 return fStore.getLong(name);
327 * @see IPreferenceStore#getString(String)
329 public String getString(String name) {
330 return fStore.getString(name);
334 * @see IPreferenceStore#isDefault(String)
336 public boolean isDefault(String name) {
337 return fStore.isDefault(name);
341 * @see IPreferenceStore#needsSaving()
343 public boolean needsSaving() {
344 return fStore.needsSaving();
348 * @see IPreferenceStore#putValue(String, String)
350 public void putValue(String name, String value) {
352 fStore.putValue(name, value);
356 * @see IPreferenceStore#setDefault(String, double)
358 public void setDefault(String name, double value) {
360 fStore.setDefault(name, value);
364 * @see IPreferenceStore#setDefault(String, float)
366 public void setDefault(String name, float value) {
368 fStore.setDefault(name, value);
372 * @see IPreferenceStore#setDefault(String, int)
374 public void setDefault(String name, int value) {
376 fStore.setDefault(name, value);
380 * @see IPreferenceStore#setDefault(String, long)
382 public void setDefault(String name, long value) {
384 fStore.setDefault(name, value);
388 * @see IPreferenceStore#setDefault(String, String)
390 public void setDefault(String name, String value) {
392 fStore.setDefault(name, value);
396 * @see IPreferenceStore#setDefault(String, boolean)
398 public void setDefault(String name, boolean value) {
400 fStore.setDefault(name, value);
404 * @see IPreferenceStore#setToDefault(String)
406 public void setToDefault(String name) {
407 fStore.setToDefault(name);
411 * @see IPreferenceStore#setValue(String, double)
413 public void setValue(String name, double value) {
415 fStore.setValue(name, value);
419 * @see IPreferenceStore#setValue(String, float)
421 public void setValue(String name, float value) {
423 fStore.setValue(name, value);
427 * @see IPreferenceStore#setValue(String, int)
429 public void setValue(String name, int value) {
431 fStore.setValue(name, value);
435 * @see IPreferenceStore#setValue(String, long)
437 public void setValue(String name, long value) {
439 fStore.setValue(name, value);
443 * @see IPreferenceStore#setValue(String, String)
445 public void setValue(String name, String value) {
447 fStore.setValue(name, value);
451 * @see IPreferenceStore#setValue(String, boolean)
453 public void setValue(String name, boolean value) {
455 fStore.setValue(name, value);
459 * The keys to add to the list of overlay keys.
461 * Note: This method must be called before {@link #load()} is called.
467 public void addKeys(OverlayKey[] keys) {
468 Assert.isTrue(!fLoaded);
469 Assert.isNotNull(keys);
471 int overlayKeysLength= fOverlayKeys.length;
472 OverlayKey[] result= new OverlayKey[keys.length + overlayKeysLength];
474 for (int i= 0, length= overlayKeysLength; i < length; i++)
475 result[i]= fOverlayKeys[i];
477 for (int i= 0, length= keys.length; i < length; i++)
478 result[overlayKeysLength + i]= keys[i];
480 fOverlayKeys= result;