KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > IViewReference


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.ui;
13
14 /**
15  * Defines a reference to an IViewPart.
16  * <p>
17  * This interface is not intended to be implemented by clients.
18  * </p>
19  */
20 public interface IViewReference extends IWorkbenchPartReference {
21
22     /**
23      * Returns the secondary ID for the view.
24      *
25      * @return the secondary ID, or <code>null</code> if there is no secondary id
26      * @see IWorkbenchPage#showView(String, String, int)
27      * @since 3.0
28      */
29     public String JavaDoc getSecondaryId();
30
31     /**
32      * Returns the <code>IViewPart</code> referenced by this object.
33      * Returns <code>null</code> if the view was not instantiated or
34      * it failed to be restored. Tries to restore the view
35      * if <code>restore</code> is true.
36      */
37     public IViewPart getView(boolean restore);
38
39     /**
40      * Returns true if the view is a fast view otherwise returns false.
41      */
42     public boolean isFastView();
43 }
44
Popular Tags