KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > IPathEditorInput


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