org.eclipse.rse.ui.wizards
Class AbstractSystemNewConnectionWizardPage

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

All Implemented Interfaces:

IDialogPage, IMessageProvider, ISystemMessageLine, ISystemNewConnectionWizardPage, ISystemWizardPage, IWizardPage

Direct Known Subclasses:

SubSystemServiceWizardPage, SystemFileNewConnectionWizardPage, SystemSubSystemsPropertiesWizardPage

public abstract class AbstractSystemNewConnectionWizardPage

extends AbstractSystemWizardPage

implements ISystemNewConnectionWizardPage, IWizardPage

A base class for additional pages that are to be appended to the New Connection wizard.

See Also:

ISubSystemConfigurationAdapter.getNewConnectionWizardPages(ISubSystemConfiguration, org.eclipse.jface.wizard.IWizard)

Field Summary

protected ISubSystemConfiguration

parentFactory

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

AbstractSystemNewConnectionWizardPage(IWizard wizard, ISubSystemConfiguration parentFactory)
Constructor that defaults: the page name to the parent factory's id the page title to the parent factory's name the page description to RESID_NEWCONN_SUBSYSTEMPAGE_DESCRIPTION

AbstractSystemNewConnectionWizardPage(IWizard wizard, ISubSystemConfiguration parentFactory, String pageDescription)
Constructor that defaults: the page name to the parent factory's id the page title to the parent factory's name

AbstractSystemNewConnectionWizardPage(IWizard wizard, ISubSystemConfiguration parentFactory, String pageName, String pageTitle, String pageDescription)
Constructor that takes everything

Method Summary

abstract Control	createContents(Composite parent) Abstract method.
protected Control	getInitialFocusControl() Abstract method.
ISystemNewConnectionWizardMainPage	getMainPage() Get the main page of SystemNewConnectionWizard, which contains all user enter connection attributes
SystemConnectionForm	getMainPageForm() Get the SystemConnectionForm of the main page of SystemNewConnectionWizard, which contains all user enter connection attributes
RSENewConnectionWizard	getNewConnectionWizard() Get the parent wizard typed as the SystemNewConnectionWizard
ISubSystemConfiguration	getSubSystemConfiguration() Return the subsystem factory that supplied this page
boolean	performFinish() This is called when the users presses Finish.

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

canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, 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.core.model.ISystemNewConnectionWizardPage

isPageComplete

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

canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard

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

createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

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

getErrorMessage, getMessage

Field Detail

parentFactory

protected ISubSystemConfiguration parentFactory

Constructor Detail

AbstractSystemNewConnectionWizardPage

public AbstractSystemNewConnectionWizardPage(IWizard wizard,
                                             ISubSystemConfiguration parentFactory,
                                             String pageName,
                                             String pageTitle,
                                             String pageDescription)

Constructor that takes everything

AbstractSystemNewConnectionWizardPage

public AbstractSystemNewConnectionWizardPage(IWizard wizard,
                                             ISubSystemConfiguration parentFactory,
                                             String pageDescription)

Constructor that defaults:

• the page name to the parent factory's id
• the page title to the parent factory's name

AbstractSystemNewConnectionWizardPage

public AbstractSystemNewConnectionWizardPage(IWizard wizard,
                                             ISubSystemConfiguration parentFactory)

Constructor that defaults:

• the page name to the parent factory's id
• the page title to the parent factory's name
• the page description to RESID_NEWCONN_SUBSYSTEMPAGE_DESCRIPTION

Method Detail

getSubSystemConfiguration

public ISubSystemConfiguration getSubSystemConfiguration()

Return the subsystem factory that supplied this page

Specified by:

getSubSystemConfiguration in interface ISystemNewConnectionWizardPage

getInitialFocusControl

protected Control getInitialFocusControl()

Description copied from class: AbstractSystemWizardPage

Abstract method.
Return the Control to be given initial focus.

Child classes must override this, but can return null.

Specified by:

getInitialFocusControl in class AbstractSystemWizardPage

See Also:

AbstractSystemWizardPage.getInitialFocusControl()

createContents

public abstract Control createContents(Composite parent)

Description copied from class: AbstractSystemWizardPage

Abstract method.
Create the page contents here.

You may find it useful to use the static methods in SystemWidgetHelpers. If you do keystroke validation, you should call AbstractSystemWizardPage.setErrorMessage(SystemMessage) if you detect errors, and also WizardPage.setPageComplete(boolean) to affect the enablement of the next and finish buttons.

Specified by:

createContents in class AbstractSystemWizardPage

See Also:

AbstractSystemWizardPage.createContents(Composite)

performFinish

public boolean performFinish()

Description copied from interface: ISystemNewConnectionWizardPage

This is called when the users presses Finish. All that should be done here is validation of the input, returning true if all is ok and the finish can proceed.

Specified by:

performFinish in interface ISystemNewConnectionWizardPage

Specified by:

performFinish in class AbstractSystemWizardPage

See Also:

ISystemWizardPage.performFinish()

getNewConnectionWizard

public RSENewConnectionWizard getNewConnectionWizard()

Get the parent wizard typed as the SystemNewConnectionWizard

getMainPage

public ISystemNewConnectionWizardMainPage getMainPage()

Get the main page of SystemNewConnectionWizard, which contains all user enter connection attributes

getMainPageForm

public SystemConnectionForm getMainPageForm()

Get the SystemConnectionForm of the main page of SystemNewConnectionWizard, which contains all user enter connection attributes