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

Go to download
/*******************************************************************************
 * Copyright (c) 2000, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.dialogs;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;

/**
 * Interface for a page in a multi-page dialog.
 */
public interface IDialogPage {
	/**
	 * Creates the top level control for this dialog
	 * page under the given parent composite.
	 * 
	 * Implementors are responsible for ensuring that
	 * the created control can be accessed via getControl
	 * 
	 *
	 * @param parent the parent composite
	 */
	void createControl(Composite parent);

	/**
	 * Disposes the SWT resources allocated by this
	 * dialog page.
	 */
	void dispose();

	/**
	 * Returns the top level control for this dialog page.
	 * 
	 * May return null if the control
	 * has not been created yet.
	 * 
	 *
	 * @return the top level control or null
	 */
	Control getControl();

	/**
	 * Returns this dialog page's description text.
	 *
	 * @return the description text for this dialog page,
	 *  or null if none
	 */
	String getDescription();

	/**
	 * Returns the current error message for this dialog page.
	 * May be null to indicate no error message.
	 * 
	 * An error message should describe some error state,
	 * as opposed to a message which may simply provide instruction
	 * or information to the user.
	 * 
	 *
	 * @return the error message, or null if none
	 */
	String getErrorMessage();

	/**
	 * Returns this dialog page's image.
	 *
	 * @return the image for this dialog page, or null
	 *  if none
	 */
	Image getImage();

	/**
	 * Returns the current message for this wizard page.
	 * 
	 * A message provides instruction or information to the
	 * user, as opposed to an error message which should
	 * describe some error state.
	 * 
	 *
	 * @return the message, or null if none
	 */
	String getMessage();

	/**
	 * Returns this dialog page's title.
	 *
	 * @return the title of this dialog page,
	 *  or null if none
	 */
	String getTitle();

	/**
	 * Notifies that help has been requested for this dialog page.
	 */
	void performHelp();

	/**
	 * Sets this dialog page's description text.
	 *
	 * @param description the description text for this dialog
	 *  page, or null if none
	 */
	void setDescription(String description);

	/**
	 * Sets this dialog page's image.
	 *
	 * @param image the image for this dialog page,
	 *  or null if none
	 */
	void setImageDescriptor(ImageDescriptor image);

	/**
	 * Set this dialog page's title.
	 *
	 * @param title the title of this dialog page,
	 *  or null if none
	 */
	void setTitle(String title);

	/**
	 * Sets the visibility of this dialog page.
	 *
	 * @param visible true to make this page visible,
	 *  and false to hide it
	 */
	void setVisible(boolean visible);
}