view dwtx/jface/dialogs/DialogTray.d @ 11:11bd25f93332

TrayDialog
author Frank Benoit <benoit@tionex.de>
date Mon, 31 Mar 2008 01:03:07 +0200
parents
children
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2005 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
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwtx.jface.dialogs.DialogTray;

import dwt.widgets.Composite;
import dwt.widgets.Control;

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

    /**
     * Creates the contents (widgets) that will be contained in the tray.
     * <p>
     * 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.
     * </p>
     *
     * @param parent the composite that will contain the tray
     * @return the contents of the tray, as a <code>Control</code>
     */
    protected abstract Control createContents(Composite parent);
    package Control createContents_package(Composite parent){
        return createContents(parent);
    }
}