org.eclipse.rse.ui.dialogs
Class SystemSelectFileTypesDialog

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SystemSearchSelectFileTypesDialog

public class SystemSelectFileTypesDialog

extends SystemPromptDialog

implements ISystemMessageLine

A public implementation of the eclipse Select Types dialog.

File types are extension names without the dot. For example "java" and "class".

Call getResult() to get the array of selected types.

Nested Class Summary

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

Window.IExceptionHandler

Field Summary

protected IFileEditorMapping[]	currentInput
protected Collection	initialSelections
protected String	instruction
protected CheckboxTableViewer	listViewer
protected Object[]	result
protected static int	SIZING_SELECTION_WIDGET_HEIGHT
protected static int	SIZING_SELECTION_WIDGET_WIDTH
protected static String	TYPE_DELIMITER
protected Text	userDefinedText

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

SystemSelectFileTypesDialog(Shell shell)
Constructor when there are no existing types

SystemSelectFileTypesDialog(Shell shell, Collection currentTypes)
Constructor when there are existing types.

SystemSelectFileTypesDialog(Shell shell, String[] currentTypes)
Constructor when there are existing types.

Method Summary

protected void	addUserDefinedEntries(List result) Add the currently-specified extensions.
protected void	checkInitialSelections() Visually checks the previously-specified elements in this dialog's list viewer.
protected Control	createInner(Composite parent) Method declared on Dialog.
protected Label	createInstructionArea(Composite composite) Creates the message area for this dialog.
protected Control	getInitialFocusControl() Return the Control to be given initial focus.
protected IFileEditorMapping[]	getInput() Return the input to the dialog.
Object[]	getResult() Returns the list of selections made by the user, or null if the selection was canceled.
protected boolean	processOK() User pressed OK.
void	setInstruction(String instr) Sets the instruction text for this dialog.
protected void	setResult(List newResult) Set the selections made by the user, or null if the selection was canceled.
protected boolean	validateFileType(String filename) Validate the user input for a file type

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, processCancel, 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, setPageComplete, 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

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

clearErrorMessage, clearMessage, getErrorMessage, getMessage, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setMessage, setMessage

Field Detail

initialSelections

protected Collection initialSelections

instruction

protected String instruction

result

protected Object[] result

listViewer

protected CheckboxTableViewer listViewer

SIZING_SELECTION_WIDGET_HEIGHT

protected static final int SIZING_SELECTION_WIDGET_HEIGHT

See Also:

Constant Field Values

SIZING_SELECTION_WIDGET_WIDTH

protected static final int SIZING_SELECTION_WIDGET_WIDTH

See Also:

Constant Field Values

TYPE_DELIMITER

protected static final String TYPE_DELIMITER

userDefinedText

protected Text userDefinedText

currentInput

protected IFileEditorMapping[] currentInput

Constructor Detail

SystemSelectFileTypesDialog

public SystemSelectFileTypesDialog(Shell shell)

Constructor when there are no existing types

Parameters:

shell - The window hosting this dialog

SystemSelectFileTypesDialog

public SystemSelectFileTypesDialog(Shell shell,
                                   Collection currentTypes)

Constructor when there are existing types.

Parameters:

shell - The window hosting this dialog

currentTypes - The current types as a java.util.Collection. Typically ArrayList is used

SystemSelectFileTypesDialog

public SystemSelectFileTypesDialog(Shell shell,
                                   String[] currentTypes)

Constructor when there are existing types.

Parameters:

shell - The window hosting this dialog

currentTypes - The current types as an array of Strings

Method Detail

createInner

protected Control createInner(Composite parent)

Method declared on Dialog.

Specified by:

createInner in class SystemPromptDialog

getInitialFocusControl

protected Control getInitialFocusControl()

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

Specified by:

getInitialFocusControl in class SystemPromptDialog

setInstruction

public void setInstruction(String instr)

Sets the instruction text for this dialog.

Parameters:

instr - the instruction text

createInstructionArea

protected Label createInstructionArea(Composite composite)

Creates the message area for this dialog.

This method is provided to allow subclasses to decide where the message will appear on the screen.

Returns:

the message label

addUserDefinedEntries

protected void addUserDefinedEntries(List result)

Add the currently-specified extensions.

checkInitialSelections

protected void checkInitialSelections()

Visually checks the previously-specified elements in this dialog's list viewer.

getInput

protected IFileEditorMapping[] getInput()

Return the input to the dialog.

processOK

protected boolean processOK()

User pressed OK.

Overrides:

processOK in class SystemPromptDialog

setResult

protected void setResult(List newResult)

Set the selections made by the user, or null if the selection was canceled.

validateFileType

protected boolean validateFileType(String filename)

Validate the user input for a file type

getResult

public Object[] getResult()

Returns the list of selections made by the user, or null if the selection was canceled.

Returns:

the array of selected elements, or null if Cancel was pressed