/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.editors.text;
import org.eclipse.core.runtime.Preferences;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.ui.internal.editors.text.EditorsPlugin;
import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
import org.eclipse.ui.texteditor.AnnotationPreferenceLookup;
import org.eclipse.ui.texteditor.AnnotationTypeLookup;
import org.eclipse.ui.texteditor.MarkerAnnotationPreferences;
/**
* The central class for access to this plug-in.
* This class cannot be instantiated; all functionality is provided by
* static methods.
*
* @since 3.0
*/
public final class EditorsUI {
/**
* TextEditor Plug-in ID (value "org.eclipse.ui.editors"
).
*/
public static final String PLUGIN_ID= "org.eclipse.ui.editors"; //$NON-NLS-1$
/**
* The ID of the default text editor.
*/
public static final String DEFAULT_TEXT_EDITOR_ID = "org.eclipse.ui.DefaultTextEditor"; //$NON-NLS-1$
/**
* Returns the annotation type lookup of this plug-in.
*
* @return the annotation type lookup
*/
public static AnnotationTypeLookup getAnnotationTypeLookup() {
return EditorsPlugin.getDefault().getAnnotationTypeLookup();
}
/**
* Returns the annotation preference lookup of this plug-in.
*
* @return the annotation preference lookup
*/
public static AnnotationPreferenceLookup getAnnotationPreferenceLookup() {
return EditorsPlugin.getDefault().getAnnotationPreferenceLookup();
}
/**
* Returns the preference store of this plug-in.
*
* @return this plug-in's preference store
*/
public static IPreferenceStore getPreferenceStore() {
return EditorsPlugin.getDefault().getPreferenceStore();
}
/**
* Removes all preference which are handled by this plug-in's
* general preference pages from the given store and prevents
* setting the default values in the future.
*
* To access the * general preference from another plug-in use a * {@link org.eclipse.ui.texteditor.ChainedPreferenceStore}: *
* List stores= new ArrayList(3); * stores.add(YourPlugin.getDefault().getPreferenceStore()); * stores.add(EditorsUI.getPreferenceStore()); * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); * ** *
* Note: In order to work this method must be called before * the store's default values are set. *
* * @param store the preference store to mark */ public static void useAnnotationsPreferencePage(IPreferenceStore store) { MarkerAnnotationPreferences.useAnnotationsPreferencePage(store); } /** * Removes all preference which are handled by this plug-in's * Quick Diff preference page from the given store and prevents * setting the default values in the future. ** To access the * general preference from another plug-in use a * {@link org.eclipse.ui.texteditor.ChainedPreferenceStore}: *
* List stores= new ArrayList(3); * stores.add(YourPlugin.getDefault().getPreferenceStore()); * stores.add(EditorsUI.getPreferenceStore()); * combinedStore= new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()])); * ** *
* Note: In order to work this method must be called before * the store's default values are set. *
* * @param store the preference store to mark */ public static void useQuickDiffPreferencePage(IPreferenceStore store) { MarkerAnnotationPreferences.useQuickDiffPreferencePage(store); store.setToDefault(AbstractDecoratedTextEditorPreferenceConstants.QUICK_DIFF_ALWAYS_ON); store.setToDefault(AbstractDecoratedTextEditorPreferenceConstants.QUICK_DIFF_CHARACTER_MODE); store.setToDefault(AbstractDecoratedTextEditorPreferenceConstants.QUICK_DIFF_DEFAULT_PROVIDER); } private EditorsUI() { // block instantiation } /** * Returns the preferences of this plug-in. * * @return the plug-in preferences * @see org.eclipse.core.runtime.Plugin#getPluginPreferences() */ public static Preferences getPluginPreferences() { return EditorsPlugin.getDefault().getPluginPreferences(); } }