annotate dwtx/jface/dialogs/PageChangedEvent.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) 2000, 2006 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 * IBM Corporation - initial API and implementation
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.dialogs.PageChangedEvent;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.dialogs.IPageChangeProvider;
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 a page selection change. The source of these events
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * is a page change provider.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * @see IPageChangeProvider
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * @see IPageChangedListener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * @since 3.1
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 public class PageChangedEvent : EventObject {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * Generated serial version UID for this class.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * @since 3.1
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 private static const long serialVersionUID = 3835149545519723574L;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * The selected page.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 protected Object selectedPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * Creates a new event for the given source and selected page.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * @param source
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * the page change provider
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * @param selectedPage
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * the selected page. In the JFace provided dialogs this
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * will be an <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 public this(IPageChangeProvider source,
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 Object selectedPage) {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 super( cast(Object) source);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 Assert.isNotNull(selectedPage);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 this.selectedPage = selectedPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * Returns the selected page.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * @return the selected page. In dialogs implemented by JFace,
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * this will be an <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 public Object getSelectedPage() {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 return selectedPage;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * Returns the page change provider that is the source of this event.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * @return the originating page change provider
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 public IPageChangeProvider getPageChangeProvider() {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 return cast(IPageChangeProvider) getSource();
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 }
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 }