|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.part.MultiEditorInput
public class MultiEditorInput
Implements an input for a AbstractMultiEditor.
This class is intended to be instantiated by clients but is
not intended to be subclassed.
| Constructor Summary | |
|---|---|
MultiEditorInput(String[] editorIDs,
IEditorInput[] innerEditors)
Constructs a new MultiEditorInput. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object obj)
|
boolean |
exists()
Returns whether the editor input exists. |
Object |
getAdapter(Class 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()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MultiEditorInput(String[] editorIDs,
IEditorInput[] innerEditors)
| Method Detail |
|---|
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 IEditorInputtrue if the editor input exists;
false otherwisepublic ImageDescriptor getImageDescriptor()
IEditorInputNote: 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 IEditorInputnull if
there is no image.public String getName()
IEditorInputFor instance, when the input is from a file, the return value would ordinarily be just the file name.
getName in interface IEditorInputnull;public IPersistableElement getPersistable()
IEditorInput
getPersistable in interface IEditorInputnull if this editor
input cannot be persistedpublic String getToolTipText()
IEditorInput
getToolTipText in interface IEditorInputnull.public Object getAdapter(Class adapter)
IAdaptablenull if
no such object can be found.
getAdapter in interface IAdaptableadapter - the adapter class to look up
null if this object does not
have an adapter for the given classpublic boolean equals(Object obj)
equals in class Objectpublic int hashCode()
hashCode in class Object
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.