Java Doc for Wizard.java in » IDE-Eclipse » jface » org » eclipse » jface » wizard » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » jface » org.eclipse.jface.wizard

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.jface.wizard .Wizard

Wizard

abstract public class Wizard implements IWizard(Code)

An abstract base implementation of a wizard. A typical client subclasses Wizard to implement a particular wizard.

Subclasses may call the following methods to configure the wizard:

addPage
setHelpAvailable
setDefaultPageImageDescriptor
setDialogSettings
setNeedsProgressMonitor
setTitleBarColor
setWindowTitle

Subclasses may override these methods if required:

reimplement createPageControls
reimplement performCancel
extend addPages
reimplement performFinish
extend dispose

Note that clients are free to implement IWizard from scratch instead of subclassing Wizard. Correct implementations of IWizard will work with any correct implementation of IWizardPage.

Field Summary
final public static String	DEFAULT_IMAGE Image registry key of the default image for wizard pages (value `"org.eclipse.jface.wizard.Wizard.pageImage"`).

Constructor Summary
protected	Wizard() Creates a new empty wizard.

Method Summary
public void	addPage(IWizardPage page) Adds a new page to this wizard.
public void	addPages() The `Wizard` implementation of this `IWizard` method does nothing.
public boolean	canFinish()
public void	createPageControls(Composite pageContainer) The `Wizard` implementation of this `IWizard` method creates all the pages controls using `IDialogPage.createControl`.
public void	dispose() The `Wizard` implementation of this `IWizard` method disposes all the pages controls using `DialogPage.dispose`.
public IWizardContainer	getContainer()
public Image	getDefaultPageImage()
public IDialogSettings	getDialogSettings()
public IWizardPage	getNextPage(IWizardPage page)
public IWizardPage	getPage(String name)
public int	getPageCount()
public IWizardPage[]	getPages()
public IWizardPage	getPreviousPage(IWizardPage page)
public Shell	getShell() Returns the wizard's shell if the wizard is visible.
public IWizardPage	getStartingPage()
public RGB	getTitleBarColor()
public String	getWindowTitle()
public boolean	isHelpAvailable()
public boolean	needsPreviousAndNextButtons()
public boolean	needsProgressMonitor()
public boolean	performCancel() The `Wizard` implementation of this `IWizard` method does nothing and returns `true`.
abstract public boolean	performFinish() Subclasses must implement this `IWizard` method to perform any special finish processing for their wizard.
public void	setContainer(IWizardContainer wizardContainer)
public void	setDefaultPageImageDescriptor(ImageDescriptor imageDescriptor) Sets the default page image descriptor for this wizard.
public void	setDialogSettings(IDialogSettings settings) Sets the dialog settings for this wizard.
public void	setForcePreviousAndNextButtons(boolean b) Controls whether the wizard needs Previous and Next buttons even if it currently contains only one page.
public void	setHelpAvailable(boolean b) Sets whether help is available for this wizard.
public void	setNeedsProgressMonitor(boolean b) Sets whether this wizard needs a progress monitor.
public void	setTitleBarColor(RGB color) Sets the title bar color for this wizard.
public void	setWindowTitle(String newTitle) Sets the window title for the container that hosts this page to the given string.

Field Detail

DEFAULT_IMAGE
final public static String DEFAULT_IMAGE(Code)
	Image registry key of the default image for wizard pages (value `"org.eclipse.jface.wizard.Wizard.pageImage"`).

Constructor Detail

Wizard
protected Wizard()(Code)
	Creates a new empty wizard.

Method Detail

addPage
public void addPage(IWizardPage page)(Code)
	Adds a new page to this wizard. The page is inserted at the end of the page list. Parameters: page - the new page

addPages
public void addPages()(Code)
	The `Wizard` implementation of this `IWizard` method does nothing. Subclasses should extend if extra pages need to be added before the wizard opens. New pages should be added by calling `addPage`.

canFinish
public boolean canFinish()(Code)

