Eclipse Platform
Release 3.3

org.eclipse.ui.dialogs
Class EditorSelectionDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.Dialog
          extended byorg.eclipse.ui.dialogs.EditorSelectionDialog
All Implemented Interfaces:
IShellProvider

public final class EditorSelectionDialog
extends Dialog

This class is used to allow the user to select a dialog from the set of internal and external editors.

Since:
3.3

Nested Class Summary
 
Nested classes 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
 
Constructor Summary
EditorSelectionDialog(Shell parentShell)
          Create an instance of this class.
 
Method Summary
protected  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 fillEditorTable()
           
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 getDialogSettings()
          Return the dialog store to cache values into
protected  IEditorDescriptor[] getExternalEditors()
          Get a list of registered programs from the OS
protected  Image[] getImages(IEditorDescriptor[] editors)
          Returns an array of images for the given array of editors
protected  IEditorDescriptor[] getInternalEditors()
          Returns the internal editors
 IEditorDescriptor getSelectedEditor()
          Return the editor the user selected
protected  void handleDoubleClickEvent()
          Handle a double click event on the list
protected  void promptForExternalEditor()
           
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
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
 void setEditorsToFilter(IEditorDescriptor[] editors)
          Set the editors which will not appear in the dialog.
 void setMessage(String aMessage)
          Set the message displayed by this message dialog
protected  void updateEnableState()
          Update enabled state.
protected  void updateOkButton()
          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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EditorSelectionDialog

public EditorSelectionDialog(Shell parentShell)
Create an instance of this class.

Parameters:
parentShell - the parent shell
Method Detail

buttonPressed

protected void buttonPressed(int buttonId)
This method is called if a button has been pressed.

Overrides:
buttonPressed in class Dialog
Parameters:
buttonId - the id of the button that was pressed (see IDialogConstants.*_ID constants)

close

public boolean close()
Close the window.

Overrides:
close in class Dialog
See Also:
Window.close()

configureShell

protected void configureShell(Shell shell)
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 class Window
Parameters:
shell - the shell

createDialogArea

protected Control createDialogArea(Composite parent)
Creates and returns the contents of the upper part of the dialog (above the button bar). Subclasses should overide.

Overrides:
createDialogArea in class Dialog
Parameters:
parent - the parent composite to contain the dialog area
Returns:
the dialog area control

fillEditorTable

protected void fillEditorTable()

getDialogSettings

protected IDialogSettings getDialogSettings()
Return the dialog store to cache values into


getExternalEditors

protected IEditorDescriptor[] getExternalEditors()
Get a list of registered programs from the OS


filterEditors

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.

Parameters:
editors - an array of editors to filter
Returns:
a filtered array of editors

getImages

protected Image[] getImages(IEditorDescriptor[] editors)
Returns an array of images for the given array of editors


getInternalEditors

protected IEditorDescriptor[] getInternalEditors()
Returns the internal editors


getSelectedEditor

public IEditorDescriptor getSelectedEditor()
Return the editor the user selected

Returns:
the selected editor

promptForExternalEditor

protected void promptForExternalEditor()

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


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

public void setMessage(String aMessage)
Set the message displayed by this message dialog

Parameters:
aMessage - the message

setEditorsToFilter

public void setEditorsToFilter(IEditorDescriptor[] editors)
Set the editors which will not appear in the dialog.

Parameters:
editors - an array of editors

updateEnableState

protected void updateEnableState()
Update enabled state.


createButtonsForButtonBar

protected void createButtonsForButtonBar(Composite parent)
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 the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

Overrides:
createButtonsForButtonBar in class Dialog
Parameters:
parent - the button bar composite

updateOkButton

protected void updateOkButton()
Update the button enablement state.


Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.