info.textgrid.lab.collatex.ui.utils

Class SaveConfirmation

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.IconAndMessageDialog

org.eclipse.jface.dialogs.MessageDialog

info.textgrid.lab.collatex.ui.utils.SaveConfirmation

All Implemented Interfaces:

IShellProvider

public class SaveConfirmation
extends MessageDialog

Helper that asks the user to save unsaved editors.

Clients can add filters to ask only for selected editors.

Nested Class Summary

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

Window.IExceptionHandler

Field Summary

Fields inherited from class org.eclipse.jface.dialogs.MessageDialog

CONFIRM, ERROR, INFORMATION, NONE, QUESTION, QUESTION_WITH_CANCEL, WARNING

Fields inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog

imageLabel, message, messageLabel

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

Constructors

Constructor and Description
SaveConfirmation(Shell parentShell, String dialogMessage) Creates a new save confirmation.

Method Summary

Methods

Modifier and Type	Method and Description
SaveConfirmation	addFilter(com.google.common.base.Predicate<IEditorReference> filter) Adds a filter that decides whether a specific editor reference should be handled by this dialog or not.
boolean	ask() Asks the user whether the editors are to be saved.
protected void	buttonPressed(int buttonId)
protected Control	createCustomArea(Composite parent)

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

configureShell, createButton, createButtonsForButtonBar, createDialogArea, customShouldTakeFocus, getButton, getButtonLabels, getDefaultButtonIndex, getImage, getMinimumMessageWidth, handleShellCloseEvent, open, open, openConfirm, openError, openInformation, openQuestion, openWarning, setButtonLabels, setButtons

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

createButtonBar, createContents, createDialogAndButtonArea, createMessageArea, getErrorImage, getInfoImage, getMessageLabelStyle, getQuestionImage, getWarningImage

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

applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, 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, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, 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

SaveConfirmation

public SaveConfirmation(Shell parentShell,
                String dialogMessage)

Creates a new save confirmation.

Parameters:

parentShell - The parent window for the dialog

dialogMessage - The message to display above the list of open editors

Method Detail

addFilter

public SaveConfirmation addFilter(com.google.common.base.Predicate<IEditorReference> filter)

Adds a filter that decides whether a specific editor reference should be handled by this dialog or not. Multiple filters can be added, only editors which are dirty and to which all configured filters apply are handled by this dialog.

Returns:

this dialog class, use this for chaining.

createCustomArea

protected Control createCustomArea(Composite parent)

Overrides:

createCustomArea in class MessageDialog

buttonPressed

protected void buttonPressed(int buttonId)

Overrides:

buttonPressed in class MessageDialog

ask

public boolean ask()

Asks the user whether the editors are to be saved.

This method first calculates which editors are to be handled by the dialog by retrieving all open editors that are dirty and pass the filters. When this list is empty, no dialog is shown and true is returned.

Otherwise, we present the user a checkable list of editors to be saved. The user can either cancel the operation—in this case ask() returns false. Or the user can select to continue, in this case the method saves all editors from which the user has not removed the check mark in the dialog and returns true.

Returns:

true to continue, false to cancel. Note that a return value of true does not guarantee that all dirty editors have been saved.