Class EditorSelectionDialog
- All Implemented Interfaces:
IShellProvider
- Direct Known Subclasses:
LargeFileLimitsPreferenceHandler.LargeFileEditorSelectionDialog
- Since:
- 3.3
- Restriction:
- This class is not intended to be subclassed by clients.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
-
Field Summary
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, resizeHasOccurred
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
buttonPressed
(int buttonId) This method is called if a button has been pressed.boolean
close()
Close the window.protected void
configureShell
(Shell shell) Configures the given shell in preparation for opening this window in it.protected void
createButtonsForButtonBar
(Composite parent) Adds buttons to this dialog's button bar.protected Control
createDialogArea
(Composite parent) Creates and returns the contents of the upper part of the dialog (above the button bar).protected void
Fills the editor table.protected IEditorDescriptor[]
filterEditors
(IEditorDescriptor[] editors) Returns an array of editors which have been filtered according to the array of editors in the editorsToFilter instance variable.protected IDialogSettings
Return the dialog store to cache values intoprotected IEditorDescriptor[]
Get a list of registered programs from the OSprotected IEditorDescriptor[]
Returns the internal editorsReturn the editor the user selectedprotected void
Handle a double click event on the listprotected boolean
Returns a boolean indicating whether the dialog should be considered resizable when the shell style is initially set.protected void
Opens the prompt to select an external editor.protected void
Use the dialog store to restore widget values to the values that they held last time this wizard was used to completion, if the previous file has same extension.protected void
Since Finish was pressed, write widget values to the dialog store so that they will persist into the next invocation of this wizard pagevoid
setEditorsToFilter
(IEditorDescriptor[] editors) Set the editors which will not appear in the dialog.void
setFileName
(String fileName) Set the file name which can be used to store the selected editor preferencevoid
setMessage
(String aMessage) Set the message displayed by this message dialogprotected void
Update enabled state.protected void
Update the button enablement state.Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createContents, 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
-
Field Details
-
STORE_ID_INTERNAL_EXTERNAL
For internal use only.- Since:
- 3.7
- See Also:
- Restriction:
- This field is not intended to be referenced by clients.
-
-
Constructor Details
-
EditorSelectionDialog
Create an instance of this class.- Parameters:
parentShell
- the parent shell
-
-
Method Details
-
buttonPressed
protected void buttonPressed(int buttonId) This method is called if a button has been pressed.- Overrides:
buttonPressed
in classDialog
- Parameters:
buttonId
- the id of the button that was pressed (seeIDialogConstants.*_ID
constants)
-
close
public boolean close()Close the window. -
configureShell
Description copied from class:Window
Configures the given shell in preparation for opening this window in it.The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.
- Overrides:
configureShell
in classWindow
- Parameters:
shell
- the shell
-
createDialogArea
Creates and returns the contents of the upper part of the dialog (above the button bar). Subclasses should overide.- Overrides:
createDialogArea
in classDialog
- Parameters:
parent
- the parent composite to contain the dialog area- Returns:
- the dialog area control
-
fillEditorTable
protected void fillEditorTable()Fills the editor table. -
getDialogSettings
Return the dialog store to cache values into -
getExternalEditors
Get a list of registered programs from the OS -
filterEditors
Returns an array of editors which have been filtered according to the array of editors in the editorsToFilter instance variable.- Parameters:
editors
- an array of editors to filter- Returns:
- a filtered array of editors
-
getInternalEditors
Returns the internal editors -
getSelectedEditor
Return the editor the user selected- Returns:
- the selected editor
-
promptForExternalEditor
protected void promptForExternalEditor()Opens the prompt to select an external editor. -
handleDoubleClickEvent
protected void handleDoubleClickEvent()Handle a double click event on the list -
restoreWidgetValues
protected void restoreWidgetValues()Use the dialog store to restore widget values to the values that they held last time this wizard was used to completion, if the previous file has same extension. -
saveWidgetValues
protected void saveWidgetValues()Since Finish was pressed, write widget values to the dialog store so that they will persist into the next invocation of this wizard page -
setMessage
Set the message displayed by this message dialog- Parameters:
aMessage
- the message
-
setFileName
Set the file name which can be used to store the selected editor preference- Parameters:
fileName
- the file name- Since:
- 3.107
-
setEditorsToFilter
Set the editors which will not appear in the dialog.- Parameters:
editors
- an array of editors
-
updateEnableState
protected void updateEnableState()Update enabled state. -
createButtonsForButtonBar
Description copied from class:Dialog
Adds buttons to this dialog's button bar.The
Dialog
implementation of this framework method adds standard ok and cancel buttons using thecreateButton
framework method. These standard buttons will be accessible fromgetCancelButton
, andgetOKButton
. Subclasses may override.Note: The common button order is: {other buttons}, OK, Cancel. On some platforms,
Dialog.initializeBounds()
will move the default button to the right.- Overrides:
createButtonsForButtonBar
in classDialog
- Parameters:
parent
- the button bar composite
-
updateOkButton
protected void updateOkButton()Update the button enablement state. -
isResizable
protected boolean isResizable()Description copied from class:Dialog
Returns a boolean indicating whether the dialog should be considered resizable when the shell style is initially set.This method is used to ensure that all style bits appropriate for resizable dialogs are added to the shell style. Individual dialogs may always set the shell style to ensure that a dialog is resizable, but using this method ensures that resizable dialogs will be created with the same set of style bits.
Style bits will never be removed based on the return value of this method. For example, if a dialog returns
false
, but also sets a style bit for a SWT.RESIZE border, the style bit will be honored.- Overrides:
isResizable
in classDialog
- Returns:
- a boolean indicating whether the dialog is resizable and should have the default style bits for resizable dialogs
-