createPageControls
public void createPageControls(Composite pageContainer)(Code)
	The `Wizard` implementation of this `IWizard` method creates all the pages controls using `IDialogPage.createControl`. Subclasses should reimplement this method if they want to delay creating one or more of the pages lazily. The framework ensures that the contents of a page will be created before attempting to show it.

dispose
public void dispose()(Code)
	The `Wizard` implementation of this `IWizard` method disposes all the pages controls using `DialogPage.dispose`. Subclasses should extend this method if the wizard instance maintains addition SWT resource that need to be disposed.

getContainer
public IWizardContainer getContainer()(Code)

getDefaultPageImage
public Image getDefaultPageImage()(Code)

getDialogSettings
public IDialogSettings getDialogSettings()(Code)

getNextPage
public IWizardPage getNextPage(IWizardPage page)(Code)

getPage
public IWizardPage getPage(String name)(Code)

getPageCount
public int getPageCount()(Code)

getPages
public IWizardPage[] getPages()(Code)

getPreviousPage
public IWizardPage getPreviousPage(IWizardPage page)(Code)

getShell
public Shell getShell()(Code)
	Returns the wizard's shell if the wizard is visible. Otherwise `null` is returned. Shell

getStartingPage
public IWizardPage getStartingPage()(Code)

getTitleBarColor
public RGB getTitleBarColor()(Code)

getWindowTitle
public String getWindowTitle()(Code)

isHelpAvailable
public boolean isHelpAvailable()(Code)

needsPreviousAndNextButtons
public boolean needsPreviousAndNextButtons()(Code)

needsProgressMonitor
public boolean needsProgressMonitor()(Code)

performCancel
public boolean performCancel()(Code)
	The `Wizard` implementation of this `IWizard` method does nothing and returns `true`. Subclasses should reimplement this method if they need to perform any special cancel processing for their wizard.

performFinish
abstract public boolean performFinish()(Code)
	Subclasses must implement this `IWizard` method to perform any special finish processing for their wizard.

setContainer
public void setContainer(IWizardContainer wizardContainer)(Code)

setDefaultPageImageDescriptor
public void setDefaultPageImageDescriptor(ImageDescriptor imageDescriptor)(Code)
	Sets the default page image descriptor for this wizard. This image descriptor will be used to generate an image for a page with no image of its own; the image will be computed once and cached. Parameters: imageDescriptor - the default page image descriptor

setDialogSettings
public void setDialogSettings(IDialogSettings settings)(Code)
	Sets the dialog settings for this wizard. The dialog settings is used to record state between wizard invocations (for example, radio button selection, last import directory, etc.) Parameters: settings - the dialog settings, or `null` if none See Also: Wizard.getDialogSettings

setForcePreviousAndNextButtons
public void setForcePreviousAndNextButtons(boolean b)(Code)
	Controls whether the wizard needs Previous and Next buttons even if it currently contains only one page. This flag should be set on wizards where the first wizard page adds follow-on wizard pages based on user input. Parameters: b - `true` to always show Next and Previous buttons,and `false` to suppress Next and Previous buttonsfor single page wizards

setHelpAvailable
public void setHelpAvailable(boolean b)(Code)
	Sets whether help is available for this wizard. The result of this method is typically used by the container to show or hide the Help button. Parameters: b - `true` if help is available, and`false` if this wizard is helpless See Also: Wizard.isHelpAvailable()

setNeedsProgressMonitor
public void setNeedsProgressMonitor(boolean b)(Code)
	Sets whether this wizard needs a progress monitor. Parameters: b - `true` if a progress monitor is required, and`false` if none is needed See Also: Wizard.needsProgressMonitor()

setTitleBarColor
public void setTitleBarColor(RGB color)(Code)
	Sets the title bar color for this wizard. Parameters: color - the title bar color

setWindowTitle
public void setWindowTitle(String newTitle)(Code)
	Sets the window title for the container that hosts this page to the given string. Parameters: newTitle - the window title for the container

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.