Mercurial > projects > dwt-addons

comparison dwtx/jface/wizard/IWizardContainer.d @ 35:ef4534de0cf9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
remaining files
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Apr 2008 04:49:22 +0200
parents
children
comparison
equal deleted inserted replaced
34:b3c8e32d406f 35:ef4534de0cf9
1 /*******************************************************************************
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 *******************************************************************************/
13 module dwtx.jface.wizard.IWizardContainer;
14
15 import dwtx.jface.wizard.IWizardPage;
16
17 import dwt.widgets.Shell;
18 import dwtx.jface.operation.IRunnableContext;
19
20 /**
21 * Interface for containers that can host a wizard. It displays
22 * wizard pages, at most one of which is considered
23 * the current page. <code>getCurrentPage</code> returns the
24 * current page; <code>showPage</code> programmatically changes the
25 * the current page. Note that the pages need not all belong
26 * to the same wizard.
27 * <p>
28 * The class <code>WizardDialog</code> provides a fully functional
29 * implementation of this interface which will meet the needs of
30 * most clients. However, clients are also free to implement this
31 * interface if <code>WizardDialog</code> does not suit their needs.
32 * </p>
33 * <p>
34 * Implementors are responsible for disposing of their wizards.
35 * </p>
36 *
37 * @see dwtx.jface.wizard.IWizardContainer2
38 */
39 public interface IWizardContainer : IRunnableContext {
40 /**
41 * Returns the current wizard page for this container.
42 *
43 * @return the current wizard page, or <code>null</code> if the container
44 * is not yet showing the wizard
45 * @see #showPage
46 */
47 public IWizardPage getCurrentPage();
48
49 /**
50 * Returns the shell for this wizard container.
51 *
52 * @return the shell, or <code>null</code> if this wizard
53 * container does not have a shell
54 */
55 public Shell getShell();
56
57 /**
58 * Makes the given page visible.
59 * <p>
60 * This method should not be use for normal page
61 * sequencing (back, next) which is handled by the
62 * container itself. It may, however, be used to
63 * move to another page in response to some custom
64 * action such as double clicking in a list.
65 * </p>
66 *
67 * @param page the page to show
68 * @see #getCurrentPage
69 */
70 public void showPage(IWizardPage page);
71
72 /**
73 * Adjusts the enable state of the Back, Next, and Finish
74 * buttons to reflect the state of the currently active
75 * page in this container.
76 * <p>
77 * This method is called by the container itself
78 * when its wizard page changes and may be called
79 * by the page at other times to force a button state
80 * update.
81 * </p>
82 */
83 public void updateButtons();
84
85 /**
86 * Updates the message (or error message) shown in the message line to
87 * reflect the state of the currently active page in this container.
88 * <p>
89 * This method is called by the container itself
90 * when its wizard page changes and may be called
91 * by the page at other times to force a message
92 * update.
93 * </p>
94 */
95 public void updateMessage();
96
97 /**
98 * Updates the title bar (title, description, and image) to
99 * reflect the state of the currently active page in this container.
100 * <p>
101 * This method is called by the container itself
102 * when its wizard page changes and may be called
103 * by the page at other times to force a title bar
104 * update.
105 * </p>
106 */
107 public void updateTitleBar();
108
109 /**
110 * Updates the window title to reflect the state of the current wizard.
111 * <p>
112 * This method is called by the container itself
113 * when its wizard changes and may be called
114 * by the wizard at other times to force a window
115 * title change.
116 * </p>
117 */
118 public void updateWindowTitle();
119 }