annotate dwtx/jface/dialogs/IPageChangingListener.d @ 20:d1f4edab3f34

Page Change
author Frank Benoit <benoit@tionex.de>
date Thu, 03 Apr 2008 00:33:43 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2006, 2007 IBM Corporation and others.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * Chris Gross (schtoo@schtoo.com) - initial API and implementation for bug 16179
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * IBM Corporation - revisions to initial contribution
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Port to the D programming language:
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 * Frank Benoit <benoit@tionex.de>
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 *******************************************************************************/
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 module dwtx.jface.dialogs.IPageChangingListener;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwtx.jface.dialogs.PageChangingEvent;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.dwthelper.utils;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * A listener which is notified when the current page of a multi-page dialog is
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * changing. Use this listener to perform long-running work that should only be
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * executed once, when the page is in the process of changing, rather then
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * during validation of page controls.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * @see PageChangingEvent
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @since 3.3
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 public interface IPageChangingListener {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * Handle the an <code>IDialogPage</code> changing.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * The <code>doit</code> field of the <code>PageChangingEvent</code>
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * must be set to false to prevent the page from changing.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @param event
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * event object describing the change
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 public void handlePageChanging(PageChangingEvent event);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 }