org.eclipse.ui.IPathEditorInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * Copyright (c) 2003, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui;

import org.eclipse.core.runtime.IPath;

/**
 * This interface defines an editor input based on the local file system path
 * of a file.
 * 
 * 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.
 * 

 * Path-oriented editors should support this as a valid input type, and
 * can allow full read-write editing of its content.
 * 

 * All editor inputs must implement the IAdaptable interface;
 * extensions are managed by the platform's adapter manager.
 * 
 *
 * @see org.eclipse.core.runtime.IPath
 * @since 3.0
 */
public interface IPathEditorInput extends IEditorInput {
    /**
     * Returns the local file system path of the file underlying this editor input.
     *
     * @return a local file system path
     */
    public IPath getPath();
}