KickJava   Java API By Example, From Geeks To Geeks.

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


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;
12
13 /**
14  * Represents the layout info for a view or placeholder in an {@link IPageLayout}.
15  * <p>
16  * This interface is not intended to be implemented by clients.
17  * </p>
18  *
19  * @since 3.0
20  */
21 public interface IViewLayout {
22
23     /**
24      * Returns whether the view is closeable.
25      * The default is <code>true</code>.
26      *
27      * @return <code>true</code> if the view is closeable, <code>false</code> if not
28      */
29     public boolean isCloseable();
30
31     /**
32      * Sets whether the view is closeable.
33      *
34      * @param closeable <code>true</code> if the view is closeable, <code>false</code> if not
35      */
36     public void setCloseable(boolean closeable);
37
38     /**
39      * Returns whether the view is moveable.
40      * The default is <code>true</code>.
41      *
42      * @return <code>true</code> if the view is moveable, <code>false</code> if not
43      */
44     public boolean isMoveable();
45
46     /**
47      * Sets whether the view is moveable.
48      *
49      * @param moveable <code>true</code> if the view is moveable, <code>false</code> if not
50      */
51     public void setMoveable(boolean moveable);
52
53     /**
54      * Returns whether the view is a standalone view.
55      *
56      * @see IPageLayout#addStandaloneView
57      */
58     public boolean isStandalone();
59
60     /**
61      * Returns whether the view shows its title.
62      * This is only applicable to standalone views.
63      *
64      * @see IPageLayout#addStandaloneView
65      */
66     public boolean getShowTitle();
67 }
68
Popular Tags