org.eclipse.ui.part
Class MultiEditorInput
java.lang.Object
org.eclipse.ui.part.MultiEditorInput
-
All Implemented Interfaces:
-
IAdaptable,
IEditorInput
-
public class MultiEditorInput
- extends
Object
- implements
IEditorInput
Implements an input for a AbstractMultiEditor.
This class is intended to be instantiated by clients but is
not intended to be subclassed.
-
Restriction:
- This class is not intended to be subclassed by clients.
MultiEditorInput
public MultiEditorInput(
String[] editorIDs,
IEditorInput[] innerEditors)
- Constructs a new MultiEditorInput.
getInput
public
IEditorInput[] getInput()
- Returns an array with the input of all inner editors.
-
-
getEditors
public
String[] getEditors()
- Retunrs an array with the id of all inner editors.
-
-
exists
public boolean exists()
-
Description copied from interface:
IEditorInput
- Returns whether the editor input exists.
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.
-
-
Specified by:
-
exists
in interface
IEditorInput
-
-
Returns:
-
true if the editor input exists;
false otherwise
getImageDescriptor
public
ImageDescriptor getImageDescriptor()
-
Description copied from interface:
IEditorInput
- Returns the image descriptor for this input.
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()).
-
-
Specified by:
-
getImageDescriptor
in interface
IEditorInput
-
-
Returns:
- the image descriptor for this input; may be
null if
there is no image.
getName
public
String getName()
-
Description copied from interface:
IEditorInput
- Returns the name of this editor input for display purposes.
For instance, when the input is from a file, the return value would
ordinarily be just the file name.
-
-
Specified by:
-
getName
in interface
IEditorInput
-
-
Returns:
- the name string; never
null;
getPersistable
public
IPersistableElement getPersistable()
-
Description copied from interface:
IEditorInput
- Returns an object that can be used to save the state of this editor
input.
-
-
Specified by:
-
getPersistable
in interface
IEditorInput
-
-
Returns:
- the persistable element, or
null if this editor
input cannot be persisted
getToolTipText
public
String getToolTipText()
-
Description copied from interface:
IEditorInput
- Returns the tool tip text for this editor input. This text is used to
differentiate between two input with the same name. For instance,
MyClass.java in folder X and MyClass.java in folder Y. The format of the
text varies between input types.
-
-
Specified by:
-
getToolTipText
in interface
IEditorInput
-
-
Returns:
- the tool tip text; never
null.
getAdapter
public
Object getAdapter(
Class adapter)
-
Description copied from interface:
IAdaptable
- Returns an object which is an instance of the given class
associated with this object. Returns
null if
no such object can be found.
-
-
Specified by:
-
getAdapter
in interface
IAdaptable
-
-
Parameters:
-
adapter - the adapter class to look up
-
Returns:
- a object castable to the given class,
or
null if this object does not
have an adapter for the given class
equals
public boolean equals(
Object obj)
-
-
Overrides:
-
equals
in class
Object
-
hashCode
public int hashCode()
-
-
Overrides:
-
hashCode
in class
Object
-
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
