01: /*******************************************************************************
02: * Copyright (c) 2000, 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: * Defines a reference to an IViewPart.
14: * <p>
15: * This interface is not intended to be implemented by clients.
16: * </p>
17: */
18: public interface IViewReference extends IWorkbenchPartReference {
19:
20: /**
21: * Returns the secondary ID for the view.
22: *
23: * @return the secondary ID, or <code>null</code> if there is no secondary id
24: * @see IWorkbenchPage#showView(String, String, int)
25: * @since 3.0
26: */
27: public String getSecondaryId();
28:
29: /**
30: * Returns the <code>IViewPart</code> referenced by this object.
31: * Returns <code>null</code> if the view was not instantiated or
32: * it failed to be restored. Tries to restore the view
33: * if <code>restore</code> is true.
34: */
35: public IViewPart getView(boolean restore);
36:
37: /**
38: * Returns true if the view is a fast view otherwise returns false.
39: */
40: public boolean isFastView();
41: }
|