CodegenPreferencePage.java

/*******************************************************************************
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 *
 * This file is part of REDHAWK IDE.
 *
 * 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
 *******************************************************************************/
package gov.redhawk.ide.codegen.ui.preferences;

import gov.redhawk.ide.codegen.ui.RedhawkCodegenUiActivator;

import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

/**
 * This class represents a preference page that
 * is contributed to the Preferences dialog. By 
 * subclassing <samp>FieldEditorPreferencePage</samp>, we
 * can use the field support built into JFace that allows
 * us to create a page that is small and knows how to 
 * save, restore and apply itself.
 * <p>
 * This page is used to modify preferences only. They
 * are stored in the preference store that belongs to
 * the main plug-in class. That way, preferences can
 * be accessed directly via the preference store.
 */

public class CodegenPreferencePage
	extends FieldEditorPreferencePage
	implements IWorkbenchPreferencePage {

	public CodegenPreferencePage() {
		super(GRID);
		setPreferenceStore(RedhawkCodegenUiActivator.getDefault().getPreferenceStore());
	}
	
	/**
	 * Creates the field editors. Field editors are abstractions of
	 * the common GUI blocks needed to manipulate various types
	 * of preferences. Each field editor knows how to save and
	 * restore itself.
	 */
	@Override
	public void createFieldEditors() {
		addField(
			new BooleanFieldEditor(
				CodegenPreferenceConstants.P_ALWAYS_GENERATE_DEFAULTS,
				"&Always Generate Default Files",
				getFieldEditorParent()));
// XXX Disable deprecated code generator option
//		addField(
//			new BooleanFieldEditor(
//				CodegenPreferenceConstants.P_ENABLE_DEPRECATED_CODE_GENERATORS,
//				"&Enable Deprecated Code Generators",
//				getFieldEditorParent()));
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
	 */
	@Override
	public void init(IWorkbench workbench) {
	}
	
}