org.eclipse.sphinx.platform.ui.wizards.pages

Class AbstractWizardPage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

org.eclipse.sphinx.platform.ui.wizards.pages.AbstractWizardPage

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

Direct Known Subclasses:

CheckConfigurationPage, OutletsConfigurationPage, XpandConfigurationPage, XtendConfigurationPage

public abstract class AbstractWizardPage
extends org.eclipse.jface.wizard.WizardPage
implements org.eclipse.jface.wizard.IWizardPage

Abstraction for wizard pages responsible of the creation of new elements.

Field Summary

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWizardPage(java.lang.String pageName)

Method Summary

Methods

Modifier and Type	Method and Description
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected void	createSeparator(org.eclipse.swt.widgets.Composite composite, int nbCol) Creates a separator line.
protected abstract org.eclipse.swt.widgets.Control	doCreateControl(org.eclipse.swt.widgets.Composite parent)
protected abstract java.lang.String	doGetDescription()
protected abstract java.lang.String	doGetTitle()
protected abstract boolean	doIsPageComplete()
protected abstract org.eclipse.core.runtime.IStatus	doValidateRules()
void	finish() Called when the wizard is closed by selecting the finish button.
protected int	getMaxFieldWidth() Returns the recommended maximum width for text fields (in pixels).
boolean	isPageComplete()
protected void	updateStatus(org.eclipse.core.runtime.IStatus status)
protected org.eclipse.core.runtime.IStatus	validateRules()

Methods inherited from class org.eclipse.jface.wizard.WizardPage

canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString

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

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible

Methods inherited from class java.lang.Object

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

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

canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, setPreviousPage, setWizard

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Constructor Detail

AbstractWizardPage

protected AbstractWizardPage(java.lang.String pageName)

Parameters:

pageName -

Method Detail

createControl

public final void createControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createControl in interface org.eclipse.jface.dialogs.IDialogPage

isPageComplete

public final boolean isPageComplete()

Specified by:

isPageComplete in interface org.eclipse.jface.wizard.IWizardPage

Overrides:

isPageComplete in class org.eclipse.jface.wizard.WizardPage

doCreateControl

protected abstract org.eclipse.swt.widgets.Control doCreateControl(org.eclipse.swt.widgets.Composite parent)

doGetDescription

protected abstract java.lang.String doGetDescription()
                                              throws java.util.MissingResourceException

Throws:

java.util.MissingResourceException

doGetTitle

protected abstract java.lang.String doGetTitle()
                                        throws java.util.MissingResourceException

Throws:

java.util.MissingResourceException

doIsPageComplete

protected abstract boolean doIsPageComplete()

doValidateRules

protected abstract org.eclipse.core.runtime.IStatus doValidateRules()

updateStatus

protected final void updateStatus(org.eclipse.core.runtime.IStatus status)

validateRules

protected final org.eclipse.core.runtime.IStatus validateRules()

getMaxFieldWidth

protected int getMaxFieldWidth()

Returns the recommended maximum width for text fields (in pixels). This method requires that createContent has been called before this method is call. Subclasses may override to change the maximum width for text fields.

Returns:

The recommended maximum width for text fields.

createSeparator

protected final void createSeparator(org.eclipse.swt.widgets.Composite composite,
                   int nbCol)

Creates a separator line. Expects a GridLayout with at least 1 column.

Parameters:

composite - The parent composite

nbCol - Number of columns to span

finish

public void finish()

Called when the wizard is closed by selecting the finish button. Implementers typically override this method to store the page result.