org.eclipse.hyades.ui.report
Class ReportGeneratorWizard

java.lang.Object
  org.eclipse.jface.wizard.Wizard
      org.eclipse.hyades.ui.internal.wizard.HyadesWizard
          org.eclipse.hyades.ui.report.ReportGeneratorWizard

All Implemented Interfaces:

IDisposable, org.eclipse.jface.wizard.IWizard, org.eclipse.jface.wizard.IWizardNode, org.eclipse.ui.IWorkbenchWizard

Direct Known Subclasses:

ExportToXML

public abstract class ReportGeneratorWizard
extends org.eclipse.hyades.ui.internal.wizard.HyadesWizard
implements org.eclipse.jface.wizard.IWizardNode

This class is the base class for the reportGenerators extension.

Field Summary

Fields inherited from class org.eclipse.jface.wizard.Wizard

DEFAULT_IMAGE

Constructor Summary

ReportGeneratorWizard()
Constructor

Method Summary

void	addPages()
abstract org.eclipse.core.resources.IFile	generate(org.eclipse.core.runtime.IProgressMonitor monitor) Generate the report.
java.lang.String	getEditorId() Returns the editor ID to determine the editor to show the generated report.
org.eclipse.swt.graphics.Point	getExtent()
java.lang.String	getId()
org.eclipse.jface.wizard.IWizard	getWizard()
abstract boolean	isAvailable(org.eclipse.jface.viewers.ISelection selection) Return true if the wizard is available for the workbench selection.
boolean	isContentCreated()
boolean	performFinish() The performFinish() method will be called by the wizard that contains this wizard.
void	setId(java.lang.String id)

Methods inherited from class org.eclipse.hyades.ui.internal.wizard.HyadesWizard

createPageControls, dispose, getSelection, getWorkbench, init

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

addPage, canFinish, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getShell, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer, setDefaultPageImageDescriptor, setDialogSettings, setForcePreviousAndNextButtons, setHelpAvailable, setNeedsProgressMonitor, setTitleBarColor, setWindowTitle

Methods inherited from class java.lang.Object

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

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

dispose

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

canFinish, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, setContainer

Constructor Detail

ReportGeneratorWizard

public ReportGeneratorWizard()

Constructor

Method Detail

addPages

public void addPages()

Specified by:

addPages in interface org.eclipse.jface.wizard.IWizard

Overrides:

addPages in class org.eclipse.jface.wizard.Wizard

See Also:

IWizard.addPages()

performFinish

public boolean performFinish()

The performFinish() method will be called by the wizard that contains this wizard.

Specified by:

performFinish in interface org.eclipse.jface.wizard.IWizard

Specified by:

performFinish in class org.eclipse.jface.wizard.Wizard

See Also:

IWizard.performFinish()

getEditorId

public java.lang.String getEditorId()

Returns the editor ID to determine the editor to show the generated report.

generate

public abstract org.eclipse.core.resources.IFile generate(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                   throws java.lang.Exception

Generate the report. This method is called in the performFinish() method of the parent ReportWizard wizard.

Parameters:

monitor - that will display a progress bar during the generation.

Returns:

the generated report file. For example an index file.

Throws:

java.lang.Exception

getExtent

public org.eclipse.swt.graphics.Point getExtent()

Specified by:

getExtent in interface org.eclipse.jface.wizard.IWizardNode

See Also:

IWizardNode.getExtent()

getWizard

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

Specified by:

getWizard in interface org.eclipse.jface.wizard.IWizardNode

See Also:

IWizardNode.getWizard()

isContentCreated

public boolean isContentCreated()

Specified by:

isContentCreated in interface org.eclipse.jface.wizard.IWizardNode

See Also:

IWizardNode.isContentCreated()

isAvailable

public abstract boolean isAvailable(org.eclipse.jface.viewers.ISelection selection)

Return true if the wizard is available for the workbench selection.

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)