annotate dwtx/jface/dialogs/PageChangingEvent.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.PageChangingEvent;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwtx.core.runtime.Assert;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.dwthelper.utils;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * Event object describing an <code>IDialogPage</code> in the midst of changing.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * @see IPageChangingListener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * @since 3.3
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 public class PageChangingEvent : EventObject {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 private static const long serialVersionUID = 1L;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 private Object currentPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 private Object targetPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * Public field that dictates if the page change will successfully change.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * Set this field to <code>false</code> to prevent the page from changing.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * Default value is <code>true</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 public bool doit = true;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * Creates a new event for the given source, selected (current) page and
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * direction.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * @param source
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * the page changing provider (the source of this event)
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * @param currentPage
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * the current page. In the JFace provided dialogs this will be
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * an <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param targetPage
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * the target page. In the JFace provided dialogs this will be an
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 public this(Object source, Object currentPage, Object targetPage) {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 super(source);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 Assert.isNotNull(currentPage);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 Assert.isNotNull(targetPage);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 this.currentPage = currentPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 this.targetPage = targetPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * Returns the current page from which the page change originates.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @return the current page. In dialogs implemented by JFace,
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * this will be an <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 public Object getCurrentPage() {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 return currentPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * Returns the target page to change to.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * @return the target page. In dialogs implemented by JFace,
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * this will be an <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 public Object getTargetPage() {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 return targetPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 }