|
 |
|
| |
org.eclipse.jface.dialogs
Interface IDialogPage
-
All Known Subinterfaces:
-
IPreferencePage,
ISearchPage,
ISearchScopePage,
IWizardPage,
IWorkbenchPreferencePage,
IWorkbenchPropertyPage,
IWorkingSetPage
-
All Known Implementing Classes:
-
ActivitiesPreferencePage,
ActivityCategoryPreferencePage,
DialogPage,
FieldEditorPreferencePage,
InstallationPage,
PreferencePage,
PropertyPage,
RefactoringWizardPage,
RootScopePage,
TemplatePreferencePage,
TextEditorPreferencePage,
UserInputWizardPage,
WizardDataTransferPage,
WizardExportPage,
WizardExportResourcesPage,
WizardExternalProjectImportPage,
WizardImportPage,
WizardNewFileCreationPage,
WizardNewFolderMainPage,
WizardNewLinkPage,
WizardNewProjectCreationPage,
WizardNewProjectReferencePage,
WizardPage,
WizardPropertyPage,
WizardResourceImportPage,
WizardSelectionPage
-
public interface IDialogPage
Interface for a page in a multi-page dialog.
createControl
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
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 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
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
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
void setImageDescriptor(
ImageDescriptor image)
- Sets this dialog page's image.
-
-
Parameters:
-
image - the image for this dialog page,
or null if none
setTitle
void setTitle(
String title)
- Set this dialog page's title.
-
-
Parameters:
-
title - the title of this dialog page,
or null if none
setVisible
void setVisible(boolean visible)
- Sets the visibility of this dialog page.
-
-
Parameters:
-
visible - true to make this page visible,
and false to hide it
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
