org.modelio.api.ui

Class ModelioWizardDialog

java.lang.Object

org.eclipse.jface.window.Window

org.eclipse.jface.dialogs.Dialog

org.eclipse.jface.dialogs.TrayDialog

org.modelio.api.ui.ModelioDialog

org.modelio.api.ui.ModelioWizardDialog

All Implemented Interfaces:

org.eclipse.jface.dialogs.IPageChangeProvider, org.eclipse.jface.operation.IRunnableContext, org.eclipse.jface.window.IShellProvider, org.eclipse.jface.wizard.IWizardContainer, org.eclipse.jface.wizard.IWizardContainer2, IModelioDialog

public class ModelioWizardDialog
extends ModelioDialog
implements org.eclipse.jface.wizard.IWizardContainer2, org.eclipse.jface.dialogs.IPageChangeProvider

Version of eclipse's WizardDialog using ModelioDialog instead of TitleAreaDialog.

See Also:

WizardDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ModelioWizardDialog.PageContainerFillLayout A layout for a container which includes several pages, like a notebook, wizard, or preference dialog.

Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

org.eclipse.jface.window.Window.IExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	WIZ_IMG_ERROR Image registry key for error message image (value "dialog_title_error_image").

Fields inherited from class org.modelio.api.ui.ModelioDialog

DLG_IMG_TITLE_BANNER

Fields inherited from class org.eclipse.jface.dialogs.Dialog

blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS

Fields inherited from class org.eclipse.jface.window.Window

CANCEL, OK, resizeHasOccurred

Constructor Summary

Constructors

Constructor and Description
ModelioWizardDialog(org.eclipse.swt.widgets.Shell parentShell, org.eclipse.jface.wizard.IWizard newWizard) Creates a new wizard dialog for the given wizard.

Method Summary

