KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
14  * This interface defines an editor input for in-place editors.
15  * <p>
16  * Clients implementing this editor input interface should override
17  * <code>Object.equals(Object)</code> to answer true for two inputs
18  * that are the same. The <code>IWorkbenchPage.openEditor</code> APIs
19  * are dependent on this to find an editor with the same input.
20  * </p><p>
21  * Path-oriented editors should support this as a valid input type, and
22  * can allow full read-write editing of its content.
23  * </p><p>
24  * All editor inputs must implement the <code>IAdaptable</code> interface;
25  * extensions are managed by the platform's adapter manager.
26  * </p>
27  *
28  * @see org.eclipse.ui.IInPlaceEditor
29  * @since 3.0
30  */
31 public interface IInPlaceEditorInput extends IPathEditorInput {
32     /**
33      * Sets the in-place editor this input is associated with.
34      *
35      * @param editor the in-place editor associated with this input
36      * or <code>null</code> to disassociate.
37      */
38     public void setInPlaceEditor(IInPlaceEditor editor);
39 }
40
Popular Tags