org.eclipse.jface.dialogs.DialogTray Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface Show documentation

This is org.eclipse.jface jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2005, 2015 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.dialogs;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

/**
 * 
 * This class is the abstract superclass of all dialog trays. A tray can be opened
 * in any TrayDialog.
 * 
 *
 * @see org.eclipse.jface.dialogs.TrayDialog
 * @since 3.2
 */
public abstract class DialogTray {

	/**
	 * Creates the contents (widgets) that will be contained in the tray.
	 * 
	 * Tray implementions must not set a layout on the parent composite, or assume
	 * a particular layout on the parent. The tray dialog will allocate space
	 * according to the natural size of the tray, and will fill the tray area with the
	 * tray's contents.
	 * 
	 *
	 * @param parent the composite that will contain the tray
	 * @return the contents of the tray, as a Control
	 */
	protected abstract Control createContents(Composite parent);
}