KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > dialogs > DialogTray


1 /*******************************************************************************
2  * Copyright (c) 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.dialogs;
12
13 import org.eclipse.swt.widgets.Composite;
14 import org.eclipse.swt.widgets.Control;
15
16 /**
17  * <p>
18  * This class is the abstract superclass of all dialog trays. A tray can be opened
19  * in any <code>TrayDialog</code>.
20  * </p>
21  *
22  * @see org.eclipse.jface.dialogs.TrayDialog
23  * @since 3.2
24  */
25 public abstract class DialogTray {
26
27     /**
28      * Creates the contents (widgets) that will be contained in the tray.
29      * <p>
30      * Tray implementions must not set a layout on the parent composite, or assume
31      * a particular layout on the parent. The tray dialog will allocate space
32      * according to the natural size of the tray, and will fill the tray area with the
33      * tray's contents.
34      * </p>
35      *
36      * @param parent the composite that will contain the tray
37      * @return the contents of the tray, as a <code>Control</code>
38      */
39     protected abstract Control createContents(Composite parent);
40 }
41
Popular Tags