org.eclipse.rse.ui.wizards
Class SystemNewConnectionWizard

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

All Implemented Interfaces:

INewWizard, ISystemPromptDialog, ISystemWizard, IWizard, IWorkbenchWizard

public class SystemNewConnectionWizard

extends AbstractSystemWizard

implements INewWizard

Wizard for creating a new remote systems connection.

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

Constructor Summary

SystemNewConnectionWizard()
Constructor

Method Summary

void	addPages() Creates the wizard pages.
boolean	canFinish() Intercept of Wizard method so we can take into account our additional pages
protected ISystemNewConnectionWizardMainPage	createMainPage(String[] restrictSystemTypesTo) Creates the wizard's main page.
protected ISystemNewConnectionWizardPage[]	getAdditionalWizardPages(String systemType)
IHost	getDummyHost()
protected IWizardPage	getFirstAdditionalPage() Return the first additional page to show when user presses Next on the main page
ISystemNewConnectionWizardMainPage	getMainPage() Return the main page of this wizard
SystemConnectionForm	getMainPageForm() Return the form of the main page of this wizard
IWizardPage	getNextPage(IWizardPage page) Intercept of Wizard method so we can get the Next button behaviour to work right for the dynamically managed additional wizard pages.
protected boolean	hasAdditionalPages() Return true if there are additional pages.
boolean	performFinish() Completes processing of the wizard.
void	restrictSystemType(String systemType) Call this to restrict the system type that the user is allowed to choose
void	restrictSystemTypes(String[] systemTypes) Call this to restrict the system types that the user is allowed to choose
void	setConnectionName(String name) Preset the connection name
void	setCurrentlySelectedConnection(IHost conn) Set the currently selected connection.
void	setHostName(String name) Preset the host name
protected void	setNewPrivateProfileName(String newName) Set the new profile name specified on the rename profile page...
void	setUserId(String userId) For "new" mode, allows setting of the initial user Id.
void	systemTypeSelected(String systemType, boolean duringInitialization) Event: the user has selected a system type.

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, 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.ui.IWorkbenchWizard

init

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

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

Constructor Detail

SystemNewConnectionWizard

public SystemNewConnectionWizard()

Constructor

Method Detail

restrictSystemType

public void restrictSystemType(String systemType)

Call this to restrict the system type that the user is allowed to choose

restrictSystemTypes

public void restrictSystemTypes(String[] systemTypes)

Call this to restrict the system types that the user is allowed to choose

getDummyHost

public IHost getDummyHost()

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 ISystemNewConnectionWizardMainPage createMainPage(String[] restrictSystemTypesTo)

Creates the wizard's main page. This method is an override from the parent class.

setCurrentlySelectedConnection

public void setCurrentlySelectedConnection(IHost conn)

Set the currently selected connection. Used to better default entry fields.

setUserId

public void setUserId(String userId)

For "new" mode, allows setting of the initial user Id. Sometimes subsystems like to have their own default userId preference page option. If so, query it and set it here by calling this.

setConnectionName

public void setConnectionName(String name)

Preset the connection name

setHostName

public void setHostName(String name)

Preset the host name

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

setNewPrivateProfileName

protected void setNewPrivateProfileName(String newName)

Set the new profile name specified on the rename profile page...

getMainPage

public ISystemNewConnectionWizardMainPage getMainPage()

Return the main page of this wizard

getMainPageForm

public SystemConnectionForm getMainPageForm()

Return the form of the main page of this wizard

systemTypeSelected

public void systemTypeSelected(String systemType,
                               boolean duringInitialization)

Event: the user has selected a system type.

getAdditionalWizardPages

protected ISystemNewConnectionWizardPage[] getAdditionalWizardPages(String systemType)

hasAdditionalPages

protected boolean hasAdditionalPages()

Return true if there are additional pages. This decides whether to enable the Next button on the main page

getFirstAdditionalPage

protected IWizardPage getFirstAdditionalPage()

Return the first additional page to show when user presses Next on the main page

getNextPage

public IWizardPage getNextPage(IWizardPage page)

Intercept of Wizard method so we can get the Next button behaviour to work right for the dynamically managed additional wizard pages.

Specified by:

getNextPage in interface IWizard

canFinish

public boolean canFinish()

Intercept of Wizard method so we can take into account our additional pages

Specified by:

canFinish in interface IWizard