KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > views > IStickyViewDescriptor


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 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 package org.eclipse.ui.views;
12
13 /**
14  * Supplemental view interface that describes various sticky characteristics
15  * that a view may possess.
16  * <p>
17  * This interface is not intended to be implemented by clients.
18  * </p>
19  *
20  * @see org.eclipse.ui.views.IViewRegistry
21  * @see org.eclipse.ui.views.IViewDescriptor
22  * @since 3.1
23  */
24 public interface IStickyViewDescriptor {
25     /**
26      * Return the id of the view to be made sticky.
27      *
28      * @return the id of the view to be made sticky
29      */
30     public String JavaDoc getId();
31
32     /**
33      * Return the location of this sticky view. Must be one of
34      * <code>IPageLayout.LEFT</code>, <code>IPageLayout.RIGHT</code>,
35      * <code>IPageLayout.TOP</code>, or <code>IPageLayout.BOTTOM</code>.
36      *
37      * @return the location constant
38      */
39     public int getLocation();
40
41     /**
42      * Return whether this view should be closeable.
43      *
44      * @return whether this view should be closeeable
45      */
46     public boolean isCloseable();
47
48     /**
49      * Return whether this view should be moveable.
50      *
51      * @return whether this view should be moveable
52      */
53     public boolean isMoveable();
54 }
55
Popular Tags