Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

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

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.SystemNewFilterWizardNamePage

All Implemented Interfaces:

EventListener, IDialogPage, IMessageProvider, IWizardPage, ISystemMessageLine, ISystemWizardPage, SelectionListener, org.eclipse.swt.internal.SWTEventListener

---

public class SystemNewFilterWizardNamePage
extends 
AbstractSystemWizardPage
implements 
SelectionListener

Second page of the New Filter wizard that prompts for the name of the filter.

Since:

3.0 moved from internal to API

---

Field Summary
protected  boolean	contentsCreated
protected   SystemMessage	errorMessage
protected   ISystemFilterPoolSelectionValidator	filterPoolSelectionValidator
protected  boolean	ignoreChanges
protected   String	inputFilterName
protected   Text	nameText
protected   ISystemValidator	nameValidator
protected   ISystemValidator[]	nameValidators
protected   ISystemFilterPool	parentPool
protected   Combo	poolCombo
protected   Label	poolComboLabel
protected   ISystemFilterPool[]	poolsToSelectFrom
protected   Label	poolVerbiage
protected   Combo	poolWrapperCombo
protected   ISystemFilterPoolWrapperInformation	poolWrapperInformation
protected   ISystemFilterPoolWrapper[]	poolWrappers
protected   Button	uniqueCB
protected  boolean	userEditedName

 

Fields inherited from interface org.eclipse.jface.dialogs. IMessageProvider
ERROR, INFORMATION, NONE, WARNING

 

Constructor Summary
SystemNewFilterWizardNamePage ( SystemNewFilterWizard wizard, ISystemFilterPool parentPool, ISystemNewFilterWizardConfigurator data)           Constructor.

 

Method Summary
Control	createContents ( Composite parent)           Populate the dialog area with our widgets.
String	getFilterName ()           Return name of filter Call this after finish ends successfully.
protected   Control	getInitialFocusControl ()           Return the Control to be given initial focus.
ISystemFilterPool	getParentSystemFilterPool ()           Return the filter pool that was explicitly chosen by the user, or implicitly set by the caller.
boolean	getUniqueToThisConnection ()           Return the user's decision whether to create this filter uniquely for this connection, or for all applicable connections.
boolean	isPageComplete ()           Return true if the page is complete, so to enable Finish.
boolean	performFinish ()           Completes processing of the wizard.
void	setAllowFilterPoolSelection ( ISystemFilterPool[] poolsToSelectFrom, ISystemValidator[] nameValidators)           Call if you want to allow the user to select the filter pool to create this filter in.
void	setAllowFilterPoolSelection ( ISystemFilterPoolWrapperInformation poolWrappersToSelectFrom, ISystemValidator[] nameValidators)           This is an alternative to setAllowFilterPoolSelection(ISystemFilterPool[], ISystemValidator[]) If you want to prompt the user for the parent filter pool to create this filter in, but want to not use the term "pool" say, you can use an array of euphamisms.
void	setFilterName ( String filterName)           Set the filter name to default the entry field to
void	setFilterNameValidator ( ISystemValidator nameValidator)           Set the validator to use to verify the filter name is correct
void	setFilterPoolSelectionValidator ( ISystemFilterPoolSelectionValidator validator)           Set the validator to call when the user selects a filter pool.
void	setPageComplete ()           Inform caller of page-complete status of this page
void	setVisible (boolean visible)           This is called when a page is given focus or loses focus
protected   SystemMessage	validateNameInput ()           This hook method is called whenever the text changes in the filter name input field.
SystemMessage	verify ()           Verify all contents
void	widgetDefaultSelected ( SelectionEvent e)           User has selected something and pressed Enter
void	widgetSelected ( SelectionEvent e)           User has selected something

 

Methods inherited from class org.eclipse.rse.ui.wizards. AbstractSystemWizardPage
addFillerLine, addGrowableFillerLine, addSeparatorLine, applyMnemonics, clearErrorMessage, clearMessage, createControl, dispose, getHelpContextId, getInputObject, getMessageLine, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setFocus, setHelp, setInputObject, setMessage, setMessage, setMessage

 

Methods inherited from class org.eclipse.jface.wizard. WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setImageDescriptor, setPageComplete, setPreviousPage, setTitle, setWizard, toString

 

Methods inherited from class org.eclipse.jface.dialogs. DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, 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.messages. ISystemMessageLine
getErrorMessage, getMessage

 

Methods inherited from interface org.eclipse.jface.dialogs. IDialogPage
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp

 

