org.eclipse.cdt.internal.ui.dialogs
Class OptionalMessageDialog

java.lang.Object
  extended by org.eclipse.jface.window.Window
      extended by org.eclipse.jface.dialogs.Dialog
          extended by org.eclipse.jface.dialogs.IconAndMessageDialog
              extended by org.eclipse.jface.dialogs.MessageDialog
                  extended by org.eclipse.cdt.internal.ui.dialogs.OptionalMessageDialog
All Implemented Interfaces:
org.eclipse.jface.window.IShellProvider

public class OptionalMessageDialog
extends org.eclipse.jface.dialogs.MessageDialog

This is a MessageDialog which allows the user to choose that the dialog isn't shown again the next time.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window
org.eclipse.jface.window.Window.IExceptionHandler
 
Field Summary
static int NOT_SHOWN
           
 
Fields inherited from class org.eclipse.jface.dialogs.MessageDialog
ERROR, INFORMATION, NONE, QUESTION, WARNING
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, 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
 
Method Summary
static void clearAllRememberedStates()
          Clears all remembered information about hidden dialogs
static boolean isDialogEnabled(java.lang.String key)
          Answers whether the optional dialog is enabled and should be shown.
static int open(java.lang.String id, org.eclipse.swt.widgets.Shell parent, java.lang.String title, org.eclipse.swt.graphics.Image titleImage, java.lang.String message, int dialogType, java.lang.String[] buttonLabels, int defaultButtonIndex)
          Opens the dialog but only if the user hasn't choosen to hide it.
static void setDialogEnabled(java.lang.String key, boolean isEnabled)
          Sets whether the optional dialog is enabled and should be shown.
 
Methods inherited from class org.eclipse.jface.dialogs.MessageDialog
getImage, openConfirm, openError, openInformation, openQuestion, openWarning
 
Methods inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog
getErrorImage, getInfoImage, getQuestionImage, getWarningImage
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, close, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, create, getBlockedHandler, getImage, setBlockedHandler, shortenText
 
Methods inherited from class org.eclipse.jface.window.Window
getDefaultImage, getDefaultImages, getDefaultOrientation, getReturnCode, getShell, getWindowManager, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setWindowManager
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NOT_SHOWN

public static final int NOT_SHOWN
See Also:
Constant Field Values
Method Detail

open

public static int open(java.lang.String id,
                       org.eclipse.swt.widgets.Shell parent,
                       java.lang.String title,
                       org.eclipse.swt.graphics.Image titleImage,
                       java.lang.String message,
                       int dialogType,
                       java.lang.String[] buttonLabels,
                       int defaultButtonIndex)
Opens the dialog but only if the user hasn't choosen to hide it. Returns NOT_SHOWN if the dialog was not shown.


isDialogEnabled

public static boolean isDialogEnabled(java.lang.String key)
Answers whether the optional dialog is enabled and should be shown.


setDialogEnabled

public static void setDialogEnabled(java.lang.String key,
                                    boolean isEnabled)
Sets whether the optional dialog is enabled and should be shown.


clearAllRememberedStates

public static void clearAllRememberedStates()
Clears all remembered information about hidden dialogs