Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.dialogs
Interface IDialogPage

All Known Subinterfaces:

IPreferencePage, ISearchPage, IWizardPage, IWorkbenchPreferencePage, IWorkbenchPropertyPage, IWorkingSetPage

All Known Implementing Classes:

DialogPage, PreferencePage, PropertyPage, TemplatePreferencePage, TextEditorPreferencePage, WizardPage

public interface IDialogPage

Interface for a page in a multi-page dialog.

Method Summary

void	createControl(Composite parent) Creates the top level control for this dialog page under the given parent composite.
void	dispose() Disposes the SWT resources allocated by this dialog page.
Control	getControl() Returns the top level control for this dialog page.
String	getDescription() Returns this dialog page's description text.
String	getErrorMessage() Returns the current error message for this dialog page.
Image	getImage() Returns this dialog page's image.
String	getMessage() Returns the current message for this wizard page.
String	getTitle() Returns this dialog page's title.
void	performHelp() Notifies that help has been requested for this dialog page.
void	setDescription(String description) Sets this dialog page's description text.
void	setImageDescriptor(ImageDescriptor image) Sets this dialog page's image.
void	setTitle(String title) Set this dialog page's title.
void	setVisible(boolean visible) Sets the visibility of this dialog page.

Method Detail

createControl

public void createControl(Composite parent)

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

Parameters:

parent - the parent composite

dispose

public void dispose()

Disposes the SWT resources allocated by this dialog page.

getControl

public Control getControl()

Returns the top level control for this dialog page.

May return null if the control has not been created yet.

Returns:

the top level control or null

getDescription

public String getDescription()

Returns this dialog page's description text.

Returns:

the description text for this dialog page, or null if none

getErrorMessage

public String getErrorMessage()

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.

Returns:

the error message, or null if none

getImage

public Image getImage()

Returns this dialog page's image.

Returns:

the image for this dialog page, or null if none

getMessage

public String getMessage()

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.

Returns:

the message, or null if none

getTitle

public String getTitle()

Returns this dialog page's title.

Returns:

the title of this dialog page, or null if none

performHelp

public void performHelp()

Notifies that help has been requested for this dialog page.

setDescription

public void setDescription(String description)

Sets this dialog page's description text.

Parameters:

description - the description text for this dialog page, or null if none

setImageDescriptor

public void setImageDescriptor(ImageDescriptor image)

Sets this dialog page's image.

Parameters:

image - the image for this dialog page, or null if none

setTitle

public void setTitle(String title)

Set this dialog page's title.

Parameters:

title - the title of this dialog page, or null if none

setVisible

public void setVisible(boolean visible)

Sets the visibility of this dialog page.

Parameters:

visible - true to make this page visible, and false to hide it