Package org.eclipse.compare.internal

Class CompareDialog

java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TrayDialog
org.eclipse.compare.internal.CompareDialog
All Implemented Interfaces:
EventListener, IPropertyChangeListener, IShellProvider
public class CompareDialog extends TrayDialog implements IPropertyChangeListener
This is a dialog that can host a CompareEditorInput.

This class can be used as is or can be subclassed.

Since:
3.3

  • Constructor Details

    • CompareDialog

      public CompareDialog(Shell shell, CompareEditorInput input)
      Create a dialog to host the given input.
      Parameters:
      shell - a shell
      input - the dialog input

  • Method Details

    • 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).

      Note that in order to prevent recursive calls to this method it does not call Shell#close(). As a result ShellListeners will not receive a shellClosed event.

      Overrides:
      close in class Dialog
      Returns:
      true if the window is (or was already) closed, and false if it is still open
      See Also:

    • createButtonsForButtonBar

      protected void createButtonsForButtonBar(Composite parent)
      Description copied from class: Dialog
      Adds buttons to this dialog's button bar.

      The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

      Note: The common button order is: {other buttons}, OK, Cancel. On some platforms, Dialog.initializeBounds() will move the default button to the right.

      Overrides:
      createButtonsForButtonBar in class Dialog
      Parameters:
      parent - the button bar composite

    • isInputEditable

      protected boolean isInputEditable()
      Return whether the compare editor input of this dialog is editable. By default, the input is editable if the compare configuration indicates that either the left or right sides are editable. Subclasses may override.
      Returns:
      whether the compare editor input of this dialog is editable
      See Also:

    • propertyChange

      public void propertyChange(PropertyChangeEvent event)
      Description copied from interface: IPropertyChangeListener
      Notification that a property has changed.

      This method gets called when the observed object fires a property change event.

      Specified by:
      propertyChange in interface IPropertyChangeListener
      Parameters:
      event - the property change event object describing which property changed and how

    • createDialogArea

      protected Control createDialogArea(Composite parent2)
      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 Dialog
      Parameters:
      parent2 - the parent composite to contain the dialog area
      Returns:
      the dialog area control

    • open

      public int open()
      Description copied from class: Window
      Opens this window, creating it first if it has not yet been created.

      If this window has been configured to block on open ( setBlockOnOpen), this method waits until the window is closed by the end user, and then it returns the window's return code; otherwise, this method returns immediately. A window's return codes are window-specific, although two standard return codes are predefined: OK and CANCEL.

      Overrides:
      open in class Window
      Returns:
      the return code
      See Also:

    • buttonPressed

      protected void buttonPressed(int buttonId)
      Description copied from class: Dialog
      Notifies that this dialog's button with the given id has been pressed.

      The Dialog implementation of this framework method calls okPressed if the ok button is the pressed, and cancelPressed if the cancel button is the pressed. All other button presses are ignored. Subclasses may override to handle other buttons, but should call super.buttonPressed if the default handling of the ok and cancel buttons is desired.

      Overrides:
      buttonPressed in class Dialog
      Parameters:
      buttonId - the id of the button that was pressed (see IDialogConstants.*_ID constants)

    • getDialogBoundsSettings

      protected IDialogSettings getDialogBoundsSettings()
      Description copied from class: 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:

    • configureShell

      protected void configureShell(Shell newShell)
      Description copied from class: 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

    • getHelpContextId

      public String getHelpContextId()
      Return the help content id for this dialog or null. By default, a generic help content id is returned. Subclasses may override.
      Returns:
      the help content id for this dialog or null

    • getInitialSize

      protected Point getInitialSize()
      Description copied from class: Dialog
      Returns the initial size to use for the shell. Overridden to check whether a size has been stored in dialog settings. If a size has been stored, it is returned.
      Overrides:
      getInitialSize in class Dialog
      Returns:
      the initial size of the shell
      See Also:

    • getDefaultSize

      protected Point getDefaultSize()
      If we don't have settings we need to come up with a reasonable default since we can't depend on the compare editor input layout returning a good default size.
      Returns:
      the default size of the dialog

    • getInput

      protected final CompareEditorInput getInput()
      Return the compare editor input for this dialog.
      Returns:
      the compare editor input for this dialog