org.eclipse.jface.wizard.IWizardNode 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) 2000, 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.wizard;

import org.eclipse.swt.graphics.Point;

/**
 * A wizard node acts a placeholder for a real wizard in a wizard
 * selection page. It is done in such a way that the actual creation
 * of a wizard can be deferred until the wizard is really needed.
 * 
 * When a wizard node comes into existence, its wizard may or may
 * not have been created yet; isContentCreated can
 * be used to determine which. A node may be asked for its wizard
 * using getWizard, which will force it to be created
 * if required. Once the client is done with a wizard node, its
 * disposemethod must be called to free up the wizard;
 * once disposes, the node should no longer be used.
 * 
 * 
 * This interface should be implemented by clients wishing to
 * support this kind of wizard placeholder in a wizard selection page.
 * 
 *
 * @see WizardSelectionPage
 */
public interface IWizardNode {
    /**
     * Disposes the wizard managed by this node. Does nothing
     * if the wizard has not been created.
     * 
     * This is the last message that should ever be sent to this node.
     * 
     */
    public void dispose();

    /**
     * Returns the extent of the wizard for this node.
     * 
     * If the content has not yet been created, calling this method
     * does not trigger the creation of the wizard. This allows
     * this node to suggest an extent in advance of actually creating
     * the wizard.
     * 
     *
     * @return the extent, or (-1, -1) extent is not known
     */
    public Point getExtent();

    /**
     * Returns the wizard this node stands for.
     * 
     * If the content has not been created beforehand, calling this
     * method triggers the creation of the wizard and caches it so that
     * the identical wizard object is returned on subsequent calls.
     * 
     *
     * @return the wizard
     */
    public IWizard getWizard();

    /**
     * Returns whether a wizard has been created for this node.
     *
     * @return true if a wizard has been created,
     *   and false otherwise
     */
    public boolean isContentCreated();
}