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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation

This is org.eclipse.ui.workbench jar used by Scout SDK

There is a newer version: 3.108.0.v20160602-1232

Show newest version

/*******************************************************************************
 * Copyright (c) 2003, 2006 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;

/**
 * This interface defines an editor input for in-place editors.
 * 
 * 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.ui.IInPlaceEditor
 * @since 3.0
 */
public interface IInPlaceEditorInput extends IPathEditorInput {
    /**
     * Sets the in-place editor this input is associated with.
     *
     * @param editor the in-place editor associated with this input
     * 		or null to disassociate.
     */
    public void setInPlaceEditor(IInPlaceEditor editor);
}