|
org.eclipse.rse.ui.filters.dialogs
Class SystemNewFilterWizardMainPage
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.SystemNewFilterWizardMainPage
-
All Implemented Interfaces:
-
IDialogPage,
IMessageProvider,
IWizardPage,
ISystemFilterStringEditPaneListener,
ISystemMessageLine,
ISystemWizardPage
-
public class SystemNewFilterWizardMainPage
- extends
AbstractSystemWizardPage
- implements
ISystemFilterStringEditPaneListener
Main page of the abstract "New Filter" wizard.
This page's content is supplyable in the form of an "edit pane" which
essentially is reponsible for the content area of the wizard, and
which implements necessary minimal methods for this wizard to
interact with it.
As per the design goals of the filter wizard, this page effectively
only prompts to create a single new filter string. Thus, the
edit pane needed is in fact the "new filter string" edit pane.
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,
isPageComplete,
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
|
editPane
protected
SystemFilterStringEditPane editPane
type
protected
String type
defaultFilterStrings
protected
String[] defaultFilterStrings
firstVisit
protected boolean firstVisit
SystemNewFilterWizardMainPage
public SystemNewFilterWizardMainPage(
SystemNewFilterWizard wizard,
ISystemNewFilterWizardConfigurator data)
- Constructor.
Uses the wizard page title as set in the overall wizard.
Uses a default wizard page description. Change later via setDescription if desired.
-
Parameters:
-
wizard - - the parent new filter wizard -
data - - configurable mri data
SystemNewFilterWizardMainPage
public SystemNewFilterWizardMainPage(
SystemNewFilterWizard wizard,
SystemFilterStringEditPane editPane,
ISystemNewFilterWizardConfigurator data)
- Constructor when unique edit pane supplied
Uses the wizard page title as set in the overall wizard.
Uses a default wizard page description. Change later via setDescription if desired.
-
Parameters:
-
wizard - - the parent new filter wizard -
editPane - - the edit pane that prompts the user for a single filter string -
data - - configurable mri data
setSystemFilterPoolReferenceManagerProvider
public void setSystemFilterPoolReferenceManagerProvider(
ISystemFilterPoolReferenceManagerProvider provider)
- Set the contextual system filter pool reference manager provider. Ie, in the RSE this
is the currently selected subsystem if this wizard was launched from a subsystem.
Will be non-null if the current selection is a reference to a filter pool or filter,
or a reference manager provider.
This is not used by default but made available for subclasses.
-
-
getEditPane
protected
SystemFilterStringEditPane getEditPane(
Shell shell)
- Overrride this if you want to supply your own edit pane for the filter string.
-
-
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
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
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
-
getFilterStrings
public
Vector getFilterStrings()
- Return the user-specified filter strings
-
-
getType
public
String getType()
- Get the type of filter as set by
setType(String)
-
-
setType
public void setType(
String type)
- Set the type of filter we are creating. Results in a call to setType on the new filter.
Types are not used by the base filter framework but are a way for tools to create typed
filters and have unique actions per filter type.
-
-
setDefaultFilterStrings
public void setDefaultFilterStrings(
String[] defaultFilterStrings)
- Supply the default set of filter strings this filter is to have.
-
-
filterStringChanged
public void filterStringChanged(
SystemMessage message)
- Callback method. The user has changed the filter string. It may or may not
be valid. If not, the given message is non-null. If it is, and you want it,
call getSystemFilterString() in the edit pane.
-
-
Specified by:
-
filterStringChanged
in interface
ISystemFilterStringEditPaneListener
-
backupChangedState
public void backupChangedState()
- Callback method. We are about to do a verify,the side effect of which is to
change the current state of the dialog, which we don't want. This tells the
dialog to back up that state so it can be restored.
-
-
Specified by:
-
backupChangedState
in interface
ISystemFilterStringEditPaneListener
-
restoreChangedState
public void restoreChangedState()
- Callback method. After backup and change events this is called to restore state
-
-
Specified by:
-
restoreChangedState
in interface
ISystemFilterStringEditPaneListener
-
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
-
Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.
|
|