net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/overlaypages/FieldEditorOverlayPage.java

   1 /*******************************************************************************
   2  * Copyright (c) 2003 Berthold Daum.
   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
   7  *
   8  * Contributors:
   9  *     Berthold Daum
  10  *******************************************************************************/
  11 package net.sourceforge.phpeclipse.overlaypages;
  12 import java.util.ArrayList;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import org.eclipse.core.resources.IResource;
  16 import org.eclipse.core.runtime.CoreException;
  17 import org.eclipse.core.runtime.IAdaptable;
  18 import org.eclipse.core.runtime.QualifiedName;
  19 import org.eclipse.jface.preference.FieldEditor;
  20 import org.eclipse.jface.preference.FieldEditorPreferencePage;
  21 import org.eclipse.jface.preference.IPreferenceNode;
  22 import org.eclipse.jface.preference.IPreferencePage;
  23 import org.eclipse.jface.preference.IPreferenceStore;
  24 import org.eclipse.jface.preference.PreferenceDialog;
  25 import org.eclipse.jface.preference.PreferenceManager;
  26 import org.eclipse.jface.preference.PreferenceNode;
  27 import org.eclipse.jface.resource.ImageDescriptor;
  28 import org.eclipse.swt.SWT;
  29 import org.eclipse.swt.custom.BusyIndicator;
  30 import org.eclipse.swt.events.SelectionAdapter;
  31 import org.eclipse.swt.events.SelectionEvent;
  32 import org.eclipse.swt.layout.GridData;
  33 import org.eclipse.swt.layout.GridLayout;
  34 import org.eclipse.swt.widgets.Button;
  35 import org.eclipse.swt.widgets.Composite;
  36 import org.eclipse.swt.widgets.Control;
  37 import org.eclipse.ui.IWorkbenchPropertyPage;
  38 /**
  39  * @author Berthold Daum
  40  */
  41 public abstract class FieldEditorOverlayPage extends FieldEditorPreferencePage
  42     implements
  43       IWorkbenchPropertyPage {
  44   /**
  45    * * Name of resource property for the selection of workbench or project
  46    * settings **
  47    */
  48   public static final String USEPROJECTSETTINGS = "useProjectSettings"; //$NON-NLS-1$
  49   private static final String FALSE = "false"; //$NON-NLS-1$
  50   private static final String TRUE = "true"; //$NON-NLS-1$
  51   private boolean fUseFileSettings = false;
  52   // Stores all created field editors
  53   private List editors = new ArrayList();
  54   // Stores owning element of properties
  55   private IAdaptable element;
  56   // Additional buttons for property pages
  57   private Button useWorkspaceSettingsButton, useProjectSettingsButton,
  58       configureButton;
  59   // Overlay preference store for property pages
  60   private IPreferenceStore overlayStore;
  61   // The image descriptor of this pages title image
  62   private ImageDescriptor image;
  63   // Cache for page id
  64   private String pageId;
  65   /**
  66    * Constructor
  67    *
  68    * @param style -
  69    *            layout style
  70    */
  71   public FieldEditorOverlayPage(int style) {
  72     super(style);
  73   }
  74   /**
  75    * Constructor
  76    *
  77    * @param style -
  78    *            layout style
  79    */
  80   public FieldEditorOverlayPage(int style, boolean isFileSettings) {
  81     super(style);
  82     fUseFileSettings = isFileSettings;
  83   }
  84   /**
  85    * Constructor
  86    *
  87    * @param title -
  88    *            title string
  89    * @param style -
  90    *            layout style
  91    */
  92   public FieldEditorOverlayPage(String title, int style) {
  93     super(title, style);
  94   }
  95   public FieldEditorOverlayPage(String title, int style, boolean isFileSettings) {
  96     super(title, style);
  97     fUseFileSettings = isFileSettings;
  98   }
  99   /**
 100    * Constructor
 101    *
 102    * @param title -
 103    *            title string
 104    * @param image -
 105    *            title image
 106    * @param style -
 107    *            layout style
 108    */
 109   public FieldEditorOverlayPage(String title, ImageDescriptor image, int style) {
 110     super(title, image, style);
 111     this.image = image;
 112   }
 113   /**
 114    * Returns the id of the current preference page as defined in plugin.xml
 115    * Subclasses must implement.
 116    *
 117    * @return - the qualifier
 118    */
 119   protected abstract String getPageId();
 120   /**
 121    * Receives the object that owns the properties shown in this property page.
 122    *
 123    * @see org.eclipse.ui.IWorkbenchPropertyPage#setElement(org.eclipse.core.runtime.IAdaptable)
 124    */
 125   public void setElement(IAdaptable element) {
 126     this.element = element;
 127   }
 128   /**
 129    * Delivers the object that owns the properties shown in this property page.
 130    *
 131    * @see org.eclipse.ui.IWorkbenchPropertyPage#getElement()
 132    */
 133   public IAdaptable getElement() {
 134     return element;
 135   }
 136   /**
 137    * Returns true if this instance represents a property page
 138    *
 139    * @return - true for property pages, false for preference pages
 140    */
 141   public boolean isPropertyPage() {
 142     return getElement() != null;
 143   }
 144   /**
 145    * We override the addField method. This allows us to store each field editor
 146    * added by subclasses in a list for later processing.
 147    *
 148    * @see org.eclipse.jface.preference.FieldEditorPreferencePage#addField(org.eclipse.jface.preference.FieldEditor)
 149    */
 150   protected void addField(FieldEditor editor) {
 151     editors.add(editor);
 152     super.addField(editor);
 153   }
 154   /**
 155    * We override the createControl method. In case of property pages we create
 156    * a new PropertyStore as local preference store. After all control have been
 157    * create, we enable/disable these controls.
 158    *
 159    * @see org.eclipse.jface.preference.PreferencePage#createControl()
 160    */
 161   public void createControl(Composite parent) {
 162     // Special treatment for property pages
 163     if (isPropertyPage()) {
 164       // Cache the page id
 165       pageId = getPageId();
 166       // Create an overlay preference store and fill it with properties
 167       overlayStore = new PropertyStore((IResource) getElement(), super
 168           .getPreferenceStore(), pageId);
 169       // Set overlay store as current preference store
 170     }
 171     super.createControl(parent);
 172     // Update state of all subclass controls
 173     if (isPropertyPage())
 174       updateFieldEditors();
 175   }
 176   /**
 177    * We override the createContents method. In case of property pages we insert
 178    * two radio buttons at the top of the page.
 179    *
 180    * @see org.eclipse.jface.preference.PreferencePage#createContents(org.eclipse.swt.widgets.Composite)
 181    */
 182   protected Control createContents(Composite parent) {
 183     if (isPropertyPage())
 184       createSelectionGroup(parent);
 185     return super.createContents(parent);
 186   }
 187   /**
 188    * Creates and initializes a selection group with two choice buttons and one
 189    * push button.
 190    *
 191    * @param parent -
 192    *            the parent composite
 193    */
 194   private void createSelectionGroup(Composite parent) {
 195     Composite comp = new Composite(parent, SWT.NONE);
 196     GridLayout layout = new GridLayout(2, false);
 197     layout.marginHeight = 0;
 198     layout.marginWidth = 0;
 199     comp.setLayout(layout);
 200     comp.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
 201     Composite radioGroup = new Composite(comp, SWT.NONE);
 202     radioGroup.setLayout(new GridLayout());
 203     radioGroup.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
 204     useWorkspaceSettingsButton = createRadioButton(radioGroup, Messages
 205         .getString("OverlayPage.Use_Workspace_Settings")); //$NON-NLS-1$
 206     if (fUseFileSettings) {
 207       useProjectSettingsButton = createRadioButton(radioGroup, Messages
 208           .getString("OverlayPage.Use_File_Settings")); //$NON-NLS-1$
 209     } else {
 210       useProjectSettingsButton = createRadioButton(radioGroup, Messages
 211           .getString("OverlayPage.Use_Project_Settings")); //$NON-NLS-1$
 212     }
 213     configureButton = new Button(comp, SWT.PUSH);
 214     configureButton.setText(Messages
 215         .getString("OverlayPage.Configure_Workspace_Settings")); //$NON-NLS-1$
 216     configureButton.addSelectionListener(new SelectionAdapter() {
 217       public void widgetSelected(SelectionEvent e) {
 218         configureWorkspaceSettings();
 219       }
 220     });
 221     // Set workspace/project radio buttons
 222     try {
 223       String use = ((IResource) getElement())
 224           .getPersistentProperty(new QualifiedName(pageId, USEPROJECTSETTINGS));
 225       if (TRUE.equals(use)) {
 226         useProjectSettingsButton.setSelection(true);
 227         configureButton.setEnabled(false);
 228       } else
 229         useWorkspaceSettingsButton.setSelection(true);
 230     } catch (CoreException e) {
 231       useWorkspaceSettingsButton.setSelection(true);
 232     }
 233   }
 234   /**
 235    * Convenience method creating a radio button
 236    *
 237    * @param parent -
 238    *            the parent composite
 239    * @param label -
 240    *            the button label
 241    * @return - the new button
 242    */
 243   private Button createRadioButton(Composite parent, String label) {
 244     final Button button = new Button(parent, SWT.RADIO);
 245     button.setText(label);
 246     button.addSelectionListener(new SelectionAdapter() {
 247       public void widgetSelected(SelectionEvent e) {
 248         configureButton.setEnabled(button == useWorkspaceSettingsButton);
 249         updateFieldEditors();
 250       }
 251     });
 252     return button;
 253   }
 254   /**
 255    * Returns in case of property pages the overlay store, in case of preference
 256    * pages the standard preference store
 257    *
 258    * @see org.eclipse.jface.preference.PreferencePage#getPreferenceStore()
 259    */
 260   public IPreferenceStore getPreferenceStore() {
 261     if (isPropertyPage())
 262       return overlayStore;
 263     return super.getPreferenceStore();
 264   }
 265   /*
 266    * Enables or disables the field editors and buttons of this page
 267    */
 268   private void updateFieldEditors() {
 269     // We iterate through all field editors
 270     boolean enabled = useProjectSettingsButton.getSelection();
 271     updateFieldEditors(enabled);
 272   }
 273   /**
 274    * Enables or disables the field editors and buttons of this page Subclasses
 275    * may override.
 276    *
 277    * @param enabled -
 278    *            true if enabled
 279    */
 280   protected void updateFieldEditors(boolean enabled) {
 281     Composite parent = getFieldEditorParent();
 282     Iterator it = editors.iterator();
 283     while (it.hasNext()) {
 284       FieldEditor editor = (FieldEditor) it.next();
 285       editor.setEnabled(enabled, parent);
 286     }
 287   }
 288   /**
 289    * We override the performOk method. In case of property pages we copy the
 290    * values in the overlay store into the property values of the selected
 291    * project. We also save the state of the radio buttons.
 292    *
 293    * @see org.eclipse.jface.preference.IPreferencePage#performOk()
 294    */
 295   public boolean performOk() {
 296     boolean result = super.performOk();
 297     if (result && isPropertyPage()) {
 298       // Save state of radiobuttons in project properties
 299       IResource resource = (IResource) getElement();
 300       try {
 301         String value = (useProjectSettingsButton.getSelection()) ? TRUE : FALSE;
 302         resource.setPersistentProperty(new QualifiedName(pageId,
 303             USEPROJECTSETTINGS), value);
 304       } catch (CoreException e) {
 305       }
 306     }
 307     return result;
 308   }
 309   /**
 310    * We override the performDefaults method. In case of property pages we
 311    * switch back to the workspace settings and disable the field editors.
 312    *
 313    * @see org.eclipse.jface.preference.PreferencePage#performDefaults()
 314    */
 315   protected void performDefaults() {
 316     if (isPropertyPage()) {
 317       useWorkspaceSettingsButton.setSelection(true);
 318       useProjectSettingsButton.setSelection(false);
 319       configureButton.setEnabled(true);
 320       updateFieldEditors();
 321     }
 322     super.performDefaults();
 323   }
 324   /**
 325    * Creates a new preferences page and opens it
 326    *
 327    * @see com.bdaum.SpellChecker.preferences.SpellCheckerPreferencePage#configureWorkspaceSettings()
 328    */
 329   protected void configureWorkspaceSettings() {
 330     try {
 331       // create a new instance of the current class
 332       IPreferencePage page = (IPreferencePage) this.getClass().newInstance();
 333       page.setTitle(getTitle());
 334       page.setImageDescriptor(image);
 335       // and show it
 336       showPreferencePage(pageId, page);
 337     } catch (InstantiationException e) {
 338       e.printStackTrace();
 339     } catch (IllegalAccessException e) {
 340       e.printStackTrace();
 341     }
 342   }
 343   /**
 344    * Show a single preference pages
 345    *
 346    * @param id -
 347    *            the preference page identification
 348    * @param page -
 349    *            the preference page
 350    */
 351   protected void showPreferencePage(String id, IPreferencePage page) {
 352     final IPreferenceNode targetNode = new PreferenceNode(id, page);
 353     PreferenceManager manager = new PreferenceManager();
 354     manager.addToRoot(targetNode);
 355     final PreferenceDialog dialog = new PreferenceDialog(getControl()
 356         .getShell(), manager);
 357     BusyIndicator.showWhile(getControl().getDisplay(), new Runnable() {
 358       public void run() {
 359         dialog.create();
 360         dialog.setMessage(targetNode.getLabelText());
 361         dialog.open();
 362       }
 363     });
 364   }
 365 }