Modifier and Type	Method and Description
void	addButtonsInButtonBar(org.eclipse.swt.widgets.Composite parent)
void	addPageChangedListener(org.eclipse.jface.dialogs.IPageChangedListener listener)
void	addPageChangingListener(org.eclipse.jface.dialogs.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()
boolean	close()
protected void	configureShell(org.eclipse.swt.widgets.Shell newShell)
protected void	createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent) Creates the buttons for this dialog's button bar.
org.eclipse.swt.widgets.Control	createContentArea(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.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 org.eclipse.swt.widgets.Control	createDialogArea(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.jface.wizard.ProgressMonitorPart	createProgressMonitorPart(org.eclipse.swt.widgets.Composite composite, org.eclipse.swt.layout.GridLayout pmlayout) Hook method for subclasses to create a custom progress monitor part.
protected void	finishPressed() The Finish button has been pressed.
protected void	firePageChanged(org.eclipse.jface.dialogs.PageChangedEvent event) Notifies any selection changed listeners that the selected page has changed.
protected void	firePageChanging(org.eclipse.jface.dialogs.PageChangingEvent event) Notifies any page changing listeners that the currently selected dialog page is changing.
protected org.eclipse.swt.widgets.Button	getButton(int id) Return the cancel button if the id is a the cancel id.
org.eclipse.jface.wizard.IWizardPage	getCurrentPage()
protected org.eclipse.core.runtime.IProgressMonitor	getProgressMonitor() Returns the progress monitor for this wizard dialog (if it has one).
Object	getSelectedPage()
protected org.eclipse.jface.wizard.IWizard	getWizard() Returns the wizard this dialog is currently displaying.
protected void	helpPressed() The Help button has been pressed.
void	init()
protected void	nextPressed() The Next button has been pressed.
void	removePageChangedListener(org.eclipse.jface.dialogs.IPageChangedListener listener)
void	removePageChangingListener(org.eclipse.jface.dialogs.IPageChangingListener listener) Removes the provided page changing listener from the list of page changing listeners registered for the dialog.
void	run(boolean fork, boolean cancelable, org.eclipse.jface.operation.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(org.eclipse.swt.widgets.Button button)
void	setMinimumPageSize(int minWidth, int minHeight) Sets the minimum page size used for the pages.
void	setMinimumPageSize(org.eclipse.swt.graphics.Point size) Sets the minimum page size used for the pages.
void	setPageSize(int width, int height) Sets the size of all pages.
void	setPageSize(org.eclipse.swt.graphics.Point size) Sets the size of all pages.
protected void	setWizard(org.eclipse.jface.wizard.IWizard newWizard) Sets the wizard this dialog is currently displaying.
void	showPage(org.eclipse.jface.wizard.IWizardPage page)
protected void	update() Updates this dialog's controls to reflect the current page.
void	updateButtons()
void	updateMessage()
void	updateSize()
protected void	updateSize(org.eclipse.jface.wizard.IWizardPage page) Computes the correct dialog size for the current page and resizes its shell if necessary.
void	updateTitleBar()
void	updateWindowTitle()

Methods inherited from class org.modelio.api.ui.ModelioDialog

addDefaultButtons, getHelpId, getInitialSize, setBlockOnOpen, setErrorMessage, setLogoImage, setMessage, setMessage, setTitle, setTitleLeftImage, setWarningMessage

Methods inherited from class org.eclipse.jface.dialogs.TrayDialog

closeTray, createButtonBar, createHelpControl, getLayout, getTray, handleShellCloseEvent, isDialogHelpAvailable, isHelpAvailable, openTray, setDialogHelpAvailable, setHelpAvailable

Methods inherited from class org.eclipse.jface.dialogs.Dialog

applyDialogFont, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutFormData, shortenText

Methods inherited from class org.eclipse.jface.window.Window

canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, open, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jface.wizard.IWizardContainer

getShell

Field Detail

WIZ_IMG_ERROR

public static final String WIZ_IMG_ERROR

Image registry key for error message image (value "dialog_title_error_image").

See Also:

Constant Field Values

Constructor Detail

ModelioWizardDialog

public ModelioWizardDialog(org.eclipse.swt.widgets.Shell parentShell,
                           org.eclipse.jface.wizard.IWizard newWizard)

Creates a new wizard dialog for the given wizard.

Parameters:

parentShell - the parent shell

newWizard - the wizard this dialog is working on

Method Detail

backPressed

protected void backPressed()

The Back button has been pressed.

buttonPressed

protected void buttonPressed(int buttonId)

Overrides:

buttonPressed in class org.eclipse.jface.dialogs.Dialog

cancelPressed

protected void cancelPressed()

Overrides:

cancelPressed in class org.eclipse.jface.dialogs.Dialog

close

public boolean close()

Overrides:

close in class org.eclipse.jface.dialogs.Dialog

finishPressed

protected void finishPressed()

The Finish button has been pressed.

helpPressed

protected void helpPressed()

The Help button has been pressed.

nextPressed

protected void nextPressed()

The Next button has been pressed.

setMinimumPageSize

public void setMinimumPageSize(int minWidth,
                               int minHeight)

Sets the minimum page size used for the pages.

Parameters:

minWidth - the minimum page width

minHeight - the minimum page height

See Also:

setMinimumPageSize(Point)

setPageSize

public void setPageSize(int width,
                        int height)

Sets the size of all pages. The given size takes precedence over computed sizes.

Parameters:

width - the page width

height - the page height

See Also:

setPageSize(Point)

update

protected void update()

Updates this dialog's controls to reflect the current page.

updateButtons

public void updateButtons()

Specified by:

updateButtons in interface org.eclipse.jface.wizard.IWizardContainer

updateMessage

public void updateMessage()

Specified by:

updateMessage in interface org.eclipse.jface.wizard.IWizardContainer

updateSize

public void updateSize()

Specified by:

updateSize in interface org.eclipse.jface.wizard.IWizardContainer2

updateTitleBar

public void updateTitleBar()

Specified by:

updateTitleBar in interface org.eclipse.jface.wizard.IWizardContainer

updateWindowTitle

public void updateWindowTitle()

Specified by:

updateWindowTitle in interface org.eclipse.jface.wizard.IWizardContainer

getSelectedPage

public Object getSelectedPage()

Specified by:

getSelectedPage in interface org.eclipse.jface.dialogs.IPageChangeProvider

init

public void init()

Specified by:

init in interface IModelioDialog

configureShell

protected void configureShell(org.eclipse.swt.widgets.Shell newShell)

Overrides:

configureShell in class org.eclipse.jface.window.Window

createButtonsForButtonBar

protected void createButtonsForButtonBar(org.eclipse.swt.widgets.Composite parent)

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.

Overrides:

createButtonsForButtonBar in class ModelioDialog

Parameters:

parent - the parent composite to contain the buttons

setButtonLayoutData

protected void setButtonLayoutData(org.eclipse.swt.widgets.Button button)

Overrides:

setButtonLayoutData in class org.eclipse.jface.dialogs.Dialog

getButton

protected org.eclipse.swt.widgets.Button getButton(int id)

Return the cancel button if the id is a the cancel id.

Overrides:

getButton in class org.eclipse.jface.dialogs.Dialog

Parameters:

id - the button id

Returns:

the button corresponding to the button id

createContents

protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.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. 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.

Overrides:

createContents in class ModelioDialog

createDialogArea

protected org.eclipse.swt.widgets.Control createDialogArea(org.eclipse.swt.widgets.Composite parent)

Overrides:

createDialogArea in class ModelioDialog

createProgressMonitorPart

protected org.eclipse.jface.wizard.ProgressMonitorPart createProgressMonitorPart(org.eclipse.swt.widgets.Composite composite,
                                                                                 org.eclipse.swt.layout.GridLayout pmlayout)

Hook method for subclasses to create a custom progress monitor part.

The default implementation creates a progress monitor with a stop button will be created.

Parameters:

composite - the parent composite

pmlayout - the layout

Returns:

ProgressMonitorPart the progress monitor part

getCurrentPage

public org.eclipse.jface.wizard.IWizardPage getCurrentPage()

Specified by:

getCurrentPage in interface org.eclipse.jface.wizard.IWizardContainer

getProgressMonitor

protected org.eclipse.core.runtime.IProgressMonitor getProgressMonitor()

Returns the progress monitor for this wizard dialog (if it has one).

Returns:

the progress monitor, or null if this wizard dialog does not have one

getWizard

protected org.eclipse.jface.wizard.IWizard getWizard()

Returns the wizard this dialog is currently displaying.

Returns:

the current wizard

run

public void run(boolean fork,
                boolean cancelable,
                org.eclipse.jface.operation.IRunnableWithProgress runnable)
         throws InterruptedException,
                InvocationTargetException

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.

Specified by:

run in interface org.eclipse.jface.operation.IRunnableContext

Throws:

InterruptedException

InvocationTargetException

setMinimumPageSize

public void setMinimumPageSize(org.eclipse.swt.graphics.Point size)

Sets the minimum page size used for the pages.

Parameters:

size - the page size encoded as new Point(width,height)

See Also:

setMinimumPageSize(int,int)

setPageSize

public void setPageSize(org.eclipse.swt.graphics.Point size)

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:

setPageSize(int,int)

setWizard

protected void setWizard(org.eclipse.jface.wizard.IWizard newWizard)

Sets the wizard this dialog is currently displaying.

Parameters:

newWizard - the wizard

showPage

public void showPage(org.eclipse.jface.wizard.IWizardPage page)

Specified by:

showPage in interface org.eclipse.jface.wizard.IWizardContainer

updateSize

protected void updateSize(org.eclipse.jface.wizard.IWizardPage page)

Computes the correct dialog size for the current page and resizes its shell if necessary. Also causes the container to refresh its layout.

Parameters:

page - the wizard page to use to resize the dialog

Since:

2.0

addPageChangedListener

public void addPageChangedListener(org.eclipse.jface.dialogs.IPageChangedListener listener)

Specified by:

addPageChangedListener in interface org.eclipse.jface.dialogs.IPageChangeProvider

removePageChangedListener

public void removePageChangedListener(org.eclipse.jface.dialogs.IPageChangedListener listener)

Specified by:

removePageChangedListener in interface org.eclipse.jface.dialogs.IPageChangeProvider

firePageChanged

protected void firePageChanged(org.eclipse.jface.dialogs.PageChangedEvent event)

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

Since:

3.1

See Also:

IPageChangedListener.pageChanged(org.eclipse.jface.dialogs.PageChangedEvent)

addPageChangingListener

public void addPageChangingListener(org.eclipse.jface.dialogs.IPageChangingListener listener)

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

removePageChangingListener

public void removePageChangingListener(org.eclipse.jface.dialogs.IPageChangingListener listener)

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

firePageChanging

protected void firePageChanging(org.eclipse.jface.dialogs.PageChangingEvent event)

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

Since:

3.3

See Also:

IPageChangingListener.handlePageChanging(PageChangingEvent)

addButtonsInButtonBar

public void addButtonsInButtonBar(org.eclipse.swt.widgets.Composite parent)

Specified by:

addButtonsInButtonBar in interface IModelioDialog

createContentArea

public org.eclipse.swt.widgets.Control createContentArea(org.eclipse.swt.widgets.Composite parent)

Specified by:

createContentArea in interface IModelioDialog