| java.lang.Object
 org.eclipse.ui.ide.IDE
| IDE | | final public class IDE (Code) | | Collection of IDE-specific APIs factored out of existing workbench. This
class cannot be instantiated; all functionality is provided by static methods
and fields.
since:
3.0 |
| Inner Class :public interface SharedImages | |
| Inner Class :public interface Preferences | |
| Field Summary | |
| final public static String | EDITOR_ID_ATTR
An optional attribute within a workspace marker (IMarker)
which identifies the preferred editor type to be opened. | | final public static QualifiedName | EDITOR_KEY
The persistent property key used on IFile resources to contain the
preferred editor ID to use. | | final public static String | RESOURCE_PERSPECTIVE_ID
The resource based perspective identifier. |
| Method Summary | |
| public static List | computeSelectedResources(IStructuredSelection originalSelection)
Extracts and returns the IResources in the given
selection or the resource objects they adapts to. | | public static IContentType | getContentType(IFile file)
Return the content type for the given file. | | public static IEditorDescriptor | getDefaultEditor(IFile file)
Returns the default editor for a given file. | | public static IEditorDescriptor | getDefaultEditor(IFile file, boolean determineContentType)
Returns the default editor for a given file. | | public static IEditorDescriptor | getEditorDescriptor(IFile file)
Returns an editor descriptor appropriate for opening the given file
resource.
The editor descriptor is determined using a multi-step process. | | public static IEditorDescriptor | getEditorDescriptor(IFile file, boolean determineContentType)
Returns an editor descriptor appropriate for opening the given file
resource.
The editor descriptor is determined using a multi-step process. | | public static IEditorDescriptor | getEditorDescriptor(String name)
Returns an editor descriptor appropriate for opening a file resource with
the given name.
The editor descriptor is determined using a multi-step process. | | public static IEditorDescriptor | getEditorDescriptor(String name, boolean inferContentType)
Returns an editor descriptor appropriate for opening a file resource with
the given name.
The editor descriptor is determined using a multi-step process. | | public static IMarkerHelpRegistry | getMarkerHelpRegistry()
Returns the marker help registry for the workbench. | | public static void | gotoMarker(IEditorPart editor, IMarker marker)
Sets the cursor and selection state for the given editor to reveal the
position of the given marker. | | public static IContentType | guessContentType(IFile file)
Guess at the content type of the given file based on the filename. | | public static IEditorPart | openEditor(IWorkbenchPage page, IEditorInput input, String editorId)
Opens an editor on the given object. | | public static IEditorPart | openEditor(IWorkbenchPage page, URI uri, String editorId, boolean activate)
Opens an editor on the given IFileStore object. | | public static IEditorPart | openEditor(IWorkbenchPage page, IEditorInput input, String editorId, boolean activate)
Opens an editor on the given object.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. | | public static IEditorPart | openEditor(IWorkbenchPage page, IFile input, boolean activate)
Opens an editor on the given file resource. | | public static IEditorPart | openEditor(IWorkbenchPage page, IFile input, boolean activate, boolean determineContentType)
Opens an editor on the given file resource. | | public static IEditorPart | openEditor(IWorkbenchPage page, IFile input)
Opens an editor on the given file resource. | | public static IEditorPart | openEditor(IWorkbenchPage page, IFile input, String editorId)
Opens an editor on the given file resource. | | public static IEditorPart | openEditor(IWorkbenchPage page, IFile input, String editorId, boolean activate)
Opens an editor on the given file resource.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. | | public static IEditorPart | openEditor(IWorkbenchPage page, IMarker marker)
Opens an editor on the file resource of the given marker. | | public static IEditorPart | openEditor(IWorkbenchPage page, IMarker marker, boolean activate)
Opens an editor on the file resource of the given marker.
If this page already has an editor open on the marker resource file that
editor is brought to front; otherwise, a new editor is opened. | | public static IEditorPart | openEditorOnFileStore(IWorkbenchPage page, IFileStore fileStore)
Opens an editor on the given IFileStore object. | | public static boolean | promptToConfirm(Shell shell, String title, String message, IResourceDelta delta, String[] ignoreModelProviderIds, boolean syncExec)
Prompt the user to inform them of the possible side effects of an
operation on resources. | | public static boolean | saveAllEditors(IResource[] resourceRoots, boolean confirm)
Save all dirty editors in the workbench whose editor input is a child
resource of one of the IResource's provided. | | public static void | setDefaultEditor(IFile file, String editorID)
Sets the default editor id for a given file. |
| EDITOR_ID_ATTR | | final public static String EDITOR_ID_ATTR(Code) | | An optional attribute within a workspace marker (IMarker)
which identifies the preferred editor type to be opened.
|
| EDITOR_KEY | | final public static QualifiedName EDITOR_KEY(Code) | | The persistent property key used on IFile resources to contain the
preferred editor ID to use.
Example of retrieving the persisted editor id:
IFile file = ...
IEditorDescriptor editorDesc = null;
try {
String editorID = file.getPersistentProperty(EDITOR_KEY);
if (editorID != null) {
editorDesc = editorReg.findEditor(editorID);
}
} catch (CoreException e) {
// handle problem accessing persistent property here
}
Example of persisting the editor id:
IFile file = ...
try {
file.setPersistentProperty(EDITOR_KEY, editorDesc.getId());
} catch (CoreException e) {
// handle problem setting persistent property here
}
|
| RESOURCE_PERSPECTIVE_ID | | final public static String RESOURCE_PERSPECTIVE_ID(Code) | | The resource based perspective identifier.
|
| computeSelectedResources | | public static List computeSelectedResources(IStructuredSelection originalSelection)(Code) | | Extracts and returns the IResources in the given
selection or the resource objects they adapts to.
Parameters:
originalSelection - the original selection, possibly empty list of resources (element type: IResource),possibly empty |
| getContentType | | public static IContentType getContentType(IFile file)(Code) | | Return the content type for the given file.
Parameters:
file - the file to test the content type, or null if it cannot bedetermined.
since:
3.1 |
| getDefaultEditor | | public static IEditorDescriptor getDefaultEditor(IFile file)(Code) | | Returns the default editor for a given file. This method will attempt to
resolve the editor based on content-type bindings as well as traditional
name/extension bindings.
A default editor id may be registered for a specific file using
setDefaultEditor. If the given file has a registered
default editor id the default editor will derived from it. If not, the
default editor is determined by taking the file name for the file and
obtaining the default editor for that name.
Parameters:
file - the file the descriptor of the default editor, or null ifnot found |
| getDefaultEditor | | public static IEditorDescriptor getDefaultEditor(IFile file, boolean determineContentType)(Code) | | Returns the default editor for a given file. This method will attempt to
resolve the editor based on content-type bindings as well as traditional
name/extension bindings if determineContentType is
true.
A default editor id may be registered for a specific file using
setDefaultEditor. If the given file has a registered
default editor id the default editor will derived from it. If not, the
default editor is determined by taking the file name for the file and
obtaining the default editor for that name.
Parameters:
file - the file
Parameters:
determineContentType - determine the content type for the given file the descriptor of the default editor, or null ifnot found
since:
3.1 |
| getEditorDescriptor | | public static IEditorDescriptor getEditorDescriptor(IFile file) throws PartInitException(Code) | | Returns an editor descriptor appropriate for opening the given file
resource.
The editor descriptor is determined using a multi-step process. This
method will attempt to resolve the editor based on content-type bindings
as well as traditional name/extension bindings.
- The file is consulted for a persistent property named
IDE.EDITOR_KEY containing the preferred editor id to be
used.
- The workbench editor registry is consulted to determine if an editor
extension has been registered for the file type. If so, an instance of
the editor extension is opened on the file. See
IEditorRegistry.getDefaultEditor(String).
- The operating system is consulted to determine if an in-place
component editor is available (e.g. OLE editor on Win32 platforms).
- The operating system is consulted to determine if an external editor
is available.
Parameters:
file - the file an editor descriptor, appropriate for opening the file
throws:
PartInitException - if no editor can be found |
| getEditorDescriptor | | public static IEditorDescriptor getEditorDescriptor(IFile file, boolean determineContentType) throws PartInitException(Code) | | Returns an editor descriptor appropriate for opening the given file
resource.
The editor descriptor is determined using a multi-step process. This
method will attempt to resolve the editor based on content-type bindings
as well as traditional name/extension bindings if
determineContentTypeis true.
- The file is consulted for a persistent property named
IDE.EDITOR_KEY containing the preferred editor id to be
used.
- The workbench editor registry is consulted to determine if an editor
extension has been registered for the file type. If so, an instance of
the editor extension is opened on the file. See
IEditorRegistry.getDefaultEditor(String).
- The operating system is consulted to determine if an in-place
component editor is available (e.g. OLE editor on Win32 platforms).
- The operating system is consulted to determine if an external editor
is available.
Parameters:
file - the file
Parameters:
determineContentType - query the content type system for the content type of the file an editor descriptor, appropriate for opening the file
throws:
PartInitException - if no editor can be found
since:
3.1 |
| getEditorDescriptor | | public static IEditorDescriptor getEditorDescriptor(String name) throws PartInitException(Code) | | Returns an editor descriptor appropriate for opening a file resource with
the given name.
The editor descriptor is determined using a multi-step process. This
method will attempt to infer content type from the file name.
- The file is consulted for a persistent property named
IDE.EDITOR_KEY containing the preferred editor id to be
used.
- The workbench editor registry is consulted to determine if an editor
extension has been registered for the file type. If so, an instance of
the editor extension is opened on the file. See
IEditorRegistry.getDefaultEditor(String).
- The operating system is consulted to determine if an in-place
component editor is available (e.g. OLE editor on Win32 platforms).
- The operating system is consulted to determine if an external editor
is available.
Parameters:
name - the file name an editor descriptor, appropriate for opening the file
throws:
PartInitException - if no editor can be found
since:
3.1 |
| getEditorDescriptor | | public static IEditorDescriptor getEditorDescriptor(String name, boolean inferContentType) throws PartInitException(Code) | | Returns an editor descriptor appropriate for opening a file resource with
the given name.
The editor descriptor is determined using a multi-step process. This
method will attempt to infer the content type of the file if
inferContentType is true.
- The file is consulted for a persistent property named
IDE.EDITOR_KEY containing the preferred editor id to be
used.
- The workbench editor registry is consulted to determine if an editor
extension has been registered for the file type. If so, an instance of
the editor extension is opened on the file. See
IEditorRegistry.getDefaultEditor(String).
- The operating system is consulted to determine if an in-place
component editor is available (e.g. OLE editor on Win32 platforms).
- The operating system is consulted to determine if an external editor
is available.
Parameters:
name - the file name
Parameters:
inferContentType - attempt to infer the content type from the file name if thisis true an editor descriptor, appropriate for opening the file
throws:
PartInitException - if no editor can be found
since:
3.1 |
| getMarkerHelpRegistry | | public static IMarkerHelpRegistry getMarkerHelpRegistry()(Code) | | Returns the marker help registry for the workbench.
the marker help registry |
| gotoMarker | | public static void gotoMarker(IEditorPart editor, IMarker marker)(Code) | | Sets the cursor and selection state for the given editor to reveal the
position of the given marker. This is done on a best effort basis. If the
editor does not provide an IGotoMarker interface (either
directly or via IAdaptable.getAdapter), this has no
effect.
Parameters:
editor - the editor
Parameters:
marker - the marker |
| guessContentType | | public static IContentType guessContentType(IFile file)(Code) | | Guess at the content type of the given file based on the filename.
Parameters:
file - the file to test the content type, or null if it cannot bedetermined.
since:
3.2 |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IEditorInput input, String editorId) throws PartInitException(Code) | | Opens an editor on the given object.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
editorId - the id of the editor extension to use an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputString) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, URI uri, String editorId, boolean activate) throws PartInitException(Code) | | Opens an editor on the given IFileStore object.
Unlike the other openEditor methods, this one can be used
to open files that reside outside the workspace resource set.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened.
Parameters:
page - the page in which the editor will be opened
Parameters:
uri - the URI of the file store representing the file to open
Parameters:
editorId - the id of the editor extension to use
Parameters:
activate - if true the editor will be activated opened an open editor or null if an external editor was
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputString)
See Also: EFS.getStore(URI)
since:
3.3 |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IEditorInput input, String editorId, boolean activate) throws PartInitException(Code) | | Opens an editor on the given object.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. If
activate == true the editor will be activated.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
editorId - the id of the editor extension to use
Parameters:
activate - if true the editor will be activated an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputStringboolean) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IFile input, boolean activate) throws PartInitException(Code) | | Opens an editor on the given file resource. This method will attempt to
resolve the editor based on content-type bindings as well as traditional
name/extension bindings.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. If
activate == true the editor will be activated.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
activate - if true the editor will be activated an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(org.eclipse.ui.IEditorInputStringboolean) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IFile input, boolean activate, boolean determineContentType) throws PartInitException(Code) | | Opens an editor on the given file resource. This method will attempt to
resolve the editor based on content-type bindings as well as traditional
name/extension bindings if determineContentType is
true.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. If
activate == true the editor will be activated.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
activate - if true the editor will be activated
Parameters:
determineContentType - attempt to resolve the content type for this file an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(org.eclipse.ui.IEditorInputStringboolean)
since:
3.1 |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IFile input) throws PartInitException(Code) | | Opens an editor on the given file resource. This method will attempt to
resolve the editor based on content-type bindings as well as traditional
name/extension bindings.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputString) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IFile input, String editorId) throws PartInitException(Code) | | Opens an editor on the given file resource.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
editorId - the id of the editor extension to use an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputString) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IFile input, String editorId, boolean activate) throws PartInitException(Code) | | Opens an editor on the given file resource.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened. If
activate == true the editor will be activated.
Parameters:
page - the page in which the editor will be opened
Parameters:
input - the editor input
Parameters:
editorId - the id of the editor extension to use
Parameters:
activate - if true the editor will be activated an open editor or null if an external editor wasopened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputStringboolean) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IMarker marker) throws PartInitException(Code) | | Opens an editor on the file resource of the given marker.
If this page already has an editor open on the marker resource file that
editor is brought to front; otherwise, a new editor is opened.The cursor
and selection state of the editor are then updated from information
recorded in the marker.
If the marker contains an EDITOR_ID_ATTR attribute the
attribute value will be used to determine the editor type to be opened.
If not, the registered editor for the marker resource file will be used.
Parameters:
page - the workbench page to open the editor in
Parameters:
marker - the marker to open an open editor or null not possible
exception:
PartInitException - if the editor could not be initialized
See Also: IDE.openEditor(org.eclipse.ui.IWorkbenchPage,org.eclipse.core.resources.IMarker,boolean) |
| openEditor | | public static IEditorPart openEditor(IWorkbenchPage page, IMarker marker, boolean activate) throws PartInitException(Code) | | Opens an editor on the file resource of the given marker.
If this page already has an editor open on the marker resource file that
editor is brought to front; otherwise, a new editor is opened. If
activate == true the editor will be activated. The cursor
and selection state of the editor are then updated from information
recorded in the marker.
If the marker contains an EDITOR_ID_ATTR attribute the
attribute value will be used to determine the editor type to be opened.
If not, the registered editor for the marker resource file will be used.
Parameters:
page - the workbench page to open the editor in
Parameters:
marker - the marker to open
Parameters:
activate - if true the editor will be activated an open editor or null not possible
exception:
PartInitException - if the editor could not be initialized |
| openEditorOnFileStore | | public static IEditorPart openEditorOnFileStore(IWorkbenchPage page, IFileStore fileStore) throws PartInitException(Code) | | Opens an editor on the given IFileStore object.
Unlike the other openEditor methods, this one
can be used to open files that reside outside the workspace
resource set.
If the page already has an editor open on the target object then that
editor is brought to front; otherwise, a new editor is opened.
Parameters:
page - the page in which the editor will be opened
Parameters:
fileStore - the IFileStore representing the file to open an open editor or null if an external editor was opened
exception:
PartInitException - if the editor could not be initialized
See Also: org.eclipse.ui.IWorkbenchPage.openEditor(IEditorInputString)
since:
3.3 |
| promptToConfirm | | public static boolean promptToConfirm(Shell shell, String title, String message, IResourceDelta delta, String[] ignoreModelProviderIds, boolean syncExec)(Code) | | Prompt the user to inform them of the possible side effects of an
operation on resources. Do not prompt for side effects from ignored model
providers. A model provider can be ignored if it is the client calling
this API. Any message from the provided model provider id or any model
providers it extends will be ignored.
Parameters:
shell - the shell to parent the prompt dialog
Parameters:
title - the title of the dialog
Parameters:
message - the message for the dialog
Parameters:
delta - a delta built using anIResourceChangeDescriptionFactory
Parameters:
ignoreModelProviderIds - model providers to be ignored
Parameters:
syncExec - prompt in a sync exec (required when called from a non-UIthread) whether the user chose to continue
since:
3.2 |
| saveAllEditors | | public static boolean saveAllEditors(IResource[] resourceRoots, boolean confirm)(Code) | | Save all dirty editors in the workbench whose editor input is a child
resource of one of the IResource's provided. Opens a
dialog to prompt the user if confirm is true. Return true
if successful. Return false if the user has canceled the command.
since:
3.0
Parameters:
resourceRoots - the resource roots under which editor input shouldbe saved, other will be left dirty
Parameters:
confirm - true to ask the user before saving unsavedchanges (recommended), and false to saveunsaved changes without asking true if the command succeeded, andfalse if the operation was canceled by the user oran error occurred while saving |
| setDefaultEditor | | public static void setDefaultEditor(IFile file, String editorID)(Code) | | Sets the default editor id for a given file. This value will be used to
determine the default editor descriptor for the file in future calls to
getDefaultEditor(IFile).
Parameters:
file - the file
Parameters:
editorID - the editor id |
|
|