KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > registry > IStickyViewDescriptor


1 /*******************************************************************************
2  * Copyright (c) 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.internal.registry;
12
13
14 /**
15  * Describes a view that should be made "sticky".
16  *
17  * @since 3.0
18  */
19 public interface IStickyViewDescriptor {
20     public static final String JavaDoc STICKY_FOLDER_RIGHT = "stickyFolderRight"; //$NON-NLS-1$
21 public static final String JavaDoc STICKY_FOLDER_LEFT = "stickyFolderLeft"; //$NON-NLS-1$
22 public static final String JavaDoc STICKY_FOLDER_TOP = "stickyFolderTop"; //$NON-NLS-1$
23 public static final String JavaDoc STICKY_FOLDER_BOTTOM = "stickyFolderBottom"; //$NON-NLS-1$
24
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 namespace in which this descriptor was declared.
34      *
35      * @return the namespace in which this descriptor was declared
36      */
37     public String JavaDoc getNamespace();
38     
39     /**
40      * Return the location of this sticky view. Must be one of
41      * <code>IPageLayout.LEFT</code>, <code>IPageLayout.RIGHT</code>,
42      * <code>IPageLayout.TOP</code>, or <code>IPageLayout.BOTTOM</code>.
43      *
44      * @return the location
45      */
46     public int getLocation();
47     
48     /**
49      * Return whether this view should be closeable.
50      *
51      * @return whether this view should be closeeable
52      */
53     public boolean isCloseable();
54     
55     /**
56      * Return whether this view should be moveable.
57      *
58      * @return whether thsi view should be moveable
59      */
60     public boolean isMoveable();
61 }
62
Popular Tags