01: /*******************************************************************************
02: * Copyright (c) 2003, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui;
11:
12: import org.eclipse.core.runtime.IPath;
13:
14: /**
15: * This interface defines an editor input based on the local file system path
16: * of a file.
17: * <p>
18: * Clients implementing this editor input interface should override
19: * <code>Object.equals(Object)</code> to answer true for two inputs
20: * that are the same. The <code>IWorkbenchPage.openEditor</code> APIs
21: * are dependent on this to find an editor with the same input.
22: * </p><p>
23: * Path-oriented editors should support this as a valid input type, and
24: * can allow full read-write editing of its content.
25: * </p><p>
26: * All editor inputs must implement the <code>IAdaptable</code> interface;
27: * extensions are managed by the platform's adapter manager.
28: * </p>
29: *
30: * @see org.eclipse.core.runtime.IPath
31: * @since 3.0
32: */
33: public interface IPathEditorInput extends IEditorInput {
34: /**
35: * Returns the local file system path of the file underlying this editor input.
36: *
37: * @return a local file system path
38: */
39: public IPath getPath();
40: }
|