| /******************************************************************************* |
| * Copyright (c) 2000, 2011 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.jdt.internal.ui.preferences; |
| |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| |
| import org.eclipse.jface.dialogs.Dialog; |
| import org.eclipse.jface.preference.PreferencePage; |
| |
| import org.eclipse.ui.IWorkbench; |
| import org.eclipse.ui.IWorkbenchPreferencePage; |
| import org.eclipse.ui.PlatformUI; |
| |
| import org.eclipse.jdt.internal.ui.JavaPlugin; |
| |
| /** |
| * Abstract preference page which is used to wrap a |
| * {@link org.eclipse.jdt.internal.ui.preferences.IPreferenceConfigurationBlock}. |
| * |
| * @since 3.0 |
| */ |
| public abstract class AbstractConfigurationBlockPreferencePage extends PreferencePage implements IWorkbenchPreferencePage { |
| |
| |
| private IPreferenceConfigurationBlock fConfigurationBlock; |
| private OverlayPreferenceStore fOverlayStore; |
| |
| |
| /** |
| * Creates a new preference page. |
| */ |
| public AbstractConfigurationBlockPreferencePage() { |
| setDescription(); |
| setPreferenceStore(); |
| fOverlayStore= new OverlayPreferenceStore(getPreferenceStore(), new OverlayPreferenceStore.OverlayKey[] {}); |
| fConfigurationBlock= createConfigurationBlock(fOverlayStore); |
| } |
| |
| protected abstract IPreferenceConfigurationBlock createConfigurationBlock(OverlayPreferenceStore overlayPreferenceStore); |
| protected abstract String getHelpId(); |
| protected abstract void setDescription(); |
| protected abstract void setPreferenceStore(); |
| |
| /* |
| * @see IWorkbenchPreferencePage#init() |
| */ |
| @Override |
| public void init(IWorkbench workbench) { |
| } |
| |
| /* |
| * @see PreferencePage#createControl(Composite) |
| */ |
| @Override |
| public void createControl(Composite parent) { |
| super.createControl(parent); |
| PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), getHelpId()); |
| } |
| |
| /* |
| * @see PreferencePage#createContents(Composite) |
| */ |
| @Override |
| protected Control createContents(Composite parent) { |
| |
| fOverlayStore.load(); |
| fOverlayStore.start(); |
| |
| Control content= fConfigurationBlock.createControl(parent); |
| |
| initialize(); |
| |
| Dialog.applyDialogFont(content); |
| return content; |
| } |
| |
| private void initialize() { |
| fConfigurationBlock.initialize(); |
| } |
| |
| /* |
| * @see PreferencePage#performOk() |
| */ |
| @Override |
| public boolean performOk() { |
| |
| fConfigurationBlock.performOk(); |
| |
| fOverlayStore.propagate(); |
| |
| JavaPlugin.flushInstanceScope(); |
| |
| return true; |
| } |
| |
| /* |
| * @see PreferencePage#performDefaults() |
| */ |
| @Override |
| public void performDefaults() { |
| |
| fOverlayStore.loadDefaults(); |
| fConfigurationBlock.performDefaults(); |
| |
| super.performDefaults(); |
| } |
| |
| /* |
| * @see DialogPage#dispose() |
| */ |
| @Override |
| public void dispose() { |
| |
| fConfigurationBlock.dispose(); |
| |
| if (fOverlayStore != null) { |
| fOverlayStore.stop(); |
| fOverlayStore= null; |
| } |
| |
| super.dispose(); |
| } |
| } |