org.eclipse.rse.ui.wizards
Class SystemNewConnectionWizardDefaultMainPage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.wizard.WizardPage
          org.eclipse.rse.ui.wizards.AbstractSystemWizardPage
              org.eclipse.rse.ui.wizards.SystemNewConnectionWizardDefaultMainPage

All Implemented Interfaces:

IDialogPage, IMessageProvider, ISystemConnectionFormCaller, ISystemMessageLine, ISystemNewConnectionWizardMainPage, ISystemWizardPage, IWizardPage

public class SystemNewConnectionWizardDefaultMainPage

extends AbstractSystemWizardPage

implements ISystemNewConnectionWizardMainPage, ISystemMessageLine, ISystemConnectionFormCaller

Default main page of the "New Connection" wizard. This page asks for the primary information, including:

• Connection Name
• Hostname/IP-address
• UserId
• Description

Field Summary

protected SystemConnectionForm	form
protected String	parentHelpId
protected String[]	restrictSystemTypesTo

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

SystemNewConnectionWizardDefaultMainPage(Wizard wizard, String title, String description)
Constructor.

Method Summary

boolean	canFlipToNextPage() Intercept of WizardPge so we know when the wizard framework is deciding whether to enable next or not.
Control	createContents(Composite parent) CreateContents is the one method that must be overridden from the parent class.
String	getConnectionDescription() Return user-entered Description.
String	getConnectionName() Return user-entered Connection Name.
String	getDefaultUserId() Return user-entered Default User Id.
int	getDefaultUserIdLocation() Return location where default user id is to be set.
protected SystemConnectionForm	getForm() Overrride this if you want to supply your own form.
String	getHostName() Return user-entered Host Name.
protected Control	getInitialFocusControl() Return the Control to be given initial focus.
Object	getLayoutData()
IWizardPage	getNextPage() Intercept of WizardPage so we know when Next is pressed
String	getProfileName() Return name of profile to contain new connection.
String	getSystemType() Return user-entered System Type.
boolean	isPageComplete() Return true if the page is complete, so to enable Finish.
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	setConnectionNameValidators(ISystemValidator[] v) Call this to specify a validator for the connection name.
void	setCurrentlySelectedConnection(IHost connection) Set the currently selected connection so as to better initialize input fields
void	setHostName(String name) Preset the host name
void	setHostNameValidator(ISystemValidator v) Call this to specify a validator for the hostname.
void	setLayoutData(Object gridData)
void	setProfileNamePreSelection(String name) Set the profile name to preselect
void	setProfileNames(String[] names) Set the profile names to show in the combo
void	setUserId(String userId) This method allows setting of the initial user Id.
void	setUserIdValidator(ISystemValidator v) Call this to specify a validator for the userId.
void	systemTypeSelected(String systemType, boolean duringInitialization) Event: the user has selected a system type.

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

addFillerLine, addGrowableFillerLine, addSeparatorLine, applyMnemonics, clearErrorMessage, clearMessage, createControl, getHelpContextId, getInputObject, getMessageLine, getSystemErrorMessage, setBusyCursor, setErrorMessage, setErrorMessage, setErrorMessage, setFocus, setHelp, setHelp, setInputObject, setMessage, setMessage, setVisible

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

getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString

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

Methods inherited from class java.lang.Object

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

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

getHelpContextId, getInputObject, setHelp, setInputObject

Methods inherited from interface org.eclipse.rse.ui.messages.ISystemMessageLine

clearErrorMessage, clearMessage, getErrorMessage, getMessage, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setMessage, setMessage

Methods inherited from interface org.eclipse.rse.ui.ISystemConnectionFormCaller

getShell

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp

Field Detail

restrictSystemTypesTo

protected String[] restrictSystemTypesTo

form

protected SystemConnectionForm form

parentHelpId

protected String parentHelpId

Constructor Detail

SystemNewConnectionWizardDefaultMainPage

public SystemNewConnectionWizardDefaultMainPage(Wizard wizard,
                                                String title,
                                                String description)

Constructor. Use this when you want to supply your own title and description strings.

Method Detail

restrictSystemType

public void restrictSystemType(String systemType)

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

Specified by:

restrictSystemType in interface ISystemNewConnectionWizardMainPage

restrictSystemTypes

public void restrictSystemTypes(String[] systemTypes)

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

Specified by:

restrictSystemTypes in interface ISystemNewConnectionWizardMainPage

getForm

protected SystemConnectionForm getForm()

Overrride this if you want to supply your own form. This may be called multiple times so please only instantatiate if the form instance variable is null, and then return the form instance variable.

See Also:

SystemConnectionForm

setConnectionNameValidators

