Eclipse Platform Release 3.7

## Uses of Interface
org.eclipse.ui.IEditorInput

Packages that use IEditorInput
org.eclipse.compare: Provides support for performing structural and textual compare operations on arbitrary data and displaying the results.
org.eclipse.compare.contentmergeviewer: Support for compare and merge viewers which show the content side-by-side.
org.eclipse.compare.structuremergeviewer: Provides support for finding and displaying the differences between hierarchically structured data.
org.eclipse.debug.ui: Provides a generic debugger user interface that clients may customize via standard workbench extension points.
org.eclipse.debug.ui.sourcelookup: Provides a user interface for debug platform source lookup facilities.
org.eclipse.search.ui: Classes and interface required to contribute search dialog pages and search result view pages.
org.eclipse.team.ui: Provides basic support for managing Team providers.
org.eclipse.team.ui.history: Application programming interfaces for working with history.
org.eclipse.team.ui.synchronize: Contains the team synchronization presentation framework and support for the Synchronize View.
org.eclipse.ui: Application programming interfaces for interaction with and extension of the Eclipse Platform User Interface.
org.eclipse.ui.editors.text: Provides a standard text editor and concrete document providers based `IFileBuffer` and others directly handling `IFile` and `IStorage` as editor input.
org.eclipse.ui.forms.editor: Support for forms-based multi-page editors.
org.eclipse.ui.handlers: Provides support for integrating handlers into the Eclipse workbench.
org.eclipse.ui.ide: APIs for the IDE-specific portion of the Eclipse Platform User Interface.
org.eclipse.ui.navigator: Provides the Common Navigator framework.
org.eclipse.ui.part: Classes for the creation of workbench parts that integrate with the Eclipse Platform User Interface.
org.eclipse.ui.texteditor: Provides a framework for text editors obeying to the desktop rules.

Uses of IEditorInput in org.eclipse.compare

Classes in org.eclipse.compare that implement IEditorInput
`class` `CompareEditorInput` A compare operation which can present its results in a special editor.

Methods in org.eclipse.compare that return IEditorInput
`IEditorInput` `ISharedDocumentAdapter.getDocumentKey(Object element)` Return the object that is to be used as the key for retrieving the appropriate `IDocumentProvider` from the `DocumentProviderRegistry` and for obtaining the shared `IDocument` from the document provider.
`IEditorInput` `SharedDocumentAdapter.getDocumentKey(Object element)` Default implementation of `SharedDocumentAdapter.getDocumentKey(Object)` that returns a `FileEditorInput` for the element if the element adapts to `IFile`.

Methods in org.eclipse.compare with parameters of type IEditorInput
`void` `ISharedDocumentAdapter.connect(IDocumentProvider provider, IEditorInput documentKey)` Connect the given element to its document provider.
`void` `SharedDocumentAdapter.connect(IDocumentProvider provider, IEditorInput documentKey)`
`void` `ISharedDocumentAdapter.disconnect(IDocumentProvider provider, IEditorInput documentKey)` Disconnect the element from the document provider.
`void` `SharedDocumentAdapter.disconnect(IDocumentProvider provider, IEditorInput documentKey)`
`void` `ISharedDocumentAdapter.flushDocument(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite)` Flush the contents of the given document into the typed element that provided the document.
`static IDocumentProvider` `SharedDocumentAdapter.getDocumentProvider(IEditorInput input)` Return the document provider for the given editor input.
`protected void` `SharedDocumentAdapter.saveDocument(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite, IProgressMonitor monitor)` A helper method to save a document.

Uses of IEditorInput in org.eclipse.compare.contentmergeviewer

Methods in org.eclipse.compare.contentmergeviewer that return IEditorInput
`protected IEditorInput` `TextMergeViewer.getEditorInput(ISourceViewer sourceViewer)` Returns an editor input for the given source viewer.

Uses of IEditorInput in org.eclipse.compare.structuremergeviewer

Methods in org.eclipse.compare.structuremergeviewer that return IEditorInput
`IEditorInput` `SharedDocumentAdapterWrapper.getDocumentKey(Object element)`

