|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void createControl(Composite parent)
Implementors are responsible for ensuring that
the created control can be accessed via getControl
parent
- the parent compositepublic void dispose()
public Control getControl()
May return null
if the control
has not been created yet.
null
public String getDescription()
null
if nonepublic String 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.
- Returns:
- the error message, or
null
if none
public Image getImage()
null
if nonepublic String getMessage()
A message provides instruction or information to the user, as opposed to an error message which should describe some error state.
null
if nonepublic String getTitle()
null
if nonepublic void performHelp()
public void setDescription(String description)
description
- the description text for this dialog
page, or null
if nonepublic void setImageDescriptor(ImageDescriptor image)
image
- the image for this dialog page,
or null
if nonepublic void setTitle(String title)
title
- the title of this dialog page,
or null
if nonepublic void setVisible(boolean visible)
visible
- true
to make this page visible,
and false
to hide it
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |