Eclipse Platform
Release 3.1

org.eclipse.debug.ui.sourcelookup
Class SourceLookupDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.Dialog
          extended byorg.eclipse.jface.dialogs.TitleAreaDialog
              extended byorg.eclipse.debug.ui.sourcelookup.SourceLookupDialog
All Implemented Interfaces:
IShellProvider

public class SourceLookupDialog
extends TitleAreaDialog

A dialog for editing the source lookup path of a source lookup director.

This class may be instantiated; it is not intended to be subclassed.

Since:
3.0

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.TitleAreaDialog
DLG_IMG_TITLE_BANNER, DLG_IMG_TITLE_ERROR, INFO_MESSAGE, WARNING_MESSAGE
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, dialogArea, DLG_IMG_ERROR, 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
SourceLookupDialog(Shell shell, ISourceLookupDirector director)
          Constructs a dialog to edit the source lookup path managed by the given source lookup director.
 
Method Summary
 boolean close()
          Closes this window, disposes its shell, and removes this window from its window manager (if it has one).
protected  void configureShell(Shell shell)
          Configures the given shell in preparation for opening this window in it.
protected  Control createDialogArea(Composite parent)
          Creates and returns the contents of the upper part of this dialog (above the button bar).
protected  Point getInitialLocation(Point initialSize)
          Returns the initial location to use for the shell.
protected  Point getInitialSize()
          The TitleAreaDialog implementation of this Window methods returns an initial size which is at least some reasonable minimum.
protected  void okPressed()
          Notifies that the ok button of this dialog has been pressed.
 
Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
createContents, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createButtonsForButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeBounds, initializeDialogUnits, 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

SourceLookupDialog

public SourceLookupDialog(Shell shell,
                          ISourceLookupDirector director)
Constructs a dialog to edit the source lookup path managed by the given source lookup director. Persists the resulting source lookup path on the launch configuration associated with the given source lookup director.

Parameters:
shell - shell to parent the dialog
director - source lookup director managing the source lookup path to be edited
Method Detail

createDialogArea

protected Control createDialogArea(Composite parent)
Description copied from class: TitleAreaDialog
Creates and returns the contents of the upper part of this dialog (above the button bar).

The Dialog implementation of this framework method creates and returns a new Composite with no margins and spacing. Subclasses should override.

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

okPressed

protected void okPressed()
Description copied from class: Dialog
Notifies that the ok button of this dialog has been pressed.

The Dialog implementation of this framework method sets this dialog's return code to Window.OK and closes the dialog. Subclasses may override.

Overrides:
okPressed in class Dialog

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

close

public boolean close()
Description copied from class: Window
Closes this window, disposes its shell, and removes this window from its window manager (if it has one).

This framework method may be extended (super.close must be called).

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

getInitialLocation

protected Point getInitialLocation(Point initialSize)
Description copied from class: Window
Returns the initial location to use for the shell. The default implementation centers the shell horizontally (1/2 of the difference to the left and 1/2 to the right) and vertically (1/3 above and 2/3 below) relative to the parent shell, or display bounds if there is no parent shell.

Overrides:
getInitialLocation in class Window
Parameters:
initialSize - the initial size of the shell, as returned by getInitialSize.
Returns:
the initial location of the shell

getInitialSize

protected Point getInitialSize()
Description copied from class: TitleAreaDialog
The TitleAreaDialog implementation of this Window methods returns an initial size which is at least some reasonable minimum.

Overrides:
getInitialSize in class TitleAreaDialog
Returns:
the initial size of the dialog

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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