public class MultiEditorInput extends Object implements IEditorInput
AbstractMultiEditor
.
This class is intended to be instantiated by clients but is
not intended to be subclassed.Constructor and Description |
---|
MultiEditorInput(String[] editorIDs,
IEditorInput[] innerEditors)
Constructs a new MultiEditorInput.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
boolean |
exists()
Returns whether the editor input exists.
|
<T> T |
getAdapter(Class<T> adapter)
Returns an object which is an instance of the given class
associated with this object.
|
String[] |
getEditors()
Retunrs an array with the id of all inner editors.
|
ImageDescriptor |
getImageDescriptor()
Returns the image descriptor for this input.
|
IEditorInput[] |
getInput()
Returns an array with the input of all inner editors.
|
String |
getName()
Returns the name of this editor input for display purposes.
|
IPersistableElement |
getPersistable()
Returns an object that can be used to save the state of this editor
input.
|
String |
getToolTipText()
Returns the tool tip text for this editor input.
|
int |
hashCode() |
public MultiEditorInput(String[] editorIDs, IEditorInput[] innerEditors)
public IEditorInput[] getInput()
public String[] getEditors()
public boolean exists()
IEditorInput
This method is primarily used to determine if an editor input should
appear in the "File Most Recently Used" menu. An editor input will appear
in the list until the return value of exists
becomes
false
or it drops off the bottom of the list.
exists
in interface IEditorInput
true
if the editor input exists;
false
otherwisepublic ImageDescriptor getImageDescriptor()
IEditorInput
Note: although a null return value has never been permitted from this method, there are many known buggy implementations that return null. Clients that need the image for an editor are advised to use IWorkbenchPart.getImage() instead of IEditorInput.getImageDescriptor(), or to recover from a null return value in a manner that records the ID of the problematic editor input. Implementors that have been returning null from this method should pick some other default return value (such as ImageDescriptor.getMissingImageDescriptor()).
getImageDescriptor
in interface IEditorInput
null
if
there is no image.public String getName()
IEditorInput
For instance, when the input is from a file, the return value would ordinarily be just the file name.
getName
in interface IEditorInput
null
;public IPersistableElement getPersistable()
IEditorInput
getPersistable
in interface IEditorInput
null
if this editor
input cannot be persistedpublic String getToolTipText()
IEditorInput
getToolTipText
in interface IEditorInput
null
.public <T> T getAdapter(Class<T> adapter)
IAdaptable
null
if
no such object can be found.
Clients may implement this method but should generally call Adapters.adapt(Object, Class, boolean)
rather than invoking it directly.
getAdapter
in interface IAdaptable
adapter
- the adapter class to look upnull
if this object does not
have an adapter for the given class
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.