plugins/org.eclipse.dltk.python.activestatedebugger/src/org/eclipse/dltk/python/activestatedebugger/preferences/PythonActiveStateDebuggerPreferencePage.java

/*******************************************************************************
 * Copyright (c) 2005, 2016 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
 ******************************************************************************/

package org.eclipse.dltk.python.activestatedebugger.preferences;

import org.eclipse.core.resources.IProject;
import org.eclipse.dltk.debug.ui.preferences.ExternalDebuggingEngineOptionsBlock;
import org.eclipse.dltk.python.activestatedebugger.PythonActiveStateDebuggerConstants;
import org.eclipse.dltk.python.activestatedebugger.PythonActiveStateDebuggerPlugin;
import org.eclipse.dltk.python.core.PythonNature;
import org.eclipse.dltk.ui.preferences.AbstractConfigurationBlockPropertyAndPreferencePage;
import org.eclipse.dltk.ui.preferences.AbstractOptionsBlock;
import org.eclipse.dltk.ui.preferences.PreferenceKey;
import org.eclipse.dltk.ui.util.IStatusChangeListener;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.preferences.IWorkbenchPreferenceContainer;

/**
 * Python ActiveState debugging engine preference page
 */
public class PythonActiveStateDebuggerPreferencePage extends
		AbstractConfigurationBlockPropertyAndPreferencePage {

	static PreferenceKey ENGINE_PATH = new PreferenceKey(
			PythonActiveStateDebuggerPlugin.PLUGIN_ID,
			PythonActiveStateDebuggerConstants.DEBUGGING_ENGINE_PATH_KEY);

	static PreferenceKey ENABLE_LOGGING = new PreferenceKey(
			PythonActiveStateDebuggerPlugin.PLUGIN_ID,
			PythonActiveStateDebuggerConstants.ENABLE_LOGGING);

	static PreferenceKey LOG_FILE_PATH = new PreferenceKey(
			PythonActiveStateDebuggerPlugin.PLUGIN_ID,
			PythonActiveStateDebuggerConstants.LOG_FILE_PATH);

	static PreferenceKey LOG_FILE_NAME = new PreferenceKey(
			PythonActiveStateDebuggerPlugin.PLUGIN_ID,
			PythonActiveStateDebuggerConstants.LOG_FILE_NAME);

	private static String PREFERENCE_PAGE_ID = "org.eclipse.dltk.python.preferences.debug.engines.activestatedebugger";
	private static String PROPERTY_PAGE_ID = "org.eclipse.dltk.python.propertyPage.debug.engines.activestatedebugger";

	@Override
	protected AbstractOptionsBlock createOptionsBlock(
			IStatusChangeListener newStatusChangedListener, IProject project,
			IWorkbenchPreferenceContainer container) {

		return new ExternalDebuggingEngineOptionsBlock(
				newStatusChangedListener, project,
				new PreferenceKey[] { ENGINE_PATH,ENABLE_LOGGING, LOG_FILE_PATH,
						LOG_FILE_NAME }, container) {

			@Override
			protected void createOtherBlock(Composite parent) {
				addDownloadLink(parent,
						PreferenceMessages.DebuggingEngineDownloadPage,
						PreferenceMessages.DebuggingEngineDownloadPageLink);
			}

			@Override
			protected void createLoggingBlock(Composite composite) {
				/*
				 * remove once the python active state debug runner supports
				 * setting up the log file
				 */
			}

			@Override
			protected PreferenceKey getDebuggingEnginePathKey() {
				return ENGINE_PATH;
			}

			@Override
			protected PreferenceKey getEnableLoggingPreferenceKey() {
				return ENABLE_LOGGING;
			}

			@Override
			protected PreferenceKey getLogFileNamePreferenceKey() {
				return LOG_FILE_NAME;
			}

			@Override
			protected PreferenceKey getLogFilePathPreferenceKey() {
				return LOG_FILE_PATH;
			}
		};
	}

	@Override
	protected String getHelpId() {
		return null;
	}

	@Override
	protected String getNatureId() {
		return PythonNature.NATURE_ID;
	}

	@Override
	protected String getPreferencePageId() {
		return PREFERENCE_PAGE_ID;
	}

	@Override
	protected String getProjectHelpId() {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	protected String getPropertyPageId() {
		return PROPERTY_PAGE_ID;
	}

	@Override
	protected void setDescription() {
		setDescription(PreferenceMessages.DebuggingEngineDescription);
	}

	@Override
	protected void setPreferenceStore() {
		setPreferenceStore(PythonActiveStateDebuggerPlugin.getDefault()
				.getPreferenceStore());
	}
}