Package org.eclipse.tracecompass.tmf.ui.symbols

Class SymbolProviderConfigDialog

java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.jface.dialogs.TitleAreaDialog
org.eclipse.tracecompass.tmf.ui.symbols.SymbolProviderConfigDialog
All Implemented Interfaces:
org.eclipse.jface.preference.IPreferencePageContainer, org.eclipse.jface.window.IShellProvider
public class SymbolProviderConfigDialog extends org.eclipse.jface.dialogs.TitleAreaDialog implements org.eclipse.jface.preference.IPreferencePageContainer
This class shall be used to configure one or more ISymbolProvider. It receives an array of ISymbolProviderPreferencePage and creates a dialog that can be used to configure the corresponding providers. If the Window.open() method exits with IDialogConstants.OK_ID the caller shall assume that the corresponding ISymbolProvider's have a new configuration.
Since:
2.0
Author:
Robert Kiss

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

    org.eclipse.jface.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, 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    SymbolProviderConfigDialog(org.eclipse.swt.widgets.Shell parentShell, ISymbolProviderPreferencePage... pages)
    Create a new dialog that will use the given shall and preference pages.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.jface.preference.IPreferenceStore
    getPreferenceStore()
     
    boolean
    isHelpAvailable()
     
    void
    updateButtons()
     
    void
    updateMessage()
     
    void
    updateTitle()
     

    Methods inherited from class org.eclipse.jface.dialogs.TitleAreaDialog

    getErrorMessage, getMessage, setErrorMessage, setMessage, setMessage, setTitle, setTitleAreaColor, setTitleImage

    Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

    closeTray, getTray, isDialogHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

    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

  • Constructor Details

    • SymbolProviderConfigDialog

      public SymbolProviderConfigDialog(org.eclipse.swt.widgets.Shell parentShell, ISymbolProviderPreferencePage... pages)
      Create a new dialog that will use the given shall and preference pages.
      Parameters:
      parentShell - The parent shell
      pages - the pages that provides the configuration UI for ISymbolProvider's. The array shall not be empty and shall not contain null elements.

  • Method Details

    • isHelpAvailable

      public boolean isHelpAvailable()
      Overrides:
      isHelpAvailable in class org.eclipse.jface.dialogs.TrayDialog

    • getPreferenceStore

      public org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()
      Specified by:
      getPreferenceStore in interface org.eclipse.jface.preference.IPreferencePageContainer

    • updateTitle

      public void updateTitle()
      Specified by:
      updateTitle in interface org.eclipse.jface.preference.IPreferencePageContainer

    • updateButtons

      public void updateButtons()
      Specified by:
      updateButtons in interface org.eclipse.jface.preference.IPreferencePageContainer

    • updateMessage

      public void updateMessage()
      Specified by:
      updateMessage in interface org.eclipse.jface.preference.IPreferencePageContainer