public interface IDialogPage
Modifier and Type | Method and Description |
---|---|
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.
|
void createControl(Composite parent)
Implementors are responsible for ensuring that
the created control can be accessed via getControl
parent
- the parent compositevoid dispose()
Control getControl()
May return null
if the control
has not been created yet.
null
String getDescription()
null
if noneString getErrorMessage()
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.
null
if noneImage getImage()
null
if noneString getMessage()
A message provides instruction or information to the user, as opposed to an error message which should describe some error state.
null
if noneString getTitle()
null
if nonevoid performHelp()
void setDescription(String description)
description
- the description text for this dialog
page, or null
if nonevoid setImageDescriptor(ImageDescriptor image)
image
- the image for this dialog page,
or null
if nonevoid setTitle(String title)
title
- the title of this dialog page,
or null
if nonevoid setVisible(boolean visible)
visible
- true
to make this page visible,
and false
to hide it
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.