core/org.eclipse.stem.util.loggers/src/org/eclipse/stem/util/loggers/preferences/LoggingPreferencePage.java

package org.eclipse.stem.util.loggers.preferences;

/*******************************************************************************
 * Copyright (c) 2009 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
 *******************************************************************************/

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 sub-classing <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 LoggingPreferencePage extends FieldEditorPreferencePage implements
		IWorkbenchPreferencePage {

	/**
	 * Default logging setting
	 */
	public static boolean DEFAULT_LOGGING_FLAG = false;
	
	/**
	 * The ID of the STEM Preference page.
	 */
	public static final String ID_LOGGING_PREFERENCE_PAGE = "org.eclipse.stem.ui.preferences.LoggingPreferencePage";

	/**
	 * Constructor
	 */
	public LoggingPreferencePage() {
		super(GRID);
		setPreferenceStore(org.eclipse.stem.util.loggers.Activator.getDefault().getPreferenceStore());
		setDescription(Messages.getString("LoggingPPage.Logging")); //$NON-NLS-1$
	} // STEMPreferencePage

	/**
	 * 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.
	 */
	public void createFieldEditors() {
		final BooleanFieldEditor integerFieldEditor = new BooleanFieldEditor(
				PreferenceConstants.LOG_INTEGER_PREFERENCE,
				Messages.getString("LPageInteger"), getFieldEditorParent()); //$NON-NLS-1$

		addField(integerFieldEditor);
	} // createFieldEditors

	/**
	 * @see org.eclipse.ui.IWorkbenchPreferencePage#init(org.eclipse.ui.IWorkbench)
	 */
	public void init(@SuppressWarnings("unused")//$NON-NLS-1$
			IWorkbench workbench) {
		// Nothing
	} // init

} // STEMPreferencePage