org.eclipse.ui.IFileEditorInput Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui;
import org.eclipse.core.resources.IFile;
/**
* This interface defines a file-oriented input to an editor.
*
* Clients implementing this editor input interface should override
* Object.equals(Object) to answer true for two inputs
* that are the same. The IWorkbenchPage.openEditor APIs
* are dependent on this to find an editor with the same input.
*
* File-oriented editors should support this as a valid input type, and allow
* full read-write editing of its content.
*
* A default implementation of this interface is provided by
* org.eclipse.ui.part.FileEditorInput.
*
* All editor inputs must implement the IAdaptable interface;
* extensions are managed by the platform's adapter manager.
*
*
* @see org.eclipse.core.resources.IFile
*/
public interface IFileEditorInput extends IStorageEditorInput {
/**
* Returns the file resource underlying this editor input.
*
* The IFile returned can be a handle to a resource
* that does not exist in the workspace. As such, an editor should
* provide appropriate feedback to the user instead of simply failing
* during input validation. For example, a text editor could open
* in read-only mode with a message in the text area to inform the
* user that the file does not exist.
*
*
* @return the underlying file
*/
public IFile getFile();
}