|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.dialogs.DialogPage | +--org.eclipse.jface.wizard.WizardPage
An abstract base implementation of a wizard page.
Subclasses must implement the createControl
method
to create the specific controls for the wizard page.
Subclasses may call the following methods to configure the wizard page:
setDescription
setErrorMessage
setImageDescriptor
setMessage
setPageComplete
setPreviousPage
setTitle
Subclasses may override these methods if required:
performHelp
- may be reimplemented to display help for the pagecanFlipToNextPage
- may be extended or reimplementedisPageComplete
- may be extended setDescription
- may be extended setTitle
- may be extended dispose
- may be extended to dispose additional allocated SWT resources
Note that clients are free to implement IWizardPage
from scratch
instead of subclassing WizardPage
. Correct implementations of
IWizardPage
will work with any correct implementation of
IWizard
.
Field Summary |
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
ERROR, INFORMATION, NONE, WARNING |
Constructor Summary | |
protected |
WizardPage(String pageName)
Creates a new wizard page with the given name, and with no title or image. |
protected |
WizardPage(String pageName,
String title,
ImageDescriptor titleImage)
Creates a new wizard page with the given name, title, and image. |
Method Summary | |
boolean |
canFlipToNextPage()
The WizardPage implementation of this IWizardPage
method returns true if this page is complete (isPageComplete )
and there is a next page to flip to. |
protected IWizardContainer |
getContainer()
Returns the wizard container for this wizard page. |
protected IDialogSettings |
getDialogSettings()
Returns the dialog settings for this wizard page. |
Image |
getImage()
Returns this dialog page's image. |
String |
getName()
Returns this page's name. |
IWizardPage |
getNextPage()
Returns the wizard page that would to be shown if the user was to press the Next button. |
IWizardPage |
getPreviousPage()
Returns the wizard page that would to be shown if the user was to press the Back button. |
Shell |
getShell()
The WizardPage implementation of this method declared on
DialogPage returns the shell of the container. |
IWizard |
getWizard()
Returns the wizard that hosts this wizard page. |
protected boolean |
isCurrentPage()
Returns whether this page is the current one in the wizard's container. |
boolean |
isPageComplete()
The WizardPage implementation of this IWizard method
returns the value of an internal state variable set by
setPageComplete . |
void |
setDescription(String description)
The WizardPage implementation of this IDialogPage
method extends the DialogPage implementation to update
the wizard container title bar. |
void |
setErrorMessage(String newMessage)
The WizardPage implementation of this method
declared on DialogPage updates the container
if this is the current page. |
void |
setImageDescriptor(ImageDescriptor image)
The WizardPage implementation of this method
declared on DialogPage updates the container
if this page is the current page. |
void |
setMessage(String newMessage,
int newType)
The WizardPage implementation of this method
declared on DialogPage updates the container
if this is the current page. |
void |
setPageComplete(boolean complete)
Sets whether this page is complete. |
void |
setPreviousPage(IWizardPage page)
Sets the wizard page that would typically be shown if the user was to press the Back button. |
void |
setTitle(String title)
The WizardPage implementation of this IDialogPage
method extends the DialogPage implementation to update
the wizard container title bar. |
void |
setWizard(IWizard newWizard)
Sets the wizard that hosts this wizard page. |
String |
toString()
Returns a printable representation of this wizard page suitable only for debug purposes. |
Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setControl, setMessage, setVisible |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible |
Constructor Detail |
protected WizardPage(String pageName)
pageName
- the name of the pageprotected WizardPage(String pageName, String title, ImageDescriptor titleImage)
pageName
- the name of the pagetitle
- the title for this wizard page,
or null
if nonetitleImage
- the image descriptor for the title of this wizard page,
or null
if noneMethod Detail |
public boolean canFlipToNextPage()
WizardPage
implementation of this IWizardPage
method returns true
if this page is complete (isPageComplete
)
and there is a next page to flip to. Subclasses may override (extend or reimplement).
canFlipToNextPage
in interface IWizardPage
true
if the next page could be displayed,
and false
otherwisegetNextPage()
,
isPageComplete()
protected IWizardContainer getContainer()
null
if this
wizard page has yet to be added to a wizard, or the
wizard has yet to be added to a containerprotected IDialogSettings getDialogSettings()
null
if nonepublic Image getImage()
IDialogPage
getImage
in interface IDialogPage
getImage
in class DialogPage
null
if nonepublic String getName()
IWizardPage
getName
in interface IWizardPage
public IWizardPage getNextPage()
IWizardPage
getNextPage
in interface IWizardPage
null
if nonepublic IWizardPage getPreviousPage()
IWizardPage
getPreviousPage
in interface IWizardPage
null
if nonepublic Shell getShell()
WizardPage
implementation of this method declared on
DialogPage
returns the shell of the container.
The advantage of this implementation is that the shell is accessable
once the container is created even though this page's control may not
yet be created.
getShell
in class DialogPage
public IWizard getWizard()
IWizardPage
getWizard
in interface IWizardPage
null
if this page has not been
added to any wizardIWizardPage.setWizard(org.eclipse.jface.wizard.IWizard)
protected boolean isCurrentPage()
true
if the page is active,
and false
otherwisepublic boolean isPageComplete()
WizardPage
implementation of this IWizard
method
returns the value of an internal state variable set by
setPageComplete
. Subclasses may extend.
isPageComplete
in interface IWizardPage
true
if this page is complete, and
false
otherwisepublic void setDescription(String description)
WizardPage
implementation of this IDialogPage
method extends the DialogPage
implementation to update
the wizard container title bar. Subclasses may extend.
setDescription
in interface IDialogPage
setDescription
in class DialogPage
description
- the description text for this dialog
page, or null
if nonepublic void setErrorMessage(String newMessage)
WizardPage
implementation of this method
declared on DialogPage
updates the container
if this is the current page.
setErrorMessage
in class DialogPage
newMessage
- the message, or null
to clear
the error messagepublic void setImageDescriptor(ImageDescriptor image)
WizardPage
implementation of this method
declared on DialogPage
updates the container
if this page is the current page.
setImageDescriptor
in interface IDialogPage
setImageDescriptor
in class DialogPage
image
- the image for this dialog page,
or null
if nonepublic void setMessage(String newMessage, int newType)
WizardPage
implementation of this method
declared on DialogPage
updates the container
if this is the current page.
setMessage
in class DialogPage
newMessage
- the message, or null
to clear
the messagenewType
- the message typepublic void setPageComplete(boolean complete)
This information is typically used by the wizard to decide when it is okay to move on to the next page or finish up.
complete
- true
if this page is complete, and
and false
otherwiseisPageComplete()
public void setPreviousPage(IWizardPage page)
IWizardPage
This method is called by the container.
setPreviousPage
in interface IWizardPage
page
- the previous wizard pagepublic void setTitle(String title)
WizardPage
implementation of this IDialogPage
method extends the DialogPage
implementation to update
the wizard container title bar. Subclasses may extend.
setTitle
in interface IDialogPage
setTitle
in class DialogPage
title
- the title of this dialog page,
or null
if nonepublic void setWizard(IWizard newWizard)
IWizardPage
setWizard
in interface IWizardPage
newWizard
- the wizardIWizardPage.getWizard()
public String toString()
toString
in class Object
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |