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