|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.rse.ui.wizards.AbstractSystemWizardPage
org.eclipse.rse.ui.filters.dialogs.SystemNewFilterWizardNamePage
public class SystemNewFilterWizardNamePage
Second page of the New Filter wizard that prompts for the name of the filter.
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 |
---|
protected Text nameText
protected Button uniqueCB
protected Label poolVerbiage
protected Label poolComboLabel
protected Combo poolWrapperCombo
protected Combo poolCombo
protected SystemMessage errorMessage
protected String inputFilterName
protected boolean contentsCreated
protected boolean userEditedName
protected boolean ignoreChanges
protected ISystemValidator nameValidator
protected ISystemValidator[] nameValidators
protected ISystemFilterPoolSelectionValidator filterPoolSelectionValidator
protected ISystemFilterPool[] poolsToSelectFrom
protected ISystemFilterPoolWrapper[] poolWrappers
protected ISystemFilterPoolWrapperInformation poolWrapperInformation
protected ISystemFilterPool parentPool
Constructor Detail |
---|
public SystemNewFilterWizardNamePage(SystemNewFilterWizard wizard, ISystemFilterPool parentPool, ISystemNewFilterWizardConfigurator data)
Method Detail |
---|
public void setFilterName(String filterName)
public void setFilterNameValidator(ISystemValidator nameValidator)
public void setAllowFilterPoolSelection(ISystemFilterPool[] poolsToSelectFrom, ISystemValidator[] nameValidators)
public void setAllowFilterPoolSelection(ISystemFilterPoolWrapperInformation poolWrappersToSelectFrom, ISystemValidator[] nameValidators)
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.
public void setFilterPoolSelectionValidator(ISystemFilterPoolSelectionValidator validator)
public Control createContents(Composite parent)
createContents
in class AbstractSystemWizardPage
SystemWidgetHelpers
protected Control getInitialFocusControl()
getInitialFocusControl
in class AbstractSystemWizardPage
public boolean performFinish()
performFinish
in interface ISystemWizardPage
performFinish
in class AbstractSystemWizardPage
public boolean isPageComplete()
isPageComplete
in interface IWizardPage
isPageComplete
in class WizardPage
public void setPageComplete()
public void widgetSelected(SelectionEvent e)
widgetSelected
in interface SelectionListener
public void widgetDefaultSelected(SelectionEvent e)
widgetDefaultSelected
in interface SelectionListener
public SystemMessage verify()
protected SystemMessage validateNameInput()
public String getFilterName()
public ISystemFilterPool getParentSystemFilterPool()
public boolean getUniqueToThisConnection()
public void setVisible(boolean visible)
setVisible
in interface IDialogPage
setVisible
in class AbstractSystemWizardPage
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |