org.eclipse.gmf.runtime.common.ui/src/org/eclipse/gmf/runtime/common/ui/util/IInlineTextEditorPart.java

/******************************************************************************
 * Copyright (c) 2002, 2003 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.gmf.runtime.common.ui.util;

import org.eclipse.jface.viewers.StructuredViewer;

/**
 * This interface is used to describe a workbench part that supports inline
 * editing.
 * 
 * @author ldamus
 */
public interface IInlineTextEditorPart {

	/**
	 * Start inline editing.
	 */
	public void startInlineEdit();

	/**
	 * sets the selection to the passed object and starts rename
	 * 
	 * @param object
	 *            the object to set selection on and rename
	 */
	void startInlineEdit(Object object);

	/**
	 * sets the selection to the passed object and starts the
	 * runnable to rename
	 * 
	 * @param object
	 *            the object to set selection on and rename
	 * @param editingRunnable a Runnable to invoke after setting selection on object
	 * in order to start renaming
	 */
	void startInlineEdit(Object object, Runnable editingRunnable);

	/**
	 * Gets the viewer for this part, in case the <code>RenameResourceAction</code> is to be used for
	 * inline editing.
	 * 
	 * @return the viewer, or <code>null</code> if there is none
	 */
	public StructuredViewer getViewer();

}