WizardPage

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> jface >> [ wizard overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.jface.wizard.WizardPage

SOURCE |

Download org.eclipse.jface.wizard.WizardPage

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.wizard
Class WizardPage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.wizard.WizardPage

All Implemented Interfaces:: org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, IWizardPage

Direct Known Subclasses:: WizardSelectionPage

public abstract class WizardPage
extends org.eclipse.jface.dialogs.DialogPage
implements IWizardPage

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 page
canFlipToNextPage - may be extended or reimplemented
isPageComplete - 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

private boolean isPageComplete
          Indicates whether this page is complete.

private java.lang.String name
          This page's name.

private IWizardPage previousPage
          The page that was shown right before this page became visible; null if none.

private IWizard wizard
          The wizard to which this page belongs; null if this page has yet to be added to a wizard.

Fields inherited from class org.eclipse.jface.dialogs.DialogPage

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

protected WizardPage(java.lang.String pageName)
          Creates a new wizard page with the given name, and with no title or image.

protected WizardPage(java.lang.String pageName, java.lang.String title, org.eclipse.jface.resource.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 org.eclipse.jface.dialogs.IDialogSettings getDialogSettings()
          Returns the dialog settings for this wizard page.

org.eclipse.swt.graphics.Image getImage()
          Returns this dialog page's image.

java.lang.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.

org.eclipse.swt.widgets.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(java.lang.String description)
          The WizardPage implementation of this IDialogPage method extends the DialogPage implementation to update the wizard container title bar.

void setErrorMessage(java.lang.String newMessage)
          The WizardPage implementation of this method declared on DialogPage updates the container if this is the current page.

void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)
          The WizardPage implementation of this method declared on DialogPage updates the container if this page is the current page.

void setMessage(java.lang.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(java.lang.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.

java.lang.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, setButtonLayoutData, 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

Field Detail

name

private java.lang.String name

This page's name.

wizard

private IWizard wizard

The wizard to which this page belongs; null if this page has yet to be added to a wizard.

isPageComplete

private boolean isPageComplete

Indicates whether this page is complete.

private IWizardPage previousPage

The page that was shown right before this page became visible; null if none.

Constructor Detail

WizardPage

protected WizardPage(java.lang.String pageName)

Creates a new wizard page with the given name, and with no title or image.

WizardPage

protected WizardPage(java.lang.String pageName,
                     java.lang.String title,
                     org.eclipse.jface.resource.ImageDescriptor titleImage)

Creates a new wizard page with the given name, title, and image.

Method Detail

canFlipToNextPage

public 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. Subclasses may override (extend or reimplement).

Specified by:: canFlipToNextPage in interface IWizardPage

getContainer

protected IWizardContainer getContainer()

Returns the wizard container for this wizard page.

getDialogSettings

protected org.eclipse.jface.dialogs.IDialogSettings getDialogSettings()

Returns the dialog settings for this wizard page.

getImage

public org.eclipse.swt.graphics.Image getImage()

Description copied from interface: org.eclipse.jface.dialogs.IDialogPage

Returns this dialog page's image.

Specified by:: getImage in interface org.eclipse.jface.dialogs.IDialogPage

getName

public java.lang.String getName()

Description copied from interface: IWizardPage

Returns this page's name.

Specified by:: getName in interface IWizardPage

getNextPage

public IWizardPage getNextPage()

Description copied from interface: IWizardPage

Returns the wizard page that would to be shown if the user was to press the Next button.

Specified by:: getNextPage in interface IWizardPage

getPreviousPage

public IWizardPage getPreviousPage()

Description copied from interface: IWizardPage

Returns the wizard page that would to be shown if the user was to press the Back button.

Specified by:: getPreviousPage in interface IWizardPage

getShell

public org.eclipse.swt.widgets.Shell getShell()

The 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.

getWizard

public IWizard getWizard()

Description copied from interface: IWizardPage

Returns the wizard that hosts this wizard page.

Specified by:: getWizard in interface IWizardPage

isCurrentPage

protected boolean isCurrentPage()

Returns whether this page is the current one in the wizard's container.

isPageComplete

public boolean isPageComplete()

The WizardPage implementation of this IWizard method returns the value of an internal state variable set by setPageComplete. Subclasses may extend.

Specified by:: isPageComplete in interface IWizardPage

setDescription

public void setDescription(java.lang.String description)

The WizardPage implementation of this IDialogPage method extends the DialogPage implementation to update the wizard container title bar. Subclasses may extend.

Specified by:: setDescription in interface org.eclipse.jface.dialogs.IDialogPage

setErrorMessage

public void setErrorMessage(java.lang.String newMessage)

The WizardPage implementation of this method declared on DialogPage updates the container if this is the current page.

setImageDescriptor

public void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)

The WizardPage implementation of this method declared on DialogPage updates the container if this page is the current page.

Specified by:: setImageDescriptor in interface org.eclipse.jface.dialogs.IDialogPage

setMessage

public void setMessage(java.lang.String newMessage,
                       int newType)

The WizardPage implementation of this method declared on DialogPage updates the container if this is the current page.

setPageComplete

public void setPageComplete(boolean complete)

Sets whether this page is 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.

setPreviousPage

public void setPreviousPage(IWizardPage page)

Description copied from interface: IWizardPage

Sets the wizard page that would typically be shown if the user was to press the Back button.

This method is called by the container.

Specified by:: setPreviousPage in interface IWizardPage

setTitle

public void setTitle(java.lang.String title)

The WizardPage implementation of this IDialogPage method extends the DialogPage implementation to update the wizard container title bar. Subclasses may extend.

Specified by:: setTitle in interface org.eclipse.jface.dialogs.IDialogPage

setWizard

public void setWizard(IWizard newWizard)

Description copied from interface: IWizardPage

Sets the wizard that hosts this wizard page. Once established, a page's wizard cannot be changed to a different wizard.

Specified by:: setWizard in interface IWizardPage

toString

public java.lang.String toString()

Returns a printable representation of this wizard page suitable only for debug purposes.

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> jface >> [ wizard overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`private boolean`	`isPageComplete` Indicates whether this page is complete.
`private java.lang.String`	`name` This page's name.
`private IWizardPage`	`previousPage` The page that was shown right before this page became visible; `null` if none.
`private IWizard`	`wizard` The wizard to which this page belongs; `null` if this page has yet to be added to a wizard.

Constructor Summary
`protected`	`WizardPage(java.lang.String pageName)` Creates a new wizard page with the given name, and with no title or image.
`protected`	`WizardPage(java.lang.String pageName, java.lang.String title, org.eclipse.jface.resource.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 org.eclipse.jface.dialogs.IDialogSettings`	`getDialogSettings()` Returns the dialog settings for this wizard page.
`org.eclipse.swt.graphics.Image`	`getImage()` Returns this dialog page's image.
`java.lang.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.
`org.eclipse.swt.widgets.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(java.lang.String description)` The `WizardPage` implementation of this `IDialogPage` method extends the `DialogPage` implementation to update the wizard container title bar.
`void`	`setErrorMessage(java.lang.String newMessage)` The `WizardPage` implementation of this method declared on `DialogPage` updates the container if this is the current page.
`void`	`setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)` The `WizardPage` implementation of this method declared on `DialogPage` updates the container if this page is the current page.
`void`	`setMessage(java.lang.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(java.lang.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.
`java.lang.String`	`toString()` Returns a printable representation of this wizard page suitable only for debug purposes.

org.eclipse.jface.wizard Class WizardPage

name

wizard

isPageComplete

previousPage

WizardPage

WizardPage

canFlipToNextPage

getContainer

getDialogSettings

getImage

getName

getNextPage

getPreviousPage

getShell

getWizard

isCurrentPage

isPageComplete

setDescription

setErrorMessage

setImageDescriptor

setMessage

setPageComplete

setPreviousPage

setTitle

setWizard

toString

org.eclipse.jface.wizard
Class WizardPage