Package org.eclipse.ui.editors.text
Class EditorsUI
java.lang.Object
org.eclipse.ui.editors.text.EditorsUI
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final intEditor UI plug-in status code indicating that an operation failed because a character could not be mapped using the given charset.static final StringThe ID of the default text editor.static final intEditor UI plug-in status code indicating that a resource is marked derived.static final StringTextEditor Plug-in ID (value"org.eclipse.ui.editors").static final intEditor UI plug-in status code indicating that state validation failed. -
Method Summary
Modifier and TypeMethodDescriptionstatic AnnotationPreferenceLookupReturns the annotation preference lookup of this plug-in.static AnnotationTypeLookupReturns the annotation type lookup of this plug-in.static HyperlinkDetectorRegistryReturns the registry that contains the hyperlink detectors contributed by theorg.eclipse.ui.workbench.texteditor.hyperlinkDetectorsextension point.static PreferencesDeprecated.static IPreferenceStoreReturns the preference store of this plug-in.static ISharedTextColorsReturns the shared text colors of this plug-in.static SpellingServiceReturns the spelling service.static final StringReturns the tool tip affordance string.static voidRemoves 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.static voidRemoves 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.
-
Field Details
-
PLUGIN_ID
TextEditor Plug-in ID (value"org.eclipse.ui.editors").- See Also:
-
DEFAULT_TEXT_EDITOR_ID
The ID of the default text editor.- See Also:
-
CHARSET_MAPPING_FAILED
public static final int CHARSET_MAPPING_FAILEDEditor 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:
-
STATE_VALIDATION_FAILED
public static final int STATE_VALIDATION_FAILEDEditor UI plug-in status code indicating that state validation failed.Value: 4
- Since:
- 3.3
- See Also:
-
DERIVED_FILE
public static final int DERIVED_FILEEditor UI plug-in status code indicating that a resource is marked derived.Value: 5
- Since:
- 3.3
- See Also:
-
-
Method Details
-
getAnnotationTypeLookup
Returns the annotation type lookup of this plug-in.- Returns:
- the annotation type lookup
-
getAnnotationPreferenceLookup
Returns the annotation preference lookup of this plug-in.- Returns:
- the annotation preference lookup
-
getPreferenceStore
Returns the preference store of this plug-in.- Returns:
- this plug-in's preference store
-
useAnnotationsPreferencePage
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
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
-
getPluginPreferences
Deprecated.As of 3.5, replaced bygetPreferenceStore()Returns the preferences of this plug-in.- Returns:
- the plug-in preferences
- See Also:
-
getSpellingService
Returns the spelling service.- Returns:
- the spelling service
- Since:
- 3.1
-
getHyperlinkDetectorRegistry
Returns the registry that contains the hyperlink detectors contributed by theorg.eclipse.ui.workbench.texteditor.hyperlinkDetectorsextension point.- Returns:
- the hyperlink detector registry
- Since:
- 3.3
-
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
nullif the preference is disabled or the binding service is unavailable - Since:
- 3.3
-
getPreferenceStore()