public void setConnectionNameValidators(ISystemValidator[] v)

Call this to specify a validator for the connection name. It will be called per keystroke.

Specified by:

setConnectionNameValidators in interface ISystemNewConnectionWizardMainPage

setHostNameValidator

public void setHostNameValidator(ISystemValidator v)

Call this to specify a validator for the hostname. It will be called per keystroke.

Specified by:

setHostNameValidator in interface ISystemNewConnectionWizardMainPage

setUserIdValidator

public void setUserIdValidator(ISystemValidator v)

Call this to specify a validator for the userId. It will be called per keystroke.

Specified by:

setUserIdValidator in interface ISystemNewConnectionWizardMainPage

setUserId

public void setUserId(String userId)

This method 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.

Specified by:

setUserId in interface ISystemNewConnectionWizardMainPage

setProfileNames

public void setProfileNames(String[] names)

Set the profile names to show in the combo

Specified by:

setProfileNames in interface ISystemNewConnectionWizardMainPage

setProfileNamePreSelection

public void setProfileNamePreSelection(String name)

Set the profile name to preselect

Specified by:

setProfileNamePreSelection in interface ISystemNewConnectionWizardMainPage

setCurrentlySelectedConnection

public void setCurrentlySelectedConnection(IHost connection)

Set the currently selected connection so as to better initialize input fields

Specified by:

setCurrentlySelectedConnection in interface ISystemNewConnectionWizardMainPage

setConnectionName

public void setConnectionName(String name)

Preset the connection name

Specified by:

setConnectionName in interface ISystemNewConnectionWizardMainPage

setHostName

public void setHostName(String name)

Preset the host name

Specified by:

setHostName in interface ISystemNewConnectionWizardMainPage

createContents

public Control createContents(Composite parent)

CreateContents is the one method that must be overridden from the parent class. In this method, we populate an SWT container with widgets and return the container to the caller (JFace). This is used as the contents of this page.

Specified by:

createContents in class AbstractSystemWizardPage

See Also:

SystemWidgetHelpers

getInitialFocusControl

protected Control getInitialFocusControl()

Return the Control to be given initial focus. Override from parent. Return control to be given initial focus.

Specified by:

getInitialFocusControl in class AbstractSystemWizardPage

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 ISystemWizardPage

Specified by:

performFinish in class AbstractSystemWizardPage

Returns:

whether the wizard finished successfully

getSystemType

public String getSystemType()

Return user-entered System Type. Call this after finish ends successfully.

Specified by:

getSystemType in interface ISystemNewConnectionWizardMainPage

getConnectionName

public String getConnectionName()

Return user-entered Connection Name. Call this after finish ends successfully.

Specified by:

getConnectionName in interface ISystemNewConnectionWizardMainPage

getHostName

public String getHostName()

Return user-entered Host Name. Call this after finish ends successfully.

Specified by:

getHostName in interface ISystemNewConnectionWizardMainPage

getDefaultUserId

public String getDefaultUserId()

Return user-entered Default User Id. Call this after finish ends successfully.

Specified by:

getDefaultUserId in interface ISystemNewConnectionWizardMainPage

getDefaultUserIdLocation

public int getDefaultUserIdLocation()

Return location where default user id is to be set.

Specified by:

getDefaultUserIdLocation in interface ISystemNewConnectionWizardMainPage

See Also:

ISystemUserIdConstants

getConnectionDescription

public String getConnectionDescription()

Return user-entered Description. Call this after finish ends successfully.

Specified by:

getConnectionDescription in interface ISystemNewConnectionWizardMainPage

getProfileName

public String getProfileName()

Return name of profile to contain new connection. Call this after finish ends successfully.

Specified by:

getProfileName in interface ISystemNewConnectionWizardMainPage

getLayoutData

public Object getLayoutData()

setLayoutData

public void setLayoutData(Object gridData)

isPageComplete

public boolean isPageComplete()

Return true if the page is complete, so to enable Finish. Called by wizard framework.

Specified by:

isPageComplete in interface IWizardPage

getNextPage

public IWizardPage getNextPage()

Intercept of WizardPage so we know when Next is pressed

Specified by:

getNextPage in interface IWizardPage

canFlipToNextPage

public boolean canFlipToNextPage()

Intercept of WizardPge so we know when the wizard framework is deciding whether to enable next or not.

Specified by:

canFlipToNextPage in interface IWizardPage

systemTypeSelected

public void systemTypeSelected(String systemType,
                               boolean duringInitialization)

Event: the user has selected a system type.

Specified by:

systemTypeSelected in interface ISystemConnectionFormCaller

Parameters:

systemType - the type of system selected

duringInitialization - true if this is being set at page initialization time versus selected by the user