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

java.lang.Object
  org.eclipse.jface.window.Window
      org.eclipse.jface.dialogs.Dialog
          org.eclipse.rse.ui.dialogs.SystemPromptDialog
              org.eclipse.rse.ui.filters.dialogs.SystemUnNamedFilterDialog

All Implemented Interfaces:

IDialogConstants, IDialogPage, IRunnableContext, IShellProvider, ISystemFilterStringEditPaneListener, ISystemMessageLine, ISystemPromptDialog, Listener, Runnable

public class SystemUnNamedFilterDialog

extends SystemPromptDialog

implements ISystemFilterStringEditPaneListener

A dialog that prompts the user for a single filter string, but not for the purpose of creating a named filter. The output is that single filter string, and the caller can do what they want with it.

Nested Class Summary

Nested classes inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

protected SystemFilterStringEditPane	editpane
protected String	outputFilterString
protected ISystemFilterPoolReferenceManagerProvider	provider

Fields inherited from class org.eclipse.rse.ui.dialogs.SystemPromptDialog

activeRunningOperations, ADD_BUTTON_NO, ADD_BUTTON_YES, ADD_ID, addButton, arrowCursor, BROWSE_BUTTON_NO, BROWSE_BUTTON_YES, BROWSE_ID, browseButton, buttonsComposite, CANCEL_ALL_ID, cancelAllButton, cancelAllPressed, cancelButton, cancelListener, DETAILS_BUTTON_NO, DETAILS_BUTTON_YES, DETAILS_ID, detailsButton, detailsButtonHideMode, detailsHideLabel, detailsShowLabel, dialogAreaComposite, dialogMnemonics, fMessageLine, helpId, horizontalSpacing, initialAddButtonEnabledState, initialDetailsButtonEnabledState, initialOKButtonEnabledState, inputObject, labelAdd, labelBrowse, labelCancel, labelCancelAll, labelDetailsHide, labelDetailsShow, labelOk, labelTest, marginHeight, marginWidth, minHeight, minWidth, needsProgressMonitor, noShowAgainButton, noShowAgainOption, okButton, okPressed, operationCancelableState, outputObject, outputObjectValidator, overallShell, pack, parentComposite, pendingErrorMessage, pendingMessage, prefId, prefStore, prefValAsSelected, progressMonitorPart, showAddButton, showBrowseButton, showCancelAllButton, showDetailsButton, showOkButton, showTestButton, TEST_BUTTON_NO, TEST_BUTTON_YES, TEST_ID, testButton, tipAdd, tipBrowse, tipCancel, tipCancelAll, tipDetailsHide, tipDetailsShow, tipOk, tipTest, title, titleImage, verticalSpacing, waitCursor, windowClosingDialog

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK

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

ABORT_ID, ABORT_LABEL, BACK_ID, BACK_LABEL, BUTTON_BAR_HEIGHT, BUTTON_HEIGHT, BUTTON_MARGIN, BUTTON_WIDTH, CANCEL_ID, CANCEL_LABEL, CLIENT_ID, CLOSE_ID, CLOSE_LABEL, DESELECT_ALL_ID, ENTRY_FIELD_WIDTH, FINISH_ID, FINISH_LABEL, HELP_ID, HELP_LABEL, HIDE_DETAILS_LABEL, HORIZONTAL_MARGIN, HORIZONTAL_SPACING, IGNORE_ID, IGNORE_LABEL, INDENT, INTERNAL_ID, LEFT_MARGIN, MINIMUM_MESSAGE_AREA_WIDTH, NEXT_ID, NEXT_LABEL, NO_ID, NO_LABEL, NO_TO_ALL_ID, NO_TO_ALL_LABEL, OK_ID, OK_LABEL, OPEN_ID, OPEN_LABEL, PROCEED_ID, PROCEED_LABEL, RETRY_ID, RETRY_LABEL, SELECT_ALL_ID, SELECT_TYPES_ID, SHOW_DETAILS_LABEL, SKIP_ID, SKIP_LABEL, SMALL_INDENT, STOP_ID, STOP_LABEL, VERTICAL_MARGIN, VERTICAL_SPACING, YES_ID, YES_LABEL, YES_TO_ALL_ID, YES_TO_ALL_LABEL

Constructor Summary

SystemUnNamedFilterDialog(Shell shell)
Constructor

SystemUnNamedFilterDialog(Shell shell, String title)
Constructor, when unique title desired

Method Summary

void	backupChangedState() Callback method.
protected Control	createInner(Composite parent) Called by createContents method.
void	filterStringChanged(SystemMessage message) Callback method.
String	getFilterString() Return the string the user configured in this dialog.
protected SystemFilterStringEditPane	getFilterStringEditPane(Shell shell) Return our edit pane.
protected Control	getInitialFocusControl() Return the Control to be given initial focus.
protected boolean	processCancel() Parent override.
protected boolean	processOK() Parent override.
void	restoreChangedState() Callback method.
void	setFilterStringEditPane(SystemFilterStringEditPane editPane) Specify an edit pane that prompts the user for the contents of a filter string.
protected void	setHelp() Overridable extension point for setting dialog help.
void	setPageComplete(boolean complete) Override of parent method so we can direct it to the Apply button versus the OK button
void	setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider) Set the contextual system filter pool reference manager provider.

