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

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

All Implemented Interfaces:

EventListener, IDialogPage, IMessageProvider, ISystemMessageLine, ISystemWizardPage, IWizardPage, Listener, SelectionListener, SWTEventListener, SystemFilterNewFilterPoolWizardMainPageInterface

public class SystemFilterNewFilterPoolWizardDefaultMainPage

extends AbstractSystemWizardPage

implements SystemFilterNewFilterPoolWizardMainPageInterface, Listener, SelectionListener

Default main page of the "New Filter Pool" wizard. This page asks for the name of the connection pool. Also allows user to select from a list of filter pool managers to put the filter pool into.

Field Summary

protected Label	labelMgr
protected Label	labelName
protected Combo	mgrCombo
protected String[]	mgrNames
protected int	mgrSelection
protected SystemFilterAbstractFilterPoolAction	parentWizardAction
protected Text	textName
protected ISystemValidator[]	validatorsByManager

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

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

Method Summary

Control	createContents(Composite parent) CreateContents is the one method that must be overridden from the parent class.
SystemFilterPoolDialogOutputs	getFilterPoolDialogOutputs() Return an object containing user-specified information pertinent to filter pool actions
protected String[]	getFilterPoolManagerNames() Returns array of manager names to show in combo box.
protected int	getFilterPoolManagerNameSelectionIndex() Returns the zero-based index of the manager name to preselect.
Control	getInitialFocusControl() Return control to recieve initial focus
String	getPoolManagerName() Return user-selected pool manager name.
protected String	getPoolManagerPromptText() Retrieve the pool manager combo prompt text.
protected String	getPoolManagerToolTip() Retrieve the pool manager combo field tooltip text.
String	getPoolName() Return user-entered pool name.
protected String	getPoolNamePromptText() Retrieve the pool name entry field prompt text.
protected String	getPoolNameToolTip() Retrieve the pool name entry field tooltip text.
void	handleEvent(Event e) Handles events generated by controls on this page.
boolean	performFinish() Completes processing of the wizard.
void	setFilterPoolManagerNameSelectionIndex(int index) Set the zero-based index of the manager name to preselect.
void	setFilterPoolManagers(ISystemFilterPoolManager[] mgrs) Call this to specify the list of filter pool managers to allow the user to select from.
void	setNameValidator(ISystemValidator v) Call this to specify a validator for the pool name.
void	setNameValidators(ISystemValidator[] v) Even if you call setFilterPoolManagers and you really want your own validators, then call this.
protected void	setPoolNameTextLimit(int mgrIndex) Set the name length for the filter pool based on the currently selected manager
protected SystemMessage	validateNameInput() This hook method is called whenever the text changes in the input field.
void	widgetDefaultSelected(SelectionEvent event) Combo selection listener method
void	widgetSelected(SelectionEvent event) Combo selection listener method

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.ui.wizards.ISystemWizardPage

getHelpContextId, getInputObject, setHelp, setInputObject

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

getErrorMessage, getMessage

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

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

Field Detail

labelName

protected Label labelName

labelMgr

protected Label labelMgr

textName

protected Text textName

mgrCombo

protected Combo mgrCombo

mgrSelection

protected int mgrSelection

mgrNames

protected String[] mgrNames

validatorsByManager

protected ISystemValidator[] validatorsByManager

parentWizardAction

protected SystemFilterAbstractFilterPoolAction parentWizardAction

Constructor Detail

SystemFilterNewFilterPoolWizardDefaultMainPage

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

Constructor.

Method Detail

setNameValidator

public void setNameValidator(ISystemValidator v)

Call this to specify a validator for the pool name. It will be called per keystroke. Only call this if you do not call setFilterPoolManagers!

Specified by:

setNameValidator in interface SystemFilterNewFilterPoolWizardMainPageInterface

setNameValidators

public void setNameValidators(ISystemValidator[] v)

