Package org.eclipse.ui.editors.text

Class EditorsUI

  • public final class EditorsUI
extends java.lang.Object
    The central class for access to this plug-in. This class cannot be instantiated; all functionality is provided by static methods.
    Since:
    3.0
    Restriction:
    This class is not intended to be instantiated by clients.

    • Field Detail

      • PLUGIN_ID

        public static final java.lang.String PLUGIN_ID
        TextEditor Plug-in ID (value "org.eclipse.ui.editors").
        See Also:
        Constant Field Values

      • DEFAULT_TEXT_EDITOR_ID

        public static final java.lang.String DEFAULT_TEXT_EDITOR_ID
        The ID of the default text editor.
        See Also:
        Constant Field Values

      • CHARSET_MAPPING_FAILED

        public static final int CHARSET_MAPPING_FAILED
        Editor UI plug-in status code indicating that an operation failed because a character could not be mapped using the given charset.

        Value: 1

        Since:
        3.2
        See Also:
        UnmappableCharacterException, Constant Field Values

    • Method Detail

      • getAnnotationTypeLookup

        public static AnnotationTypeLookup getAnnotationTypeLookup()
        Returns the annotation type lookup of this plug-in.
        Returns:
        the annotation type lookup

      • getAnnotationPreferenceLookup

        public static AnnotationPreferenceLookup getAnnotationPreferenceLookup()
        Returns the annotation preference lookup of this plug-in.
        Returns:
        the annotation preference lookup

      • getPreferenceStore

        public static IPreferenceStore getPreferenceStore()
        Returns the preference store of this plug-in.
        Returns:
        this plug-in's preference store

      • useAnnotationsPreferencePage

        public static void useAnnotationsPreferencePage​(IPreferenceStore store)
        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 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.

        Parameters:
        store - the preference store to mark

      • useQuickDiffPreferencePage

        public static void useQuickDiffPreferencePage​(IPreferenceStore 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 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.

        Parameters:
        store - the preference store to mark

      • getSpellingService

        public static SpellingService getSpellingService()
        Returns the spelling service.
        Returns:
        the spelling service
        Since:
        3.1

      • getSharedTextColors

        public static ISharedTextColors getSharedTextColors()
        Returns the shared text colors of this plug-in.
        Returns:
        the shared text colors
        Since:
        3.3

      • getHyperlinkDetectorRegistry

        public static HyperlinkDetectorRegistry getHyperlinkDetectorRegistry()
        Returns the registry that contains the hyperlink detectors contributed by the org.eclipse.ui.workbench.texteditor.hyperlinkDetectors extension point.
        Returns:
        the hyperlink detector registry
        Since:
        3.3

      • getTooltipAffordanceString

        public static final java.lang.String getTooltipAffordanceString()
        Returns the tool tip affordance string.
        Returns:
        the affordance string which is empty if the preference is enabled but the key binding not active or null if the preference is disabled or the binding service is unavailable
        Since:
        3.3