Eclipse Platform
Release 3.1

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.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.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.ide APIs for the IDE-specific portion of the Eclipse Platform User Interface.  
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.
 

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
 

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.
 

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

Classes in org.eclipse.team.ui.synchronize that implement IEditorInput
 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.
 

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

Methods in org.eclipse.ui with parameters of type IEditorInput
 IEditorPart IWorkbenchPage.findEditor(IEditorInput input)
          Returns the editor with the specified input.
 void IWorkbenchPage.reuseEditor(IReusableEditor editor, IEditorInput input)
          Reuses the specified editor by setting its new 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.
 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.
 void IReusableEditor.setInput(IEditorInput input)
          Sets the input to this editor.
 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.
 

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 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)
          Deprecated. use file encoding based version
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
 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.
 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.
 

Uses of IEditorInput in org.eclipse.ui.ide
 

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.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 MultiEditor.
 

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

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

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.
 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.
 void MultiEditor.init(IEditorSite site, IEditorInput input)
           
abstract  void EditorPart.init(IEditorSite site, IEditorInput input)
           
protected  void EditorPart.setInput(IEditorInput input)
          Sets the input to this editor.
static EditorInputTransfer.EditorInputData EditorInputTransfer.createEditorInputData(String editorId, IEditorInput input)
           
 

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
 void StatusTextEditor.updatePartControl(IEditorInput input)
          Checks if the status of the given input is OK.
protected  void StatusTextEditor.doSetInput(IEditorInput input)
           
protected  void StatusTextEditor.sanityCheckState(IEditorInput input)
           
protected  void AbstractTextEditor.internalInit(IWorkbenchWindow window, IEditorSite site, IEditorInput input)
          Implements the init method of IEditorPart.
 void AbstractTextEditor.init(IEditorSite site, IEditorInput input)
           
protected  void AbstractTextEditor.setDocumentProvider(IEditorInput input)
          Hook method for setting the document provider for the given 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.
 void AbstractTextEditor.setInput(IEditorInput input)
           
protected  void AbstractTextEditor.safelySanityCheckState(IEditorInput input)
          Checks the state of the given editor input if sanity checking is enabled.
protected  void AbstractTextEditor.sanityCheckState(IEditorInput input)
          Checks the state of the given editor input.
protected  void AbstractTextEditor.validateState(IEditorInput input)
          Validates the state of the given editor input.
protected  void AbstractTextEditor.updateState(IEditorInput input)
          Updates the state of the given editor input such as read-only flag.
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.
 IDocumentProvider DocumentProviderRegistry.getDocumentProvider(IEditorInput editorInput)
          Returns the shared document for the type of the given editor input.
protected  void AbstractDecoratedTextEditor.setDocumentProvider(IEditorInput input)
           
protected  void AbstractDecoratedTextEditor.doSetInput(IEditorInput input)
           
 


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.