org.eclipse.rse.ui.wizards
Class RSENewConnectionWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      org.eclipse.rse.ui.wizards.AbstractSystemWizard
          org.eclipse.rse.ui.wizards.RSENewConnectionWizard

All Implemented Interfaces:

INewWizard, IRSENewConnectionWizard, ISystemPromptDialog, ISystemWizard, IWizard, IWorkbenchWizard

public class RSENewConnectionWizard

extends AbstractSystemWizard

implements IRSENewConnectionWizard

The New Connection wizard. This wizard allows users to create new RSE connections.

Field Summary

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

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

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

DEFAULT_IMAGE

Fields inherited from interface org.eclipse.rse.ui.wizards.IRSENewConnectionWizard

NEW_CONNECTION_WIZARD_DELEGATE_EXTENSION_CONFIG_ATTRIBUTE_CLASS, NEW_CONNECTION_WIZARD_DELEGATE_EXTENSION_CONFIG_ATTRIBUTE_SYSTEMTYPE, NEW_CONNECTION_WIZARD_DELEGATE_EXTENSION_CONFIG_NAME, NEW_CONNECTION_WIZARD_DELEGATE_EXTENSION_POINT_ID

Constructor Summary

RSENewConnectionWizard()
Constructor.

Method Summary

void	addPages() Creates the wizard pages.
boolean	canFinish()
IRSENewConnectionWizardDelegate	getDelegate()
IWizardPage	getNextPage(IWizardPage page)
IWizardPage	getPreviousPage(IWizardPage page)
boolean	performFinish() Called when finish pressed.
void	restrictToSystemType(IRSESystemType systemType) Restrict to a single system type.
void	restrictToSystemTypes(IRSESystemType[] systemTypes) Restrict system types.
void	setSelectedSystemType(IRSESystemType systemType) Sets the system type that was selected in the 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

createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getPage, getPageCount, getPages, 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.ui.IWorkbenchWizard

init

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

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

Constructor Detail

RSENewConnectionWizard

public RSENewConnectionWizard()

Constructor.

Method Detail

restrictToSystemType

public void restrictToSystemType(IRSESystemType systemType)

Description copied from interface: IRSENewConnectionWizard

Restrict to a single system type. Users will not be shown the system type selection page in the wizard.

Specified by:

restrictToSystemType in interface IRSENewConnectionWizard

Parameters:

systemType - the system type to restrict to.

See Also:

IRSENewConnectionWizard.restrictToSystemType(org.eclipse.rse.core.IRSESystemType)

restrictToSystemTypes

public void restrictToSystemTypes(IRSESystemType[] systemTypes)

Description copied from interface: IRSENewConnectionWizard

Restrict system types. Users will only be able to choose from the given system types.

Specified by:

restrictToSystemTypes in interface IRSENewConnectionWizard

Parameters:

systemTypes - the system types to restrict to.

See Also:

IRSENewConnectionWizard.restrictToSystemTypes(org.eclipse.rse.core.IRSESystemType[])

setSelectedSystemType

public void setSelectedSystemType(IRSESystemType systemType)

Description copied from interface: IRSENewConnectionWizard

Sets the system type that was selected in the wizard. This will only be called if the wizard shows the system type selection page, i.e. if the wizard is not restricted to a single system type.

Specified by:

setSelectedSystemType in interface IRSENewConnectionWizard

Parameters:

systemType - the system type.

See Also:

IRSENewConnectionWizard.setSelectedSystemType(org.eclipse.rse.core.IRSESystemType)

getDelegate

public IRSENewConnectionWizardDelegate getDelegate()

Specified by:

getDelegate in interface IRSENewConnectionWizard

See Also:

IRSENewConnectionWizard.getDelegate()

addPages

public void addPages()

Description copied from class: AbstractSystemWizard

Creates the wizard pages. This method is an override from the parent Wizard class, but is made abstract here to ensure child classes override it.

Specified by:

addPages in interface IWizard

Specified by:

addPages in class AbstractSystemWizard

See Also:

Wizard.addPages()

canFinish

public boolean canFinish()

Specified by:

canFinish in interface IWizard

See Also:

Wizard.canFinish()

getNextPage

public IWizardPage getNextPage(IWizardPage page)

Specified by:

getNextPage in interface IWizard

See Also:

Wizard.getNextPage(org.eclipse.jface.wizard.IWizardPage)

getPreviousPage

public IWizardPage getPreviousPage(IWizardPage page)

Specified by:

getPreviousPage in interface IWizard

See Also:

Wizard.getPreviousPage(org.eclipse.jface.wizard.IWizardPage)

performFinish

public boolean performFinish()

Description copied from class: AbstractSystemWizard

Called when finish pressed.

Return true if no errors, false to cancel the finish operation.

Typically, you walk through each wizard page calling performFinish on it, and only return true if they all return true. If one of the pages returns false, you should call setPageError(IWizardPage), which shows a message to the user about an error pending on another page, if the given page is not the current page.

Specified by:

performFinish in interface IWizard

Specified by:

performFinish in class AbstractSystemWizard

See Also:

Wizard.performFinish()