KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > wizard > IWizardPage


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  *******************************************************************************/
11 package org.eclipse.jface.wizard;
12
13 import org.eclipse.jface.dialogs.IDialogPage;
14
15 /**
16  * Interface for a wizard page.
17  * <p>
18  * The class <code>WizardPage</code> provides an abstract implementation
19  * of this interface. However, clients are also free to implement this
20  * interface if <code>WizardPage</code> does not suit their needs.
21  * </p>
22  */
23 public interface IWizardPage extends IDialogPage {
24     /**
25      * Returns whether the next page could be displayed.
26      *
27      * @return <code>true</code> if the next page could be displayed,
28      * and <code>false</code> otherwise
29      */
30     public boolean canFlipToNextPage();
31
32     /**
33      * Returns this page's name.
34      *
35      * @return the name of this page
36      */
37     public String JavaDoc getName();
38
39     /**
40      * Returns the wizard page that would to be shown if the user was to
41      * press the Next button.
42      *
43      * @return the next wizard page, or <code>null</code> if none
44      */
45     public IWizardPage getNextPage();
46
47     /**
48      * Returns the wizard page that would to be shown if the user was to
49      * press the Back button.
50      *
51      * @return the previous wizard page, or <code>null</code> if none
52      */
53     public IWizardPage getPreviousPage();
54
55     /**
56      * Returns the wizard that hosts this wizard page.
57      *
58      * @return the wizard, or <code>null</code> if this page has not been
59      * added to any wizard
60      * @see #setWizard
61      */
62     public IWizard getWizard();
63
64     /**
65      * Returns whether this page is complete or not.
66      * <p>
67      * This information is typically used by the wizard to decide
68      * when it is okay to finish.
69      * </p>
70      *
71      * @return <code>true</code> if this page is complete, and
72      * <code>false</code> otherwise
73      */
74     public boolean isPageComplete();
75
76     /**
77      * Sets the wizard page that would typically be shown
78      * if the user was to press the Back button.
79      * <p>
80      * This method is called by the container.
81      * </p>
82      *
83      * @param page the previous wizard page
84      */
85     public void setPreviousPage(IWizardPage page);
86
87     /**
88      * Sets the wizard that hosts this wizard page.
89      * Once established, a page's wizard cannot be changed
90      * to a different wizard.
91      *
92      * @param newWizard the wizard
93      * @see #getWizard
94      */
95     public void setWizard(IWizard newWizard);
96 }
97
Popular Tags