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