org.eclipse.jface.dialogs.IDialogPage Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2006 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 java.io.Serializable;
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 extends Serializable {
/**
* 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
*/
public void createControl(Composite parent);
/**
* Disposes the SWT resources allocated by this
* dialog page.
*/
public 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
*/
public Control getControl();
/**
* Returns this dialog page's description text.
*
* @return the description text for this dialog page,
* or null if none
*/
public 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
*/
public String getErrorMessage();
/**
* Returns this dialog page's image.
*
* @return the image for this dialog page, or null
* if none
*/
public 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
*/
public String getMessage();
/**
* Returns this dialog page's title.
*
* @return the title of this dialog page,
* or null if none
*/
public String getTitle();
/**
* Notifies that help has been requested for this dialog page.
*/
public void performHelp();
/**
* Sets this dialog page's description text.
*
* @param description the description text for this dialog
* page, or null if none
*/
public void setDescription(String description);
/**
* Sets this dialog page's image.
*
* @param image the image for this dialog page,
* or null if none
*/
public void setImageDescriptor(ImageDescriptor image);
/**
* Set this dialog page's title.
*
* @param title the title of this dialog page,
* or null if none
*/
public void setTitle(String title);
/**
* Sets the visibility of this dialog page.
*
* @param visible true to make this page visible,
* and false to hide it
*/
public void setVisible(boolean visible);
}