Even if you call setFilterPoolManagers and you really want your own validators, then call this. Otherwise, FolderNameValidator will be called for you. The input must be an array of validators that is the same length as the array of filter pool managers. Call this AFTER setFilterPoolManagers!

Specified by:

setNameValidators in interface SystemFilterNewFilterPoolWizardMainPageInterface

setFilterPoolManagers

public void setFilterPoolManagers(ISystemFilterPoolManager[] mgrs)

Call this to specify the list of filter pool managers to allow the user to select from. Either call this or override getFilterPoolManagerNames, or leave null and this prompt will not show.

Specified by:

setFilterPoolManagers in interface SystemFilterNewFilterPoolWizardMainPageInterface

getFilterPoolManagerNames

protected String[] getFilterPoolManagerNames()

Returns array of manager names to show in combo box.

setFilterPoolManagerNameSelectionIndex

public void setFilterPoolManagerNameSelectionIndex(int index)

Set the zero-based index of the manager name to preselect. The default is zero. Either call this or override getFilterPoolManagerNameSelectionIndex.

Specified by:

setFilterPoolManagerNameSelectionIndex in interface SystemFilterNewFilterPoolWizardMainPageInterface

getFilterPoolManagerNameSelectionIndex

protected int getFilterPoolManagerNameSelectionIndex()

Returns the zero-based index of the manager name to preselect. Returns what was set in setFilterPoolManagerNameSelectionIndex by default.

getPoolNamePromptText

protected String getPoolNamePromptText()

Retrieve the pool name entry field prompt text. By default, uses what we set in setPoolNamePromptText, or uses a supplied default if that is null.

getPoolNameToolTip

protected String getPoolNameToolTip()

Retrieve the pool name entry field tooltip text. By default, uses what we set in setPoolNameToolTip, or uses a supplied default if that is null.

getPoolManagerPromptText

protected String getPoolManagerPromptText()

Retrieve the pool manager combo prompt text. By default, uses what we set in setPoolManagerPromptText, or uses a supplied default if that is null.

getPoolManagerToolTip

protected String getPoolManagerToolTip()

Retrieve the pool manager combo field tooltip text. By default, uses what we set in setPoolManagerToolTip, or uses a supplied default if that is null.

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

Parameters:

parent - The parent composite

See Also:

SystemWidgetHelpers

getInitialFocusControl

public Control getInitialFocusControl()

Return control to recieve initial focus

Specified by:

getInitialFocusControl in class AbstractSystemWizardPage

widgetDefaultSelected

public void widgetDefaultSelected(SelectionEvent event)

Combo selection listener method

Specified by:

widgetDefaultSelected in interface SelectionListener

widgetSelected

public void widgetSelected(SelectionEvent event)

Combo selection listener method

Specified by:

widgetSelected in interface SelectionListener

handleEvent

public void handleEvent(Event e)

Handles events generated by controls on this page.

Specified by:

handleEvent in interface Listener

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

validateNameInput

protected SystemMessage validateNameInput()

This hook method is called whenever the text changes in the input field. The default implementation delegates the request to an ISystemValidator object. If the ISystemValidator reports an error the error message is displayed in the Dialog's message line.

See Also:

setNameValidator(ISystemValidator)

setPoolNameTextLimit

protected void setPoolNameTextLimit(int mgrIndex)

Set the name length for the filter pool based on the currently selected manager

getPoolName

public String getPoolName()

Return user-entered pool name. Call this after finish ends successfully.

Specified by:

getPoolName in interface SystemFilterNewFilterPoolWizardMainPageInterface

getPoolManagerName

public String getPoolManagerName()

Return user-selected pool manager name. Call this after finish ends successfully.

Specified by:

getPoolManagerName in interface SystemFilterNewFilterPoolWizardMainPageInterface

getFilterPoolDialogOutputs

public SystemFilterPoolDialogOutputs getFilterPoolDialogOutputs()

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

Specified by:

getFilterPoolDialogOutputs in interface SystemFilterNewFilterPoolWizardMainPageInterface