Java Doc for WizardDialog.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)

org.eclipse.jface.dialogs .TitleAreaDialog

org.eclipse.jface.wizard .WizardDialog

WizardDialog

public class WizardDialog extends TitleAreaDialog implements IWizardContainer2,IPageChangeProvider(Code)

A dialog to show a wizard to the end user.

In typical usage, the client instantiates this class with a particular wizard. The dialog serves as the wizard container and orchestrates the presentation of its pages.

The standard layout is roughly as follows: it has an area at the top containing both the wizard's title, description, and image; the actual wizard page appears in the middle; below that is a progress indicator (which is made visible if needed); and at the bottom of the page is message line and a button bar containing Help, Next, Back, Finish, and Cancel buttons (or some subset).

Clients may subclass WizardDialog, although this is rarely required.

Inner Class :protected class PageContainerFillLayout extends Layout

Field Summary
final public static String	WIZ_IMG_ERROR Image registry key for error message image (value `"dialog_title_error_image"`).

Constructor Summary
public	WizardDialog(Shell parentShell, IWizard newWizard) Creates a new wizard dialog for the given wizard.

Method Summary
public void	addPageChangedListener(IPageChangedListener listener)
public void	addPageChangingListener(IPageChangingListener listener) Adds a listener for page changes to the list of page changing listeners registered for this dialog.
protected void	backPressed() The Back button has been pressed.
protected void	buttonPressed(int buttonId)
protected void	cancelPressed()
public boolean	close()
protected void	configureShell(Shell newShell)
protected void	createButtonsForButtonBar(Composite parent) Creates the buttons for this dialog's button bar.
protected Control	createContents(Composite parent) The `WizardDialog` implementation of this `Window` method calls call `IWizard.addPages` to allow the current wizard to add extra pages, then `super.createContents` to create the controls.
protected Control	createDialogArea(Composite parent)
protected ProgressMonitorPart	createProgressMonitorPart(Composite composite, GridLayout pmlayout) Create the progress monitor part in the receiver.
protected void	finishPressed() The Finish button has been pressed.
protected void	firePageChanged(PageChangedEvent event) Notifies any selection changed listeners that the selected page has changed.
protected void	firePageChanging(PageChangingEvent event) Notifies any page changing listeners that the currently selected dialog page is changing.
protected Button	getButton(int id) Return the cancel button if the id is a the cancel id.
public IWizardPage	getCurrentPage()
protected IProgressMonitor	getProgressMonitor() Returns the progress monitor for this wizard dialog (if it has one).
public Object	getSelectedPage()
protected IWizard	getWizard() Returns the wizard this dialog is currently displaying.
protected void	helpPressed() The Help button has been pressed.
protected void	nextPressed() The Next button has been pressed.
public void	removePageChangedListener(IPageChangedListener listener)
public void	removePageChangingListener(IPageChangingListener listener) Removes the provided page changing listener from the list of page changing listeners registered for the dialog.
public void	run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) This implementation of IRunnableContext#run(boolean, boolean, IRunnableWithProgress) blocks until the runnable has been run, regardless of the value of `fork`.
protected void	setButtonLayoutData(Button button)
public void	setMinimumPageSize(int minWidth, int minHeight) Sets the minimum page size used for the pages.
public void	setMinimumPageSize(Point size) Sets the minimum page size used for the pages.
public void	setPageSize(int width, int height) Sets the size of all pages.
public void	setPageSize(Point size) Sets the size of all pages.
protected void	setWizard(IWizard newWizard) Sets the wizard this dialog is currently displaying.
public void	showPage(IWizardPage page)
protected void	update() Updates this dialog's controls to reflect the current page.
public void	updateButtons()
public void	updateMessage()
protected void	updateSize(IWizardPage page) Computes the correct dialog size for the current page and resizes its shell if nessessary.
public void	updateSize()
public void	updateTitleBar()
public void	updateWindowTitle()

Field Detail

WIZ_IMG_ERROR
final public static String WIZ_IMG_ERROR(Code)
	Image registry key for error message image (value `"dialog_title_error_image"`).

Constructor Detail

WizardDialog
public WizardDialog(Shell parentShell, IWizard newWizard)(Code)
	Creates a new wizard dialog for the given wizard. Parameters: parentShell - the parent shell Parameters: newWizard - the wizard this dialog is working on

Method Detail

addPageChangedListener
public void addPageChangedListener(IPageChangedListener listener)(Code)

addPageChangingListener
public void addPageChangingListener(IPageChangingListener listener)(Code)
	Adds a listener for page changes to the list of page changing listeners registered for this dialog. Has no effect if an identical listener is already registered. Parameters: listener - a page changing listener since: 3.3

backPressed
protected void backPressed()(Code)
	The Back button has been pressed.

buttonPressed
protected void buttonPressed(int buttonId)(Code)

cancelPressed
protected void cancelPressed()(Code)

close
public boolean close()(Code)

configureShell
protected void configureShell(Shell newShell)(Code)

createButtonsForButtonBar
protected void createButtonsForButtonBar(Composite parent)(Code)
	Creates the buttons for this dialog's button bar. The `WizardDialog` implementation of this framework method prevents the parent composite's columns from being made equal width in order to remove the margin between the Back and Next buttons. Parameters: parent - the parent composite to contain the buttons

createContents
protected Control createContents(Composite parent)(Code)
	The `WizardDialog` implementation of this `Window` method calls call `IWizard.addPages` to allow the current wizard to add extra pages, then `super.createContents` to create the controls. It then calls `IWizard.createPageControls` to allow the wizard to pre-create their page controls prior to opening, so that the wizard opens to the correct size. And finally it shows the first page.

