|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectWizard
com.businessobjects.crystalreports.designer.sdk.wizard.ReportWizard
public class ReportWizard
This class defines a wizard that creates Crystal reports.
You can extend this class to implement a wizard that produces customized reports.
To add custom pages to the wizard, override the addCustomPages
method.
To customize the report that is created by the wizard, override the
doFinish
method.
Constructor Summary | |
---|---|
ReportWizard()
Constructs a ReportWizard object and initializes it with a blank report. |
Method Summary | |
---|---|
void |
addCustomPages()
Adds custom pages to the report wizard. |
void |
addPages()
Adds default pages to the report wizard and calls addCustomPages to add
custom pages to the wizard. |
void |
doFinish()
Performs report modification when the report wizard finishes. |
IWizardPage |
getMainWizardPage()
Returns the main wizard page in the Eclipse IDE. |
ReportClientDocument |
getReport()
Returns the report that is being created by the wizard. |
IStructuredSelection |
getSelection()
Returns the workbench selection. |
IWorkbench |
getWorkbench()
Returns the workbench that is running the wizard. |
void |
init(IWorkbench aWorkbench,
IStructuredSelection currentSelection)
Initializes the report wizard. |
boolean |
performFinish()
Finishes the wizard and creates the report. |
void |
setReport(ReportClientDocument report)
Sets a report into the wizard. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReportWizard() throws ReportSDKException
ReportWizard
object and initializes it with a blank report.
Note: To prevent the wizard dialog from being displayed, throw an exception from this constructor.
ReportSDKException
Method Detail |
---|
public IWorkbench getWorkbench()
public IStructuredSelection getSelection()
public void setReport(ReportClientDocument report)
report
- the new reportpublic void init(IWorkbench aWorkbench, IStructuredSelection currentSelection)
aWorkbench
- the workbench that is running the wizardcurrentSelection
- the current selectionpublic final void addPages()
addCustomPages
to add
custom pages to the wizard.
public void addCustomPages()
org.eclipse.jface.Wizard.addPage
method.
public final boolean performFinish()
doFinish
method
to perform the final report modification tasks.
true
if the report was successfully created, false
otherwisepublic void doFinish()
Performs report modification when the report wizard finishes.
Typically, this method modifies the a blank report by using the SDK.
To modify a report template, use thesetReport
method
to replace the blank report with a report template.
Report wizards that contain customized pages can modify the report directly from the pages.
Note: this method is not intended to be called directly by the client.
public final ReportClientDocument getReport()
ReportClientDocument
object that this wizard is creatingpublic final IWizardPage getMainWizardPage()
For example:
PlatformUI.getWorkbench ().getHelpSystem ().setHelp (getMainWizardPage ().getControl (), HELP_CONTEXT_ID);
null
if none exists.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |