|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.ide.IDE
Collection of IDE-specific APIs factored out of existing workbench. This class cannot be instantiated; all functionality is provided by static methods and fields.
Nested Class Summary | |
---|---|
static interface |
IDE.Preferences
Preferences defined by the IDE workbench. |
static interface |
IDE.SharedImages
Standard shared images defined by the IDE. |
Field Summary | |
---|---|
static String |
EDITOR_ID_ATTR
An optional attribute within a workspace marker ( IMarker ) which
identifies the preferred editor type to be opened. |
static QualifiedName |
EDITOR_KEY
The persistent property key used on IFile resources to contain the preferred editor ID to use. |
static String |
RESOURCE_PERSPECTIVE_ID
The resource based perspective identifier. |
Method Summary | |
---|---|
static List |
computeSelectedResources(IStructuredSelection originalSelection)
Extracts and returns the IResource s in the given
selection or the resource objects they adapts to. |
static IContentType |
getContentType(IFile file)
Return the content type for the given file. |
static IEditorDescriptor |
getDefaultEditor(IFile file)
Returns the default editor for a given file. |
static IEditorDescriptor |
getDefaultEditor(IFile file,
boolean determineContentType)
Returns the default editor for a given file. |
static IEditorDescriptor |
getEditorDescriptor(IFile file)
Returns an editor descriptor appropriate for opening the given file resource. |
static IEditorDescriptor |
getEditorDescriptor(IFile file,
boolean determineContentType)
Returns an editor descriptor appropriate for opening the given file resource. |
static IEditorDescriptor |
getEditorDescriptor(String name)
Returns an editor descriptor appropriate for opening a file resource with the given name. |
static IEditorDescriptor |
getEditorDescriptor(String name,
boolean inferContentType)
Returns an editor descriptor appropriate for opening a file resource with the given name. |
static IMarkerHelpRegistry |
getMarkerHelpRegistry()
Returns the marker help registry for the workbench. |
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. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IEditorInput input,
String editorId)
Opens an editor on the given object. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IEditorInput input,
String editorId,
boolean activate)
Opens an editor on the given object. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IFile input)
Opens an editor on the given file resource. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IFile input,
boolean activate)
Opens an editor on the given file resource. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IFile input,
boolean activate,
boolean determineContentType)
Opens an editor on the given file resource. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IFile input,
String editorId)
Opens an editor on the given file resource. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IFile input,
String editorId,
boolean activate)
Opens an editor on the given file resource. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IMarker marker)
Opens an editor on the file resource of the given marker. |
static IEditorPart |
openEditor(IWorkbenchPage page,
IMarker marker,
boolean activate)
Opens an editor on the file resource of the given marker. |
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.
|
static void |
setDefaultEditor(IFile file,
String editorID)
Sets the default editor id for a given file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final QualifiedName EDITOR_KEY
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
}
public static final String EDITOR_ID_ATTR
IMarker
) which
identifies the preferred editor type to be opened.
public static final String RESOURCE_PERSPECTIVE_ID
Method Detail |
public static IMarkerHelpRegistry getMarkerHelpRegistry()
public static void gotoMarker(IEditorPart editor, IMarker marker)
IGotoMarker
interface (either directly
or via IAdaptable.getAdapter
), this has no effect.
editor
- the editormarker
- the markerpublic static IEditorPart openEditor(IWorkbenchPage page, IEditorInput input, String editorId) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputeditorId
- the id of the editor extension to use
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(IEditorInput, String)
public static IEditorPart openEditor(IWorkbenchPage page, IEditorInput input, String editorId, boolean activate) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputeditorId
- the id of the editor extension to useactivate
- if true
the editor will be activated
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(IEditorInput, String, boolean)
public static IEditorPart openEditor(IWorkbenchPage page, IFile input, boolean activate) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputactivate
- if true
the editor will be activated
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(org.eclipse.ui.IEditorInput,
String, boolean)
public static IEditorPart openEditor(IWorkbenchPage page, IFile input, boolean activate, boolean determineContentType) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputactivate
- if true
the editor will be activateddetermineContentType
- attempt to resolve the content type for this file
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(org.eclipse.ui.IEditorInput,
String, boolean)
public static IEditorPart openEditor(IWorkbenchPage page, IFile input) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor input
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(IEditorInput, String)
public static IEditorPart openEditor(IWorkbenchPage page, IFile input, String editorId) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputeditorId
- the id of the editor extension to use
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(IEditorInput, String)
public static IEditorPart openEditor(IWorkbenchPage page, IFile input, String editorId, boolean activate) throws PartInitException
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.
page
- the page in which the editor will be openedinput
- the editor inputeditorId
- the id of the editor extension to useactivate
- if true
the editor will be activated
null
if an external editor was
opened
PartInitException
- if the editor could not be initializedIWorkbenchPage.openEditor(IEditorInput, String, boolean)
public static IEditorDescriptor getEditorDescriptor(IFile file) throws PartInitException
The editor descriptor is determined using a multistep process. This method will attempt to resolve the editor based on content-type bindings as well as traditional name/extension bindings.
IDE.EDITOR_KEY
containing the preferred editor id to be
used.IEditorRegistry.getDefaultEditor(String)
.
file
- the file
PartInitException
- if no editor can be foundpublic static IEditorDescriptor getEditorDescriptor(IFile file, boolean determineContentType) throws PartInitException
The editor descriptor is determined using a multistep process. This
method will attempt to resolve the editor based on content-type bindings
as well as traditional name/extension bindings if
determineContentType
is true
.
IDE.EDITOR_KEY
containing the preferred editor id to be
used.IEditorRegistry.getDefaultEditor(String)
.
file
- the filedetermineContentType
- query the content type system for the content type of the file
PartInitException
- if no editor can be foundpublic static IEditorDescriptor getEditorDescriptor(String name) throws PartInitException
The editor descriptor is determined using a multistep process. This method will attempt to infer content type from the file name.
IDE.EDITOR_KEY
containing the preferred editor id to be
used.IEditorRegistry.getDefaultEditor(String)
.
name
- the file name
PartInitException
- if no editor can be foundpublic static IEditorDescriptor getEditorDescriptor(String name, boolean inferContentType) throws PartInitException
The editor descriptor is determined using a multistep process. This
method will attempt to infer the content type of the file if
inferContentType
is true
.
IDE.EDITOR_KEY
containing the preferred editor id to be
used.IEditorRegistry.getDefaultEditor(String)
.
name
- the file nameinferContentType
- attempt to infer the content type from the file name if this
is true
PartInitException
- if no editor can be foundpublic static IEditorPart openEditor(IWorkbenchPage page, IMarker marker) throws PartInitException
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.
page
- the workbench page to open the editor inmarker
- the marker to open
null
not possible
PartInitException
- if the editor could not be initializedopenEditor(org.eclipse.ui.IWorkbenchPage,
org.eclipse.core.resources.IMarker, boolean)
public static IEditorPart openEditor(IWorkbenchPage page, IMarker marker, boolean activate) throws PartInitException
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.
page
- the workbench page to open the editor inmarker
- the marker to openactivate
- if true
the editor will be activated
null
not possible
PartInitException
- if the editor could not be initializedpublic static boolean saveAllEditors(IResource[] resourceRoots, boolean confirm)
IResource
's provided.
Opens a dialog to prompt the user if confirm
is true.
Return true if successful. Return false if the user has cancelled
the command.
resourceRoots
- the resource roots under which editor input should be saved,
other will be left dirtyconfirm
- prompt the user if true
public static void setDefaultEditor(IFile file, String editorID)
getDefaultEditor(IFile)
.
file
- the fileeditorID
- the editor idpublic static IEditorDescriptor getDefaultEditor(IFile file)
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.
file
- the file
null
if
not foundpublic static IEditorDescriptor getDefaultEditor(IFile file, boolean determineContentType)
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.
file
- the filedetermineContentType
- determine the content type for the given file
null
if
not foundpublic static List computeSelectedResources(IStructuredSelection originalSelection)
IResource
s in the given
selection or the resource objects they adapts to.
originalSelection
- the original selection, possibly empty
IResource
),
possibly emptypublic static IContentType getContentType(IFile file)
file
- the file to test
null
if it cannot be determined.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.