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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gef-gwt

The newest version!

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

/**
 * Defines a reference to an IViewPart.
 * 
 * This interface is not intended to be implemented by clients.
 * 
 * 
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IViewReference extends IWorkbenchPartReference {

	/**
	 * Returns the secondary ID for the view.
	 * 
	 * @return the secondary ID, or null if there is no secondary
	 *         id
	 * @see IWorkbenchPage#showView(String, String, int)
	 * @since 3.0
	 */
	public String getSecondaryId();

	/**
	 * Returns the IViewPart referenced by this object. Returns
	 * null if the view was not instantiated or it failed to be
	 * restored. Tries to restore the view if restore is true.
	 */
	public IViewPart getView(boolean restore);

	/**
	 * Returns true if the view is a fast view otherwise returns false.
	 */
	public boolean isFastView();
}