org.eclipse.net4j.util.ui.widgets
Class BaseDialog<VIEWER extends Viewer>

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.TrayDialog
              extended by org.eclipse.jface.dialogs.TitleAreaDialog
                  extended by org.eclipse.net4j.util.ui.widgets.BaseDialog<VIEWER>
All Implemented Interfaces:
IShellProvider
Direct Known Subclasses:
CredentialsDialog, LogDialog

public abstract class BaseDialog<VIEWER extends Viewer>
extends TitleAreaDialog

Author:
Eike Stepper

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
 
Field Summary
static int DEFAULT_SHELL_STYLE
           
 
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, 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
BaseDialog(Shell parentShell, int shellStyle, String title, String message, IDialogSettings settings)
           
BaseDialog(Shell parentShell, String title, String message, IDialogSettings settings)
           
 
Method Summary
protected  void configureShell(Shell newShell)
          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 abstract  void createUI(Composite parent)
           
protected  void fillContextMenu(IMenuManager manager, VIEWER viewer)
           
 VIEWER getCurrentViewer()
           
protected  IDialogSettings getDialogBoundsSettings()
          Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy.
protected  void hookContextMenu()
           
 void setCurrentViewer(VIEWER currentViewer)
           
 
Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog
createContents, getErrorMessage, getInitialSize, getMessage, getTitleArea, getTitleImageLabel, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage
 
Methods inherited from class org.eclipse.jface.dialogs.TrayDialog
close, closeTray, createButtonBar, createHelpControl, getLayout, getTray, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonsForButtonBar, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, 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
 

Field Detail

DEFAULT_SHELL_STYLE

public static final int DEFAULT_SHELL_STYLE
See Also:
Constant Field Values
Constructor Detail

BaseDialog

public BaseDialog(Shell parentShell,
                  int shellStyle,
                  String title,
                  String message,
                  IDialogSettings settings)

BaseDialog

public BaseDialog(Shell parentShell,
                  String title,
                  String message,
                  IDialogSettings settings)
Method Detail

configureShell

protected void configureShell(Shell newShell)
Description copied from class: org.eclipse.jface.window.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:
newShell - the shell

createDialogArea

protected Control createDialogArea(Composite parent)
Description copied from class: org.eclipse.jface.dialogs.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

createUI

protected abstract void createUI(Composite parent)

getCurrentViewer

public VIEWER getCurrentViewer()

setCurrentViewer

public void setCurrentViewer(VIEWER currentViewer)

hookContextMenu

protected void hookContextMenu()

fillContextMenu

protected void fillContextMenu(IMenuManager manager,
                               VIEWER viewer)

getDialogBoundsSettings

protected IDialogSettings getDialogBoundsSettings()
Description copied from class: org.eclipse.jface.dialogs.Dialog
Gets the dialog settings that should be used for remembering the bounds of of the dialog, according to the dialog bounds strategy.

Overrides:
getDialogBoundsSettings in class Dialog
Returns:
settings the dialog settings used to store the dialog's location and/or size, or null if the dialog's bounds should never be stored.
See Also:
Dialog.getDialogBoundsStrategy()


Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.