Package org.eclipse.jface.dialogs
Interface IDialogPage
- All Known Subinterfaces:
IPreferencePage
,IScmUrlImportWizardPage
,ISearchPage
,ISearchScopePage
,IWizardPage
,IWorkbenchPreferencePage
,IWorkbenchPropertyPage
,IWorkbenchPropertyPageMulti
,IWorkingSetPage
- All Known Implementing Classes:
AcceptLicensesWizardPage
,ActivitiesPreferencePage
,ActivityCategoryPreferencePage
,ComparePreferencePage
,DialogPage
,FieldEditorPreferencePage
,InstallationPage
,InstalledSoftwarePage
,PreferencePage
,PropertyPage
,RefactoringWizardPage
,RenameResourceWizard.RenameResourceRefactoringConfigurationPage
,RepositoryManipulationPage
,RevertProfilePage
,RootScopePage
,TemplatePreferencePage
,TextEditorPreferencePage
,UserInputWizardPage
,WizardDataTransferPage
,WizardExportResourcesPage
,WizardExternalProjectImportPage
,WizardNewFileCreationPage
,WizardNewFolderMainPage
,WizardNewLinkPage
,WizardNewProjectCreationPage
,WizardNewProjectReferencePage
,WizardPage
,WizardPropertyPage
,WizardResourceImportPage
,WizardSelectionPage
public interface IDialogPage
Interface for a page in a multi-page dialog.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Returns the top level control for this dialog page.Returns this dialog page's description text.Returns the current error message for this dialog page.getImage()
Returns this dialog page's image.Returns the current message for this wizard page.getTitle()
Returns this dialog page's title.void
Notifies that help has been requested for this dialog page.void
setDescription
(String description) Sets this dialog page's description text.void
Sets this dialog page's image.void
Set this dialog page's title.void
setVisible
(boolean visible) Sets the visibility of this dialog page.
-
Method Details
-
createControl
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
void dispose()Disposes the SWT resources allocated by this dialog page. -
getControl
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
String getDescription()Returns this dialog page's description text.- Returns:
- the description text for this dialog page,
or
null
if none
-
getErrorMessage
String getErrorMessage()Returns the current error message for this dialog page. May benull
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
Image getImage()Returns this dialog page's image.- Returns:
- the image for this dialog page, or
null
if none
-
getMessage
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
String getTitle()Returns this dialog page's title.- Returns:
- the title of this dialog page,
or
null
if none
-
performHelp
void performHelp()Notifies that help has been requested for this dialog page. -
setDescription
Sets this dialog page's description text.- Parameters:
description
- the description text for this dialog page, ornull
if none
-
setImageDescriptor
Sets this dialog page's image.- Parameters:
image
- the image for this dialog page, ornull
if none
-
setTitle
Set this dialog page's title.- Parameters:
title
- the title of this dialog page, ornull
if none
-
setVisible
void setVisible(boolean visible) Sets the visibility of this dialog page.- Parameters:
visible
-true
to make this page visible, andfalse
to hide it
-