Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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 a input for a MultiEditor. This class is intended to be instanciated by clients but is not intented to be subclassed.

Constructor Summary
`MultiEditorInput(String[] editorIDs, IEditorInput[] innerEditors)` Constructor for MultiEditorInput.

Method Summary
`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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### MultiEditorInput

    public MultiEditorInput(String[] editorIDs,
                            IEditorInput[] innerEditors)

  Constructor for MultiEditorInput.

Method Detail

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

  Specified by:
    `getImageDescriptor` in interface `IEditorInput`
  Returns:
    the image descriptor for this input

### 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

### 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

### 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

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