Methods in org.eclipse.compare.structuremergeviewer with parameters of type IEditorInput
`void` `SharedDocumentAdapterWrapper.connect(IDocumentProvider provider, IEditorInput documentKey)`
`void` `SharedDocumentAdapterWrapper.disconnect(IDocumentProvider provider, IEditorInput documentKey)`
`void` `SharedDocumentAdapterWrapper.flushDocument(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite)`

Uses of IEditorInput in org.eclipse.debug.ui

Methods in org.eclipse.debug.ui that return IEditorInput
`IEditorInput` `ISourcePresentation.getEditorInput(Object element)` Returns an editor input that should be used to display the given object in an editor or `null` if unable to provide an editor input for the given object.

Methods in org.eclipse.debug.ui with parameters of type IEditorInput
`String` `ISourcePresentation.getEditorId(IEditorInput input, Object element)` Returns the id of the editor to use to display the given editor input and object, or `null` if unable to provide an editor id.

Uses of IEditorInput in org.eclipse.debug.ui.sourcelookup

Classes in org.eclipse.debug.ui.sourcelookup that implement IEditorInput
`class` `CommonSourceNotFoundEditorInput` Editor input for the `CommonSourceNotFoundEditor`.

Methods in org.eclipse.debug.ui.sourcelookup that return IEditorInput
`IEditorInput` `ISourceLookupResult.getEditorInput()` Returns the editor input used to display result, or `null` if unknown.

Methods in org.eclipse.debug.ui.sourcelookup with parameters of type IEditorInput
`void` `CommonSourceNotFoundEditor.init(IEditorSite site, IEditorInput input)`
`void` `CommonSourceNotFoundEditor.setInput(IEditorInput input)`

Uses of IEditorInput in org.eclipse.search.ui

Methods in org.eclipse.search.ui that return IEditorInput
`IEditorInput` `ISearchPageContainer.getActiveEditorInput()` Returns the editor input of the active editor.

Uses of IEditorInput in org.eclipse.team.ui

Classes in org.eclipse.team.ui that implement IEditorInput
`class` `PageCompareEditorInput` Abstract class for hosting a page based structure input view for the purposes of feeding compare viewers.

Uses of IEditorInput in org.eclipse.team.ui.history

Classes in org.eclipse.team.ui.history that implement IEditorInput
`class` `HistoryPageCompareEditorInput` Displays a history page combined with the compare/merge infrastructure.

Uses of IEditorInput in org.eclipse.team.ui.synchronize

Classes in org.eclipse.team.ui.synchronize that implement IEditorInput
`class` `ParticipantPageCompareEditorInput` Displays a synchronize participant page combined with the compare/merge infrastructure.
`class` `SaveableCompareEditorInput` A compare editor input that makes use of a `Saveable` to manage the save lifecycle of the editor input.
`class` `SyncInfoCompareInput` A `SyncInfo` editor input used as input to a two-way or three-way compare viewer.

Uses of IEditorInput in org.eclipse.ui

Subinterfaces of IEditorInput in org.eclipse.ui
`interface` `IFileEditorInput` This interface defines a file-oriented input to an editor.
`interface` `IInPlaceEditorInput` This interface defines an editor input for in-place editors.
`interface` `IPathEditorInput` This interface defines an editor input based on the local file system path of a file.
`interface` `IStorageEditorInput` Interface for a `IStorage` input to an editor.
`interface` `IURIEditorInput` This interface defines an editor input based on a URI.

Methods in org.eclipse.ui that return IEditorInput
`IEditorInput` `IEditorPart.getEditorInput()` Returns the input for this editor.
`IEditorInput` `IEditorReference.getEditorInput()` Returns the editor input for the editor referenced by this object.

