Eclipse Platform
Release 3.2

org.eclipse.debug.ui
Class InspectPopupDialog

java.lang.Object
  extended byorg.eclipse.jface.window.Window
      extended byorg.eclipse.jface.dialogs.PopupDialog
          extended byorg.eclipse.debug.ui.DebugPopup
              extended byorg.eclipse.debug.ui.InspectPopupDialog
All Implemented Interfaces:
IShellProvider

public class InspectPopupDialog
extends DebugPopup

A DebugPopup that can be used to inspect an IExpression object.

This class is not intended to be subclassed.

Note: This class subclasses PopupDialog which is currently marked as experimental API. Users should therefore consider this class to be experimental as well.

Since:
3.2

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.PopupDialog
HOVER_SHELLSTYLE, INFOPOPUP_SHELLSTYLE, INFOPOPUPRESIZE_SHELLSTYLE, POPUP_HORIZONTALSPACING, POPUP_MARGINHEIGHT, POPUP_MARGINWIDTH, POPUP_VERTICALSPACING
 
Fields inherited from class org.eclipse.jface.window.Window
CANCEL, OK
 
Constructor Summary
InspectPopupDialog(Shell shell, Point anchor, String commandId, IExpression expression)
          Creates a new inspect popup.
 
Method Summary
 boolean close()
          Closes this window, disposes its shell, and removes this window from its window manager (if it has one).
protected  Control createDialogArea(Composite parent)
          Creates and returns the contents of the dialog (the area below the title area and above the info text area.
protected  String getActionText()
          Returns the text to be shown as the action performed when this dialog's persist command is invoked, or null.
protected  Point getInitialSize()
          Returns the initial size to use for the shell.
protected  void persist()
          Persists the contents of the dialog.
 
Methods inherited from class org.eclipse.debug.ui.DebugPopup
getCommandId, getDialogSettings, getInfoText, getInitialLocation, open, wasPersisted
 
Methods inherited from class org.eclipse.jface.dialogs.PopupDialog
adjustBounds, applyBackgroundColor, applyForegroundColor, configureShell, createContents, createInfoTextArea, createTitleControl, createTitleMenuArea, fillDialogMenu, getBackgroundColorExclusions, getFocusControl, getForegroundColorExclusions, getPersistBounds, hasInfoArea, hasTitleArea, saveDialogBounds, setInfoText, setTabOrder, setTitleText, showDialogMenu
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, create, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, 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

InspectPopupDialog

public InspectPopupDialog(Shell shell,
                          Point anchor,
                          String commandId,
                          IExpression expression)
Creates a new inspect popup.

Parameters:
shell - The parent shell
anchor - point at which to anchor the popup in Display coordinates
commandId - The command id to be used for persistence of the dialog (possibly null)
expression - The expression being inspected
Method Detail

createDialogArea

protected Control createDialogArea(Composite parent)
Description copied from class: PopupDialog
Creates and returns the contents of the dialog (the area below the title area and above the info text area.

The PopupDialog 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;
 

Specified by:
createDialogArea in class DebugPopup

close

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

This method is extended to save the dialog bounds and initialize widget state so that the widgets can be recreated if the dialog is reopened. This method may be extended (super.close must be called).

Overrides:
close in class DebugPopup

getActionText

protected String getActionText()
Description copied from class: DebugPopup
Returns the text to be shown as the action performed when this dialog's persist command is invoked, or null.

Subclasses should override as necessary.

Overrides:
getActionText in class DebugPopup
Returns:
the text to be shown as the action performed when this dialog's persist command is invoked

persist

protected void persist()
Description copied from class: DebugPopup
Persists the contents of the dialog. Subclasses should override as required, but also call super.persist().

Overrides:
persist in class DebugPopup

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 PopupDialog

Eclipse Platform
Release 3.2

Guidelines for using Eclipse APIs.

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