org.eclipse.rse.ui.filters.dialogs
Class SystemFilterNewFilterPoolWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      org.eclipse.rse.ui.wizards.AbstractSystemWizard
          org.eclipse.rse.ui.filters.dialogs.SystemFilterNewFilterPoolWizard

All Implemented Interfaces:

INewWizard, ISystemPromptDialog, ISystemWizard, IWizard, IWorkbenchWizard, SystemFilterPoolDialogInterface, SystemFilterPoolWizardInterface

public class SystemFilterNewFilterPoolWizard

extends AbstractSystemWizard

implements SystemFilterPoolWizardInterface

Wizard for creating a new system filter pool.

Field Summary

protected SystemFilterAbstractFilterPoolAction	caller
protected SystemFilterNewFilterPoolWizardMainPageInterface	mainPage
protected ISystemFilterPoolManager[]	mgrs
protected SystemFilterPoolDialogOutputs	output
protected ValidatorFolderName	usv

Fields inherited from class org.eclipse.rse.ui.wizards.AbstractSystemWizard

cancelled, finishPressed, helpId, input, minPageHeight, minPageWidth, owningDialog, pageTitle, selection, viewer

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

DEFAULT_IMAGE

Constructor Summary

SystemFilterNewFilterPoolWizard()
Constructor that uses a default title and image

SystemFilterNewFilterPoolWizard(String title, ImageDescriptor image)
Constructor

Method Summary

void	addPages() Creates the wizard pages.
protected ISystemFilterPool	createFilterPool(ISystemFilterPoolManager selectedManager, String poolName) Process the create new filter pool request, after user presses OK on the dialog.
protected SystemFilterNewFilterPoolWizardMainPageInterface	createMainPage() Creates the wizard's main page.
SystemFilterAbstractFilterPoolAction	getFilterPoolDialogActionCaller() Allow wizard pages to get this.
SystemFilterPoolDialogOutputs	getFilterPoolDialogOutputs() Return an object containing user-specified information pertinent to filter pool actions
boolean	performFinish() Completes processing of the wizard.
void	setFilterPoolDialogActionCaller(SystemFilterAbstractFilterPoolAction caller) Allow base action to pass instance of itself for callback to get info
void	setHelpContextId(String id) Set the help context Id (infoPop) for this wizard.

Methods inherited from class org.eclipse.rse.ui.wizards.AbstractSystemWizard

addPage, getCurrentTreeView, getHelpContextId, getInputObject, getMinimumPageHeight, getMinimumPageWidth, getOutputObject, getSystemWizardDialog, getViewer, getWizardPageTitle, init, performCancel, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, setBusyCursor, setHelp, setInputObject, setMinimumPageSize, setOutputObject, setPageError, setSystemWizardDialog, setViewer, setWasCancelled, setWizardImage, setWizardPageTitle, setWizardTitle, updateSize, wasCancelled

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

canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, 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

Methods inherited from interface org.eclipse.rse.ui.wizards.ISystemWizard

getHelpContextId, getMinimumPageHeight, getMinimumPageWidth, getSystemWizardDialog, getViewer, getWizardPageTitle, setHelp, setMinimumPageSize, setSystemWizardDialog, setViewer, setWizardPageTitle, updateSize

Methods inherited from interface org.eclipse.ui.IWorkbenchWizard

init

Methods inherited from interface org.eclipse.jface.wizard.IWizard

canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Methods inherited from interface org.eclipse.rse.ui.dialogs.ISystemPromptDialog

getInputObject, getOutputObject, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, setInputObject, wasCancelled

Field Detail

mainPage

protected SystemFilterNewFilterPoolWizardMainPageInterface mainPage

usv

protected ValidatorFolderName usv

output

protected SystemFilterPoolDialogOutputs output

caller

protected SystemFilterAbstractFilterPoolAction caller

mgrs

protected ISystemFilterPoolManager[] mgrs

Constructor Detail

SystemFilterNewFilterPoolWizard

public SystemFilterNewFilterPoolWizard()

Constructor that uses a default title and image

SystemFilterNewFilterPoolWizard

public SystemFilterNewFilterPoolWizard(String title,
                                       ImageDescriptor image)

Constructor

Parameters:

image - The image for this wizard

Method Detail

setHelpContextId

public void setHelpContextId(String id)

Set the help context Id (infoPop) for this wizard. This must be fully qualified by plugin ID.

Specified by:

setHelpContextId in interface SystemFilterPoolDialogInterface

addPages

public void addPages()

Creates the wizard pages. This method is an override from the parent Wizard class.

Specified by:

addPages in interface IWizard

Specified by:

addPages in class AbstractSystemWizard

createMainPage

protected SystemFilterNewFilterPoolWizardMainPageInterface createMainPage()

Creates the wizard's main page.

performFinish

public boolean performFinish()

Completes processing of the wizard. If this method returns true, the wizard will close; otherwise, it will stay active. This method is an override from the parent Wizard class.

Specified by:

performFinish in interface IWizard

Specified by:

performFinish in class AbstractSystemWizard

Returns:

whether the wizard finished successfully

createFilterPool

protected ISystemFilterPool createFilterPool(ISystemFilterPoolManager selectedManager,
                                             String poolName)
                                      throws Exception

Process the create new filter pool request, after user presses OK on the dialog. By default, asks the selected manager to create the new pool of the given name.

Throws:

Exception

getFilterPoolDialogOutputs

public SystemFilterPoolDialogOutputs getFilterPoolDialogOutputs()

Return an object containing user-specified information pertinent to filter pool actions

Specified by:

getFilterPoolDialogOutputs in interface SystemFilterPoolDialogInterface

setFilterPoolDialogActionCaller

public void setFilterPoolDialogActionCaller(SystemFilterAbstractFilterPoolAction caller)

Allow base action to pass instance of itself for callback to get info

Specified by:

setFilterPoolDialogActionCaller in interface SystemFilterPoolDialogInterface

getFilterPoolDialogActionCaller

public SystemFilterAbstractFilterPoolAction getFilterPoolDialogActionCaller()

Allow wizard pages to get this.