Methods in org.eclipse.ui with parameters of type IEditorInput
`IEditorPart` `IWorkbenchPage.findEditor(IEditorInput input)` Returns the editor with the specified input.
`IEditorReference[]` `IWorkbenchPage.findEditors(IEditorInput input, String editorId, int matchFlags)` Returns an array of editor references that match the given input and/or editor id, as specified by the given match flags.
`void` `IEditorPart.init(IEditorSite site, IEditorInput input)` Initializes this editor with the given editor site and input.
`boolean` `IEditorMatchingStrategy.matches(IEditorReference editorRef, IEditorInput input)` Returns whether the editor represented by the given editor reference matches the given editor input.
`IEditorPart` `IWorkbenchPage.openEditor(IEditorInput input, String editorId)` Opens an editor on the given input.
`IEditorPart` `IWorkbenchPage.openEditor(IEditorInput input, String editorId, boolean activate)` Opens an editor on the given input.
`IEditorPart` `IWorkbenchPage.openEditor(IEditorInput input, String editorId, boolean activate, int matchFlags)` Opens an editor on the given input.
`IEditorReference[]` `IWorkbenchPage.openEditors(IEditorInput[] inputs, String[] editorIDs, int matchFlags)` Opens editors for the given inputs.
`void` `IWorkbenchPage.reuseEditor(IReusableEditor editor, IEditorInput input)` Reuses the specified editor by setting its new input.
`void` `IReusableEditor.setInput(IEditorInput input)` Sets the input to this editor.
`void` `IShowEditorInput.showEditorInput(IEditorInput editorInput)` Shows the given input if it represents a different subset of the editor's content than the one currently being shown.

Uses of IEditorInput in org.eclipse.ui.editors.text

Methods in org.eclipse.ui.editors.text with parameters of type IEditorInput
`protected void` `TextEditor.doSetInput(IEditorInput input)`
`protected boolean` `StorageDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput)` Deprecated. use the encoding based version instead
`protected boolean` `FileDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput)` Deprecated. use file encoding based version
`protected boolean` `StorageDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput, String encoding)` Initializes the given document from the given editor input using the given character encoding.
`protected boolean` `FileDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput, String encoding)`

Uses of IEditorInput in org.eclipse.ui.forms.editor

Methods in org.eclipse.ui.forms.editor with parameters of type IEditorInput
`int` `FormEditor.addPage(IEditorPart editor, IEditorInput input)` Adds a complete editor part to the multi-page editor.
`void` `FormEditor.addPage(int index, IEditorPart editor, IEditorInput input)` Adds a complete editor part to the multi-page editor at the specified position.
`void` `FormPage.init(IEditorSite site, IEditorInput input)` Initializes the form page.
`void` `FormEditor.init(IEditorSite site, IEditorInput input)` Overrides super to plug in a different selection provider.

Uses of IEditorInput in org.eclipse.ui.handlers

Methods in org.eclipse.ui.handlers that return IEditorInput
`static IEditorInput` `HandlerUtil.getActiveEditorInput(ExecutionEvent event)` Return the input of the active editor.
`static IEditorInput` `HandlerUtil.getActiveEditorInputChecked(ExecutionEvent event)` Return the input of the active editor.

Uses of IEditorInput in org.eclipse.ui.ide

Classes in org.eclipse.ui.ide that implement IEditorInput
`class` `FileStoreEditorInput` Implements an IEditorInput instance appropriate for `IFileStore` elements that represent files that are not part of the current workspace.

Methods in org.eclipse.ui.ide with parameters of type IEditorInput
`static IFile` `ResourceUtil.getFile(IEditorInput editorInput)` Returns the file corresponding to the given editor input, or `null` if there is no applicable file.
`static IResource` `ResourceUtil.getResource(IEditorInput editorInput)` Returns the resource corresponding to the given editor input, or `null` if there is no applicable resource.
`static IEditorPart` `IDE.openEditor(IWorkbenchPage page, IEditorInput input, String editorId)` Opens an editor on the given object.
`static IEditorPart` `IDE.openEditor(IWorkbenchPage page, IEditorInput input, String editorId, boolean activate)` Opens an editor on the given object.

Uses of IEditorInput in org.eclipse.ui.navigator

Methods in org.eclipse.ui.navigator with parameters of type IEditorInput
`IStructuredSelection` `ILinkHelper.findSelection(IEditorInput anInput)` Determine the correct structured selection for the Common Navigator given anInput.
`ILinkHelper[]` `LinkHelperService.getLinkHelpersFor(IEditorInput input)`
`IStructuredSelection` `LinkHelperService.getSelectionFor(IEditorInput input)` Return a selection that contains the elements that the given editor input represent.

Uses of IEditorInput in org.eclipse.ui.part

Classes in org.eclipse.ui.part that implement IEditorInput
`class` `FileEditorInput` Adapter for making a file resource a suitable input for an editor.
`class` `FileInPlaceEditorInput` Adapter for making a file resource a suitable input for an in-place editor.
`class` `MultiEditorInput` Implements an input for a `AbstractMultiEditor`.

