Package org.eclipse.ui
Interface IEditorDescriptor
- All Superinterfaces:
IWorkbenchPartDescriptor
Description of an editor in the workbench editor registry. The editor
descriptor contains the information needed to create editor instances.
An editor descriptor typically represents one of three types of editors:
- a file editor extension for a specific file extension.
- a file editor added by the user (via the workbench preference page)
- a general editor extension which works on objects other than files.
This interface is not intended to be implemented or extended by clients.
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
-
Method Summary
Modifier and TypeMethodDescriptionReturns the editor matching strategy object for editors represented by this editor descriptor, ornull
if there is no explicit matching strategy specified.getId()
Returns the editor id.Returns the descriptor of the image for this editor.getLabel()
Returns the label to show for this editor.boolean
Returns whether this editor descriptor will open a regular editor part inside the editor area.boolean
Returns whether this editor descriptor will open an external editor in a new window outside the workbench.boolean
Returns whether this editor descriptor will open an external editor in-place inside the editor area.
-
Method Details
-
getId
String getId()Returns the editor id.For internal editors, this is the extension id as defined in the workbench registry; for external editors, it is path and file name of the external program.
- Specified by:
getId
in interfaceIWorkbenchPartDescriptor
- Returns:
- the id of the editor
-
getImageDescriptor
ImageDescriptor getImageDescriptor()Returns the descriptor of the image for this editor.- Specified by:
getImageDescriptor
in interfaceIWorkbenchPartDescriptor
- Returns:
- the descriptor of the image to display next to this editor
-
getLabel
String getLabel()Returns the label to show for this editor.- Specified by:
getLabel
in interfaceIWorkbenchPartDescriptor
- Returns:
- the editor label
-
isInternal
boolean isInternal()Returns whether this editor descriptor will open a regular editor part inside the editor area.- Returns:
true
if editor is inside editor area, andfalse
otherwise- Since:
- 3.0
-
isOpenInPlace
boolean isOpenInPlace()Returns whether this editor descriptor will open an external editor in-place inside the editor area.- Returns:
true
if editor is in-place, andfalse
otherwise- Since:
- 3.0
-
isOpenExternal
boolean isOpenExternal()Returns whether this editor descriptor will open an external editor in a new window outside the workbench.- Returns:
true
if editor is external, andfalse
otherwise- Since:
- 3.0
-
getEditorMatchingStrategy
IEditorMatchingStrategy getEditorMatchingStrategy()Returns the editor matching strategy object for editors represented by this editor descriptor, ornull
if there is no explicit matching strategy specified.- Returns:
- the editor matching strategy, or
null
if none - Since:
- 3.1
-