Field Detail

nameText

protected 
Text nameText

---

uniqueCB

protected 
Button uniqueCB

---

poolVerbiage

protected 
Label poolVerbiage

---

poolComboLabel

protected 
Label poolComboLabel

---

poolWrapperCombo

protected 
Combo poolWrapperCombo

---

poolCombo

protected 
Combo poolCombo

---

errorMessage

protected 
SystemMessage errorMessage

---

inputFilterName

protected 
String inputFilterName

---

contentsCreated

protected boolean contentsCreated

---

userEditedName

protected boolean userEditedName

---

ignoreChanges

protected boolean ignoreChanges

---

nameValidator

protected 
ISystemValidator nameValidator

---

nameValidators

protected 
ISystemValidator[] nameValidators

---

filterPoolSelectionValidator

protected 
ISystemFilterPoolSelectionValidator filterPoolSelectionValidator

---

poolsToSelectFrom

protected 
ISystemFilterPool[] poolsToSelectFrom

---

poolWrappers

protected 
ISystemFilterPoolWrapper[] poolWrappers

---

poolWrapperInformation

protected 
ISystemFilterPoolWrapperInformation poolWrapperInformation

---

parentPool

protected 
ISystemFilterPool parentPool

Constructor Detail

SystemNewFilterWizardNamePage

public SystemNewFilterWizardNamePage(
SystemNewFilterWizard wizard,
                                     
ISystemFilterPool parentPool,
                                     
ISystemNewFilterWizardConfigurator data)

Constructor.

Method Detail

setFilterName

public void setFilterName(
String filterName)

Set the filter name to default the entry field to

---

setFilterNameValidator

public void setFilterNameValidator(
ISystemValidator nameValidator)

Set the validator to use to verify the filter name is correct

---

setAllowFilterPoolSelection

public void setAllowFilterPoolSelection(
ISystemFilterPool[] poolsToSelectFrom,
                                        
ISystemValidator[] nameValidators)

Call if you want to allow the user to select the filter pool to create this filter in.

---

setAllowFilterPoolSelection

public void setAllowFilterPoolSelection(
ISystemFilterPoolWrapperInformation poolWrappersToSelectFrom,
                                        
ISystemValidator[] nameValidators)

This is an alternative to setAllowFilterPoolSelection(ISystemFilterPool[], ISystemValidator[])

If you want to prompt the user for the parent filter pool to create this filter in, but want to not use the term "pool" say, you can use an array of euphamisms. That is, you can pass an array of objects that map to filter pools, but have a different display name that is shown in the dropdown.

Of course, if you want to do this, then you will likely want to offer a different label and tooltip for the prompt, and different verbiage above the prompt. The object this method accepts as a parameter encapsulates all that information, and there is a default class you can use for this.

---

setFilterPoolSelectionValidator

public void setFilterPoolSelectionValidator(
ISystemFilterPoolSelectionValidator validator)

Set the validator to call when the user selects a filter pool. Optional.

---

createContents

public 
Control createContents(
Composite parent)

Populate the dialog area with our widgets. Return the composite they are in.

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

---

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

Overrides:

isPageComplete in class WizardPage

---

setPageComplete

public void setPageComplete()

Inform caller of page-complete status of this page

---

widgetSelected

public void widgetSelected(
SelectionEvent e)

User has selected something

Specified by:

widgetSelected in interface SelectionListener

---

widgetDefaultSelected

public void widgetDefaultSelected(
SelectionEvent e)

User has selected something and pressed Enter

Specified by:

widgetDefaultSelected in interface SelectionListener

---

verify

public 
SystemMessage verify()

Verify all contents

---

validateNameInput

protected 
SystemMessage validateNameInput()

This hook method is called whenever the text changes in the filter name input field.

---

getFilterName

public 
String getFilterName()

Return name of filter Call this after finish ends successfully.

---

getParentSystemFilterPool

public 
ISystemFilterPool getParentSystemFilterPool()

Return the filter pool that was explicitly chosen by the user, or implicitly set by the caller.

---

getUniqueToThisConnection

public boolean getUniqueToThisConnection()

Return the user's decision whether to create this filter uniquely for this connection, or for all applicable connections.

---

setVisible

public void setVisible(boolean visible)

This is called when a page is given focus or loses focus

Specified by:

setVisible in interface IDialogPage

Overrides:

setVisible in class AbstractSystemWizardPage

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED |  FIELD |  CONSTR |  METHOD	DETAIL:  FIELD |  CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.