Methods inherited from class org.eclipse.rse.ui.dialogs.SystemPromptDialog

aboutToStart, addFillerLine, addGrowableFillerLine, addSeparatorLine, adjustButtonWidth, applyMnemonics, buttonPressed, clearErrorMessage, clearMessage, close, configureShell, createButtonBar, createButtonsForButtonBar, createContents, createControl, createDialogArea, createMessageLine, createNoShowAgainButton, createWizardClosingDialog, dispose, enableAddButton, enableBrowseButton, enableCancelAllButton, enableCancelButton, enableDetailsButton, enableOkButton, enableTestButton, getAddButton, getBrowseButton, getCancelAllButton, getCancelOrCloseButton, getControl, getDescription, getDetailsButton, getDialogMnemonics, getErrorMessage, getHelpContextId, getImage, getInputObject, getMessage, getMessageLine, getOkButton, getOutputObject, getOutputObjectValidator, getProgressMonitor, getSystemErrorMessage, getTestButton, getTitle, handleEvent, hardClose, okToClose, pack, performHelp, processAdd, processBrowse, processCancelAll, processDetails, processTest, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, restoreEnableState, restoreUIState, run, run, saveEnableStateAndSet, saveUIState, setAddButtonLabel, setAddButtonToolTipText, setBrowseButtonLabel, setBrowseButtonToolTipText, setBusyCursor, setCancelAllButtonLabel, setCancelAllButtonToolTipText, setCancelButtonLabel, setCancelButtonToolTipText, setControl, setDescription, setDetailsButtonLabel, setDetailsButtonToolTipText, setDisplayCursor, setDisplayCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setHelp, setImageDescriptor, setInitialOKButtonEnabledState, setInputObject, setMessage, setMessage, setMinimumSize, setNeedsProgressMonitor, setNoShowAgainOption, setOkButtonLabel, setOkButtonToolTipText, setOutputObject, setOutputObjectValidator, setShowAddButton, setShowBrowseButton, setShowCancelAllButton, setShowDetailsButton, setShowOkButton, setShowTestButton, setTestButtonLabel, setTestButtonToolTipText, setTitle, setVisible, wasCancelled, wasCancelledAll

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

editpane

protected SystemFilterStringEditPane editpane

outputFilterString

protected String outputFilterString

provider

protected ISystemFilterPoolReferenceManagerProvider provider

Constructor Detail

SystemUnNamedFilterDialog

public SystemUnNamedFilterDialog(Shell shell)

Constructor

SystemUnNamedFilterDialog

public SystemUnNamedFilterDialog(Shell shell,
                                 String title)

Constructor, when unique title desired

Method Detail

setHelp

protected void setHelp()

Overridable extension point for setting dialog help. By default, there is no help

setSystemFilterPoolReferenceManagerProvider

public void setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider)

Set the contextual system filter pool reference manager provider. Eg, in the RSE, this will be the selected subsystem if the New Filter action is launched from there, or if launched from a filter pool reference under there.

Will be non-null if the current selection is a reference to a filter pool or filter, or a reference manager provider.

This is passed into the filter and filter string wizards and dialogs in case it is needed for context.

setFilterStringEditPane

public void setFilterStringEditPane(SystemFilterStringEditPane editPane)

Specify an edit pane that prompts the user for the contents of a filter string.

getFilterString

public String getFilterString()

Return the string the user configured in this dialog. Will return null if the user cancelled the dialog, so test with wasCancelled().

getInitialFocusControl

protected Control getInitialFocusControl()

Description copied from class: SystemPromptDialog

Return the Control to be given initial focus. Child classes must override this, but can return null.

Specified by:

getInitialFocusControl in class SystemPromptDialog

See Also:

SystemPromptDialog.getInitialFocusControl()

createInner

protected Control createInner(Composite parent)

Description copied from class: SystemPromptDialog

Called by createContents method. Create this dialog's widgets inside a composite. Child classes must override this.

Specified by:

createInner in class SystemPromptDialog

See Also:

SystemPromptDialog.createInner(Composite)

getFilterStringEditPane

protected SystemFilterStringEditPane getFilterStringEditPane(Shell shell)

Return our edit pane. Overriding this is an alternative to calling setEditPane. This is called in createContents

processOK

protected boolean processOK()

Parent override. Called when user presses OK button. This is when we save all the changes the user made.

Overrides:

processOK in class SystemPromptDialog

processCancel

protected boolean processCancel()

Parent override. Called when user presses CLOSE button. We simply blow away all their changes!

Overrides:

processCancel in class SystemPromptDialog

setPageComplete

public void setPageComplete(boolean complete)

Override of parent method so we can direct it to the Apply button versus the OK button

Overrides:

setPageComplete in class SystemPromptDialog

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