| /******************************************************************************* |
| * Copyright (c) 2000, 2011 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.jdt.internal.ui.javaeditor.saveparticipant; |
| |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.layout.GridData; |
| import org.eclipse.swt.layout.GridLayout; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| |
| import org.eclipse.core.runtime.IAdaptable; |
| import org.eclipse.core.runtime.preferences.DefaultScope; |
| import org.eclipse.core.runtime.preferences.IEclipsePreferences; |
| import org.eclipse.core.runtime.preferences.IScopeContext; |
| import org.eclipse.core.runtime.preferences.InstanceScope; |
| |
| import org.eclipse.core.resources.ProjectScope; |
| |
| import org.eclipse.jface.preference.IPreferencePageContainer; |
| |
| import org.eclipse.jdt.ui.JavaUI; |
| |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.DialogField; |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.IDialogFieldListener; |
| import org.eclipse.jdt.internal.ui.wizards.dialogfields.SelectionButtonDialogField; |
| |
| public abstract class AbstractSaveParticipantPreferenceConfiguration implements ISaveParticipantPreferenceConfiguration { |
| |
| /** |
| * Preference prefix that is appended to the id of {@link SaveParticipantDescriptor save participants}. |
| * |
| * <p> |
| * Value is of type <code>Boolean</code>. |
| * </p> |
| * |
| * @see SaveParticipantDescriptor |
| * @since 3.3 |
| */ |
| private static final String EDITOR_SAVE_PARTICIPANT_PREFIX= "editor_save_participant_"; //$NON-NLS-1$ |
| |
| private SelectionButtonDialogField fEnableField; |
| private IScopeContext fContext; |
| |
| /** |
| * @return id of the post save listener managed by this configuration block |
| */ |
| protected abstract String getPostSaveListenerId(); |
| |
| /** |
| * @return human readable name of the post save listener managed by this configuration block |
| */ |
| protected abstract String getPostSaveListenerName(); |
| |
| /** |
| * Subclasses can add specific controls |
| * |
| * @param parent the parent to use to add the control to |
| * @param container the container showing the preferences |
| */ |
| protected void createConfigControl(Composite parent, IPreferencePageContainer container) { |
| //Default has no specific controls |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public Control createControl(Composite parent, IPreferencePageContainer container) { |
| Composite composite= new Composite(parent, SWT.NONE); |
| GridData gridData= new GridData(SWT.FILL, SWT.FILL, true, true); |
| composite.setLayoutData(gridData); |
| GridLayout layout= new GridLayout(); |
| layout.marginHeight= 0; |
| layout.marginWidth= 0; |
| composite.setLayout(layout); |
| |
| fEnableField= new SelectionButtonDialogField(SWT.CHECK); |
| fEnableField.setLabelText(getPostSaveListenerName()); |
| fEnableField.doFillIntoGrid(composite, 1); |
| |
| createConfigControl(composite, container); |
| |
| return composite; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void initialize(final IScopeContext context, IAdaptable element) { |
| boolean enabled= isEnabled(context); |
| fEnableField.setSelection(enabled); |
| |
| fEnableField.setDialogFieldListener(new IDialogFieldListener() { |
| public void dialogFieldChanged(DialogField field) { |
| fContext.getNode(JavaUI.ID_PLUGIN).putBoolean(getPreferenceKey(), fEnableField.isSelected()); |
| enabled(fEnableField.isSelected()); |
| } |
| |
| }); |
| |
| fContext= context; |
| |
| enabled(enabled); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void dispose() {} |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void performDefaults() { |
| String key= getPreferenceKey(); |
| boolean defaultEnabled; |
| if (ProjectScope.SCOPE.equals(fContext.getName())) { |
| defaultEnabled= InstanceScope.INSTANCE.getNode(JavaUI.ID_PLUGIN).getBoolean(key, false); |
| } else { |
| defaultEnabled= DefaultScope.INSTANCE.getNode(JavaUI.ID_PLUGIN).getBoolean(key, false); |
| } |
| fContext.getNode(JavaUI.ID_PLUGIN).putBoolean(key, defaultEnabled); |
| fEnableField.setSelection(defaultEnabled); |
| |
| enabled(defaultEnabled); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void performOk() {} |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void enableProjectSettings() { |
| fContext.getNode(JavaUI.ID_PLUGIN).putBoolean(getPreferenceKey(), fEnableField.isSelected()); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public void disableProjectSettings() { |
| fContext.getNode(JavaUI.ID_PLUGIN).remove(getPreferenceKey()); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean hasSettingsInScope(IScopeContext context) { |
| return context.getNode(JavaUI.ID_PLUGIN).get(getPreferenceKey(), null) != null; |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| public boolean isEnabled(IScopeContext context) { |
| IEclipsePreferences node; |
| if (hasSettingsInScope(context)) { |
| node= context.getNode(JavaUI.ID_PLUGIN); |
| } else { |
| node= InstanceScope.INSTANCE.getNode(JavaUI.ID_PLUGIN); |
| } |
| IEclipsePreferences defaultNode= DefaultScope.INSTANCE.getNode(JavaUI.ID_PLUGIN); |
| |
| String key= getPreferenceKey(); |
| return node.getBoolean(key, defaultNode.getBoolean(key, false)); |
| } |
| |
| /** |
| * @param enabled true if this save action has been enabled by user, false otherwise |
| */ |
| protected void enabled(boolean enabled) { |
| } |
| |
| private String getPreferenceKey() { |
| return EDITOR_SAVE_PARTICIPANT_PREFIX + getPostSaveListenerId(); |
| } |
| } |