KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > window > IShellProvider


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.jface.window;
12
13 import org.eclipse.swt.widgets.Shell;
14
15 /**
16  * Interface for objects that can return a shell. This is normally used for
17  * opening child windows. An object that wants to open child shells can take
18  * an IShellProvider in its constructor, and the object that implements IShellProvider
19  * can dynamically choose where child shells should be opened.
20  *
21  * @since 3.1
22  */
23 public interface IShellProvider {
24     /**
25      * Returns the current shell (or null if none). This return value may
26      * change over time, and should not be cached.
27      *
28      * @return the current shell or null if none
29      */
30     Shell getShell();
31 }
32
Popular Tags