org.eclipse.ui.IPersistableEditor 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) 2006, 2009 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;

/**
 * An editor can implement this interface and participate in the workbench
 * session save/restore cycle using IMemento, similar to how
 * IViewPart currently works.
 * 
 * Refer to IWorkbenchPart for the part lifecycle.
 * 
 * 
 * If a memento is available, restoreState(*) will be inserted into the editor
 * startup.
 * 

 * editor.init(site, input)
 * editor.restoreState(memento)
 * editor.createPartControl(parent)
 * ...
 * 
 * 
 * 
 * On workbench shutdown, the editor state will be persisted when the editor
 * references are saved.
 * 
 *
 * @since 3.3
 */
public interface IPersistableEditor extends IPersistable {
	/**
	 * Called with a memento for this editor. The editor can parse the data or
	 * save the memento. This method may not be called.
	 *
	 * @param memento
	 *            the saved state for this editor. May be null.
	 */
	public void restoreState(IMemento memento);
}