net.sourceforge.java.feednread.frontend.wizard
Class WatchWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      net.sourceforge.java.feednread.frontend.wizard.WatchWizard

All Implemented Interfaces:

IWizard

public class WatchWizard

extends Wizard

Wizard implementation that guides the end-user step by step through the creation process of a Watch object.

Author:

Sebastian Machhausen

Field Summary

private WatchBasicDataWizardPage	basicDataPage Lets the end-user enter basic Watch data
private FavoriteSelectionWizardPage	favoriteSelectionPage Lets the ened-user choose the Favorites to watch
private MainApplicationWindow	mainWindow The Feed'n Read main window
private WatchSettingsWizardPage	settingsPage Lets the end-user enter the WatchSettings data
private Watch	watch The Watch to edit; null if a new Watch has to be created

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

WatchWizard(MainApplicationWindow mainWindow)
Creates a new WatchWizard instance.

WatchWizard(MainApplicationWindow mainWindow, Watch watch)
Creates a new WatchWizard instance.

Method Summary

void	addPages() Adds all required WizardPages to this WatchWizard.
Watch	getWatch() Gets the Watch created or edited in this WatchWizard.
boolean	performFinish() Returns true if all data that is required to create a valid Watch object has been entered in order to finish this WatchWizard.

Methods inherited from class org.eclipse.jface.wizard.Wizard

addPage, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mainWindow

private MainApplicationWindow mainWindow

The Feed'n Read main window

watch

private Watch watch

The Watch to edit; null if a new Watch has to be created

basicDataPage

private WatchBasicDataWizardPage basicDataPage

Lets the end-user enter basic Watch data

settingsPage

private WatchSettingsWizardPage settingsPage

Lets the end-user enter the WatchSettings data

favoriteSelectionPage

private FavoriteSelectionWizardPage favoriteSelectionPage

Lets the ened-user choose the Favorites to watch

Constructor Detail

WatchWizard

public WatchWizard(MainApplicationWindow mainWindow)

Creates a new WatchWizard instance.

Parameters:

mainWindow - the Feed'n Read main window

See Also:

WatchWizard(MainApplicationWindow, Watch)

WatchWizard

public WatchWizard(MainApplicationWindow mainWindow,
                   Watch watch)

Creates a new WatchWizard instance.

Parameters:

mainWindow - the Feed'n Read main window

watch - the Watch to edit in this WatchWizard

See Also:

WatchWizard(MainApplicationWindow)

Method Detail

getWatch

public Watch getWatch()

Gets the Watch created or edited in this WatchWizard.

Returns:

the Watch created or edited in this WatchWizard; null if this WatchWizard was canceled in add mode

addPages

public void addPages()

Adds all required WizardPages to this WatchWizard.

See Also:

Wizard.addPages()

performFinish

public boolean performFinish()

Returns true if all data that is required to create a valid Watch object has been entered in order to finish this WatchWizard.

Returns:

true if this WatchWizard can be finished; false otherwise which means that some of the displayed WizardPages contain invalid inputs which denies this WatchWizard from finishing

See Also:

Wizard.performFinish()