createDialogArea
protected Control createDialogArea(Composite parent)(Code)

createProgressMonitorPart
protected ProgressMonitorPart createProgressMonitorPart(Composite composite, GridLayout pmlayout)(Code)
	Create the progress monitor part in the receiver. Parameters: composite - Parameters: pmlayout - ProgressMonitorPart

finishPressed
protected void finishPressed()(Code)
	The Finish button has been pressed.

firePageChanged
protected void firePageChanged(PageChangedEvent event)(Code)
	Notifies any selection changed listeners that the selected page has changed. Only listeners registered at the time this method is called are notified. Parameters: event - a selection changed event See Also: IPageChangedListener.pageChanged since: 3.1

firePageChanging
protected void firePageChanging(PageChangingEvent event)(Code)
	Notifies any page changing listeners that the currently selected dialog page is changing. Only listeners registered at the time this method is called are notified. Parameters: event - a selection changing event See Also: IPageChangingListener.handlePageChanging(PageChangingEvent) since: 3.3

getButton
protected Button getButton(int id)(Code)
	Return the cancel button if the id is a the cancel id. Parameters: id - the button id the button corresponding to the button id

getCurrentPage
public IWizardPage getCurrentPage()(Code)

getProgressMonitor
protected IProgressMonitor getProgressMonitor()(Code)
	Returns the progress monitor for this wizard dialog (if it has one). the progress monitor, or `null` if this wizarddialog does not have one

getSelectedPage
public Object getSelectedPage()(Code)

getWizard
protected IWizard getWizard()(Code)
	Returns the wizard this dialog is currently displaying. the current wizard

helpPressed
protected void helpPressed()(Code)
	The Help button has been pressed.

nextPressed
protected void nextPressed()(Code)
	The Next button has been pressed.

removePageChangedListener
public void removePageChangedListener(IPageChangedListener listener)(Code)

removePageChangingListener
public void removePageChangingListener(IPageChangingListener listener)(Code)
	Removes the provided page changing listener from the list of page changing listeners registered for the dialog. Parameters: listener - a page changing listener since: 3.3

run
public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException, InterruptedException(Code)
	This implementation of IRunnableContext#run(boolean, boolean, IRunnableWithProgress) blocks until the runnable has been run, regardless of the value of `fork`. It is recommended that `fork` is set to true in most cases. If `fork` is set to `false`, the runnable will run in the UI thread and it is the runnable's responsibility to call `Display.readAndDispatch()` to ensure UI responsiveness. UI state is saved prior to executing the long-running operation and is restored after the long-running operation completes executing. Any attempt to change the UI state of the wizard in the long-running operation will be nullified when original UI state is restored.

setButtonLayoutData
protected void setButtonLayoutData(Button button)(Code)

setMinimumPageSize
public void setMinimumPageSize(int minWidth, int minHeight)(Code)
	Sets the minimum page size used for the pages. Parameters: minWidth - the minimum page width Parameters: minHeight - the minimum page height See Also: WizardDialog.setMinimumPageSize(Point)

setMinimumPageSize
public void setMinimumPageSize(Point size)(Code)
	Sets the minimum page size used for the pages. Parameters: size - the page size encoded as `new Point(width,height)` See Also: WizardDialog.setMinimumPageSize(int,int)

setPageSize
public void setPageSize(int width, int height)(Code)
	Sets the size of all pages. The given size takes precedence over computed sizes. Parameters: width - the page width Parameters: height - the page height See Also: WizardDialog.setPageSize(Point)

setPageSize
public void setPageSize(Point size)(Code)
	Sets the size of all pages. The given size takes precedence over computed sizes. Parameters: size - the page size encoded as `new Point(width,height)` See Also: WizardDialog.setPageSize(int,int)

setWizard
protected void setWizard(IWizard newWizard)(Code)
	Sets the wizard this dialog is currently displaying. Parameters: newWizard - the wizard

showPage
public void showPage(IWizardPage page)(Code)

update
protected void update()(Code)
	Updates this dialog's controls to reflect the current page.

updateButtons
public void updateButtons()(Code)

updateMessage
public void updateMessage()(Code)

updateSize
protected void updateSize(IWizardPage page)(Code)
	Computes the correct dialog size for the current page and resizes its shell if nessessary. Also causes the container to refresh its layout. Parameters: page - the wizard page to use to resize the dialog since: 2.0

updateSize
public void updateSize()(Code)

updateTitleBar
public void updateTitleBar()(Code)

updateWindowTitle
public void updateWindowTitle()(Code)

Fields inherited from org.eclipse.jface.dialogs.TitleAreaDialog

final public static String DLG_IMG_TITLE_BANNER(Code)(Java Doc)
final public static String DLG_IMG_TITLE_ERROR(Code)(Java Doc)
final public static String INFO_MESSAGE(Code)(Java Doc)
final public static String WARNING_MESSAGE(Code)(Java Doc)

Methods inherited from org.eclipse.jface.dialogs.TitleAreaDialog

protected Control createContents(Composite parent)(Code)(Java Doc)
protected Control createDialogArea(Composite parent)(Code)(Java Doc)
protected Point getInitialSize()(Code)(Java Doc)
protected Composite getTitleArea()(Code)(Java Doc)
protected Label getTitleImageLabel()(Code)(Java Doc)
public void setErrorMessage(String newErrorMessage)(Code)(Java Doc)
public void setMessage(String newMessage)(Code)(Java Doc)
public void setMessage(String newMessage, int newType)(Code)(Java Doc)
public void setTitle(String newTitle)(Code)(Java Doc)
public void setTitleAreaColor(RGB color)(Code)(Java Doc)
public void setTitleImage(Image newTitleImage)(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.