01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui;
11:
12: /**
13: * Workbench parts implement or adapt to this interface to participate
14: * in actions that require a prompt for the user to provide input on
15: * what to do with unsaved data when the part is closed or the Workbench
16: * is shut down.
17: * <p>
18: * Note that if a part implements this interface, it is excluded from the
19: * common "prompt to save" dialog, and instead opens its own dialog. This may
20: * cause multiple prompts to the end user during a single user operation.
21: * Implementors should be aware that this may lead to a less than optimal
22: * user experience.
23: * </p>
24: *
25: * @since 3.1
26: */
27: public interface ISaveablePart2 extends ISaveablePart {
28:
29: /**
30: * Standard return code constant (value 0) indicating that the part
31: * needs to be saved.
32: */
33: public static final int YES = 0;
34:
35: /**
36: * Standard return code constant (value 1) indicating that the part
37: * does not need to be saved and the part should be closed.
38: */
39: public static final int NO = 1;
40:
41: /**
42: * Standard return code constant (value 2) indicating that the part
43: * does not need to be saved and the part should not be closed.
44: */
45: public static final int CANCEL = 2;
46:
47: /**
48: * Standard return code constant (value 3) indicating that the default
49: * behavior for prompting the user to save will be use.
50: */
51: public static final int DEFAULT = 3;
52:
53: /**
54: * Prompts the user for input on what to do with unsaved data.
55: * This method is only called when the part is closed or when
56: * the Workbench is shutting down.
57: * <p>
58: * Implementors are expected to open a custom dialog where the
59: * user will be able to determine what to do with the unsaved data.
60: * Implementors may also return a result of <code>DEFAULT</code>
61: * to get the default prompt handling from the Workbench.
62: * </p>
63: *
64: * @return the return code, must be either <code>YES</code>,
65: * <code>NO</code>, <code>CANCEL</code> or <code>DEFAULT</code>.
66: */
67: public int promptToSaveOnClose();
68:
69: }
|