Eclipse Platform
Release 3.1

org.eclipse.debug.ui
Class StringVariableSelectionDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.Dialog
          extended byorg.eclipse.ui.dialogs.SelectionDialog
              extended byorg.eclipse.ui.dialogs.SelectionStatusDialog
                  extended byorg.eclipse.ui.dialogs.AbstractElementListSelectionDialog
                      extended byorg.eclipse.ui.dialogs.ElementListSelectionDialog
                          extended byorg.eclipse.debug.ui.StringVariableSelectionDialog
All Implemented Interfaces:
IShellProvider

public class StringVariableSelectionDialog
extends ElementListSelectionDialog

A dialog that prompts the user to choose and configure a string substitution variable.

Clients may instantiate this class; not intended to be subclassed.

Since:
3.1

Nested Class Summary
 
Nested classes inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
 
Field Summary
 
Fields inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
fFilteredList
 
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
StringVariableSelectionDialog(Shell parent)
          Constructs a new string substitution variable selection dialog.
 
Method Summary
 boolean close()
          Closes this window, disposes its shell, and removes this window from its window manager (if it has one).
protected  void configureArgument()
          Configures the argument for the selected variable.
protected  Control createDialogArea(Composite parent)
          Creates and returns the contents of the upper part of this dialog (above the button bar).
protected  void editVariables()
           
protected  Point getInitialLocation(Point initialSize)
          Returns the initial location to use for the shell.
protected  Point getInitialSize()
          Returns the initial size to use for the shell.
 String getVariableExpression()
          Returns the variable expression the user generated from this dialog, or null if none.
protected  void handleSelectionChanged()
          Update variable description and argument button enablement.
protected  void okPressed()
          Notifies that the ok button of this dialog has been pressed.
 
Methods inherited from class org.eclipse.ui.dialogs.ElementListSelectionDialog
computeResult, setElements
 
Methods inherited from class org.eclipse.ui.dialogs.AbstractElementListSelectionDialog
cancelPressed, create, createFilteredList, createFilterText, createMessageArea, getFilter, getFoldedElements, getSelectedElements, getSelectionIndex, getSelectionIndices, handleDefaultSelected, handleEmptyList, isCaseIgnored, open, setAllowDuplicates, setEmptyListMessage, setEmptySelectionMessage, setFilter, setIgnoreCase, setListElements, setMatchEmptyString, setMultipleSelection, setSelection, setSize, setValidator, updateOkState, validateCurrentSelection
 
Methods inherited from class org.eclipse.ui.dialogs.SelectionStatusDialog
configureShell, createButtonBar, getFirstResult, setImage, setResult, setStatusLineAboveButtons, updateButtonsEnableState, updateStatus
 
Methods inherited from class org.eclipse.ui.dialogs.SelectionDialog
createButtonsForButtonBar, getInitialElementSelections, getInitialSelections, getMessage, getOkButton, getResult, setInitialElementSelections, setInitialSelections, setMessage, setResult, setSelectionResult, setTitle
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createContents, 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, 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

StringVariableSelectionDialog

public StringVariableSelectionDialog(Shell parent)
Constructs a new string substitution variable selection dialog.

Parameters:
parent - parent shell
Method Detail

getVariableExpression

public String getVariableExpression()
Returns the variable expression the user generated from this dialog, or null if none.

Returns:
variable expression the user generated from this dialog, or null if none

createDialogArea

protected Control createDialogArea(Composite parent)
Description copied from class: Dialog
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 standard margins and spacing.

The returned control's layout data must be an instance of GridData. This method must not modify the parent's layout.

Subclasses must override this method but may call super as in the following example:

 Composite composite = (Composite) super.createDialogArea(parent);
 //add controls to composite as necessary
 return composite;
 

Overrides:
createDialogArea in class ElementListSelectionDialog

editVariables

protected void editVariables()

configureArgument

protected void configureArgument()
Configures the argument for the selected variable.


handleSelectionChanged

protected void handleSelectionChanged()
Update variable description and argument button enablement.

Overrides:
handleSelectionChanged in class AbstractElementListSelectionDialog
See Also:
AbstractElementListSelectionDialog.handleSelectionChanged()

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 SelectionStatusDialog

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: Window
Returns the initial size to use for the shell. The default implementation returns the preferred size of the shell, using Shell.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).

Overrides:
getInitialSize in class Window
Returns:
the initial size of 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()

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

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