org.csstudio.opibuilder.preferences.CommonPreferencePage.java Source code

Introduction

Here is the source code for org.csstudio.opibuilder.preferences.CommonPreferencePage.java

Source

/*******************************************************************************
 * Copyright (c) 2010 Oak Ridge National Laboratory.
 * 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.csstudio.opibuilder.preferences;

import org.csstudio.opibuilder.OPIBuilderPlugin;
import org.eclipse.jface.preference.BooleanFieldEditor;
import org.eclipse.jface.preference.FieldEditorPreferencePage;
import org.eclipse.jface.preference.IntegerFieldEditor;
import org.eclipse.jface.preference.StringFieldEditor;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPreferencePage;

/**The preference page for OPIBuilder
 * @author Xihui Chen
 *
 */
public class CommonPreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {

    // private static final String RESTART_MESSAGE = "Changes only takes effect after restart.";

    public CommonPreferencePage() {
        super(FieldEditorPreferencePage.GRID);
        setPreferenceStore(OPIBuilderPlugin.getDefault().getPreferenceStore());
        setMessage("BOY Common Preferences");
    }

    @Override
    protected void createFieldEditors() {
        final Composite parent = getFieldEditorParent();

        WorkspaceFileFieldEditor colorEditor = new WorkspaceFileFieldEditor(PreferencesHelper.COLOR_FILE,
                "Color File: ", new String[] { "def" }, parent);//$NON-NLS-2$
        addField(colorEditor);

        WorkspaceFileFieldEditor fontEditor = new WorkspaceFileFieldEditor(PreferencesHelper.FONT_FILE,
                "Font File: ", new String[] { "def" }, parent);//$NON-NLS-2$
        addField(fontEditor);

        StringFieldEditor opiSearchPathEditor = new StringFieldEditor(PreferencesHelper.OPI_SEARCH_PATH,
                "OPI Search Path", parent);
        opiSearchPathEditor.getTextControl(parent).setToolTipText("The path to search OPI files.");
        addField(opiSearchPathEditor);

        StringFieldEditor topOPIsEditor = new StringFieldEditor(PreferencesHelper.TOP_OPIS, "Top OPIs", parent);
        topOPIsEditor.getTextControl(parent).setToolTipText("The OPIs appeared in top opi button on toolbar");
        addField(topOPIsEditor);

        WorkspaceFileFieldEditor probeOPIEditor = new WorkspaceFileFieldEditor(PreferencesHelper.PROBE_OPI,
                "Probe OPI: ", new String[] { "opi" }, parent);//$NON-NLS-2$
        probeOPIEditor.getTextControl(parent)
                .setToolTipText("The opi file to be invoked from CSS->OPI Probe context menu");
        addField(probeOPIEditor);

        BooleanFieldEditor noEditModeEditor = new BooleanFieldEditor(PreferencesHelper.NO_EDIT, "No-Editing mode",
                parent);
        addField(noEditModeEditor);

        BooleanFieldEditor showOpiRuntimeStacks = new BooleanFieldEditor(PreferencesHelper.SHOW_OPI_RUNTIME_STACKS,
                "Show OPI Runtime Stacks", parent);
        showOpiRuntimeStacks.getDescriptionControl(parent).setToolTipText(
                "Enable to add placeholders to new OPI Runtime perspective " + "as an aid to positioning displays");
        addField(showOpiRuntimeStacks);

        BooleanFieldEditor advanceGraphicsEditor = new BooleanFieldEditor(
                PreferencesHelper.DISABLE_ADVANCED_GRAPHICS, "Disable Advanced Graphics", parent);
        advanceGraphicsEditor.getDescriptionControl(parent)
                .setToolTipText("This will disable alpha, anti-alias and gradient effect. "
                        + "OPI need to be re-opened to make this take effect.");
        addField(advanceGraphicsEditor);

        BooleanFieldEditor displaySysOutEditor = new BooleanFieldEditor(PreferencesHelper.DISPLAY_SYSTEM_OUTPUT,
                "Display system output to BOY Console", parent);
        displaySysOutEditor.getDescriptionControl(parent)
                .setToolTipText("Enable this may result in undesired \ninformation displayed in BOY Console.");
        addField(displaySysOutEditor);

        BooleanFieldEditor default_type_editor = new BooleanFieldEditor(PreferencesHelper.DEFAULT_TO_CLASSIC_STYLE,
                "Default to 'classic' widget style", parent);
        default_type_editor.getDescriptionControl(parent)
                .setToolTipText("Should widgets with 'classic' as well as 'native' style default to 'classic'?");
        addField(default_type_editor);

        IntegerFieldEditor urlLoadFieldEditor = new IntegerFieldEditor(PreferencesHelper.URL_FILE_LOADING_TIMEOUT,
                "URL file loading timeout (ms)", parent);
        urlLoadFieldEditor.getTextControl(parent)
                .setToolTipText("The timeout in millisecond for loading file from a URL path.");
        addField(urlLoadFieldEditor);

    }

    @Override
    public void init(IWorkbench workbench) {

    }

    @Override
    public boolean performOk() {
        if (!isValid())
            return false;
        return super.performOk();
    }

}