Fields in org.eclipse.ui.part declared as IEditorInput
`IEditorInput` `EditorInputTransfer.EditorInputData.input`

Methods in org.eclipse.ui.part that return IEditorInput
`IEditorInput` `EditorPart.getEditorInput()`
`IEditorInput[]` `MultiEditorInput.getInput()` Returns an array with the input of all inner editors.

Methods in org.eclipse.ui.part with parameters of type IEditorInput
`int` `MultiPageEditorPart.addPage(IEditorPart editor, IEditorInput input)` Creates and adds a new page containing the given editor to this multi-page editor.
`void` `MultiPageEditorPart.addPage(int index, IEditorPart editor, IEditorInput input)` Creates and adds a new page containing the given editor to this multi-page editor.
`static EditorInputTransfer.EditorInputData` `EditorInputTransfer.createEditorInputData(String editorId, IEditorInput input)`
`IEditorPart[]` `MultiPageEditorPart.findEditors(IEditorInput input)` Find the editors contained in this multi-page editor whose editor input match the provided input.
`void` `AbstractMultiEditor.init(IEditorSite site, IEditorInput input)`
`abstract void` `EditorPart.init(IEditorSite site, IEditorInput input)`
`void` `MultiPageEditorPart.init(IEditorSite site, IEditorInput input)` The `MultiPageEditorPart` implementation of this `IEditorPart` method sets its site to the given site, its input to the given input, and the site's selection provider to a `MultiPageSelectionProvider`.
`protected void` `EditorPart.setInput(IEditorInput input)` Sets the input to this editor.
`protected void` `EditorPart.setInputWithNotify(IEditorInput input)` Sets the input to this editor and fires a PROP_INPUT property change if the input has changed.

Constructors in org.eclipse.ui.part with parameters of type IEditorInput
`MultiEditorInput(String[] editorIDs, IEditorInput[] innerEditors)` Constructs a new MultiEditorInput.

Uses of IEditorInput in org.eclipse.ui.texteditor

Methods in org.eclipse.ui.texteditor with parameters of type IEditorInput
`protected boolean` `AbstractTextEditor.canHandleMove(IEditorInput originalElement, IEditorInput movedElement)` Returns whether this editor can handle the move of the original element so that it ends up being the moved element.
`protected void` `StatusTextEditor.doSetInput(IEditorInput input)`
`protected void` `AbstractTextEditor.doSetInput(IEditorInput input)` Called directly from `setInput` and from within a workspace runnable from `init`, this method does the actual setting of the editor input.
`protected void` `AbstractDecoratedTextEditor.doSetInput(IEditorInput input)`
`IDocumentProvider` `DocumentProviderRegistry.getDocumentProvider(IEditorInput editorInput)` Returns the shared document for the type of the given editor input.
`void` `AbstractTextEditor.init(IEditorSite site, IEditorInput input)`
`protected void` `AbstractTextEditor.internalInit(IWorkbenchWindow window, IEditorSite site, IEditorInput input)` Implements the `init` method of `IEditorPart`.
`protected void` `AbstractTextEditor.safelySanityCheckState(IEditorInput input)` Checks the state of the given editor input if sanity checking is enabled.
`protected void` `StatusTextEditor.sanityCheckState(IEditorInput input)`
`protected void` `AbstractTextEditor.sanityCheckState(IEditorInput input)` Checks the state of the given editor input.
`protected void` `AbstractTextEditor.setDocumentProvider(IEditorInput input)` Hook method for setting the document provider for the given input.
`protected void` `AbstractDecoratedTextEditor.setDocumentProvider(IEditorInput input)`
`void` `AbstractTextEditor.setInput(IEditorInput input)`
`protected void` `AbstractTextEditor.setInputWithNotify(IEditorInput input)`
`void` `StatusTextEditor.updatePartControl(IEditorInput input)` Checks if the status of the given input is OK.
`protected void` `AbstractTextEditor.updateState(IEditorInput input)` Updates the state of the given editor input such as read-only flag.
`protected void` `AbstractTextEditor.validateState(IEditorInput input)` Validates the state of the given editor input.

Eclipse Platform Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.