org.eclipse.ui.ide

Interface IEditorAssociationOverride

public interface IEditorAssociationOverride

Allows to override editor associations for the IDE.

This interface is implemented by org.eclipse.ui.ide.editorAssociationOverride extensions.

Clients may implement this interface.

Since:

3.8

Method Summary

Modifier and Type	Method and Description
IEditorDescriptor	overrideDefaultEditor(IEditorInput editorInput, IContentType contentType, IEditorDescriptor editorDescriptor) Allows to override the given editor descriptor for the given editor input with a different one.
IEditorDescriptor	overrideDefaultEditor(String fileName, IContentType contentType, IEditorDescriptor editorDescriptor) Allows to override the given editor descriptor for the given input with a different one.
IEditorDescriptor[]	overrideEditors(IEditorInput editorInput, IContentType contentType, IEditorDescriptor[] editorDescriptors) Allows to override the given editor descriptors for the given editor input with different ones.
IEditorDescriptor[]	overrideEditors(String fileName, IContentType contentType, IEditorDescriptor[] editorDescriptors) Allows to override the given editor descriptors for the given file name with different ones.

Method Detail

overrideEditors

IEditorDescriptor[] overrideEditors(IEditorInput editorInput,
                                    IContentType contentType,
                                    IEditorDescriptor[] editorDescriptors)

Allows to override the given editor descriptors for the given editor input with different ones.

Parameters:

editorInput - the editor input for the editor

contentType - the content type of the input or null if not available

editorDescriptors - the current association for the given input

Returns:

the editor descriptors to be used for the given input - can be editorDescriptors. The order is not relevant.

overrideEditors

IEditorDescriptor[] overrideEditors(String fileName,
                                    IContentType contentType,
                                    IEditorDescriptor[] editorDescriptors)

Allows to override the given editor descriptors for the given file name with different ones.

Parameters:

fileName - the name of the file for which to choose the editor

contentType - the content type of the input or null if not available

editorDescriptors - the current association for the given input

Returns:

the editor descriptors to be used for the given input - can be editorDescriptors. The order is not relevant.

overrideDefaultEditor

IEditorDescriptor overrideDefaultEditor(IEditorInput editorInput,
                                        IContentType contentType,
                                        IEditorDescriptor editorDescriptor)

Allows to override the given editor descriptor for the given editor input with a different one. Normally, this is used to override the default editor for the given input.

Though possible, it is advised not to override an editor that has been explicitly chosen by the user for the given input. This is the case when IFile#getPersistentProperty(IDE.EDITOR_KEY) != null.

Parameters:

editorInput - the editor input for the editor

contentType - the content type of the input or null if not available

editorDescriptor - the current association for the given input or null if none

Returns:

the editor descriptor to be used for the given input or null if none. Can be editorDescriptor.

overrideDefaultEditor

IEditorDescriptor overrideDefaultEditor(String fileName,
                                        IContentType contentType,
                                        IEditorDescriptor editorDescriptor)

Allows to override the given editor descriptor for the given input with a different one. Normally, this is used to override the default editor for the given input.

Parameters:

fileName - the name of the file for which to choose the editor

contentType - the content type of the input or null if not available

editorDescriptor - the current association for the given input or null if none

Returns:

the editor descriptor to be used for the given input or null if none. Can be editorDescriptor.