org.eclipse.pde.api.tools.ui.internal.wizards

Class ApiBaselineWizardPage [ source ]

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

org.eclipse.pde.api.tools.ui.internal.wizards.ApiBaselineWizardPage

All Implemented Interfaces:

IDialogPage, IMessageProvider, IWizardPage

public class ApiBaselineWizardPage
extends WizardPage

The wizard page allowing a new API profiles to be created or an existing one to be edited

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ApiBaselineWizardPage.ContentProvider Content provider for the viewer
static class	ApiBaselineWizardPage.EEEntry an EE entry (child of an api component in the viewer)
(package private) class	ApiBaselineWizardPage.ReloadOperation Resets the baseline contents based on current settings and a location from which to read plug-ins.
(package private) static class	ApiBaselineWizardPage.WorkingCopyOperation Operation that creates a new working copy for an IApiProfile that is being edited

Field Summary

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiBaselineWizardPage(IApiBaseline profile) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cleans up the working copy if the page is cancelled
boolean	contentChanged()
void	createControl(Composite parent) Creates the top level control for this dialog page under the given parent composite.
protected void	doReload() Reloads all of the plugins from the location specified in the location text field.
IApiBaseline	finish() Creates or edits the profile and returns it
protected IApiComponent[]	getCurrentComponents() Returns the current API components in the baseline or an empty collection if none.
protected void	initialize() Initializes the controls of the page if the profile is not null
protected boolean	pageValid()
protected void	updateButtons() Updates the state of a variety of buttons on this page

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

canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, 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.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible

Constructor Detail

ApiBaselineWizardPage

protected ApiBaselineWizardPage(IApiBaseline profile)

Constructor

Parameters:

profile -

Method Detail

createControl

public void createControl(Composite parent)

Description copied from interface: IDialogPage

Creates the top level control for this dialog page under the given parent composite.

Implementors are responsible for ensuring that the created control can be accessed via getControl

Parameters:

parent - the parent composite

initialize

protected void initialize()

Initializes the controls of the page if the profile is not null

doReload

protected void doReload()

Reloads all of the plugins from the location specified in the location text field.

pageValid

protected boolean pageValid()

Returns:

if the page is valid, such that it is considered complete and can be 'finished'

getCurrentComponents

protected IApiComponent[] getCurrentComponents()

Returns the current API components in the baseline or an empty collection if none.

Returns:

the current API components in the baseline or an empty collection if none

updateButtons

protected void updateButtons()

Updates the state of a variety of buttons on this page

finish

public IApiBaseline finish()
                    throws IOException,
                           CoreException

Creates or edits the profile and returns it

Returns:

a new IApiProfile or null if an error was encountered creating the new profile

Throws:

IOException

CoreException

contentChanged

public boolean contentChanged()

Returns:

if the actual content of the base line has changed and not just some other attribute

cancel

public void cancel()

Cleans up the working copy if the page is cancelled