org.modelio.api.module.report

Class ReportDialog

java.lang.Object

org.modelio.platform.ui.dialog.ModelioDialog

org.modelio.api.ui.ModelioDialog

org.modelio.api.module.report.ReportDialog

public class ReportDialog
extends ModelioDialog

The report dialog is used by modules willing to display the contents of a Report which they have built during a processing operation by adding ReportEntry records to it. A Report is a sequence of ReportEntry. A Reportentry can be of several kind (see @link EntryKind. The contents of the report are displayed in HTML rendred text in a browser. Two kind of links are exclusively supported:

• modelio model element links that allow to navigate to a given element listed in the report
• modelio help topic links that pops the Modelio help for a given topic.

The ReportDialog browser is configured to ignore any other type of link. The @link HTMLReport private class is in charge to lay out the reported message in HTML text, controlled by its internal CSS stylesheet HTMLReport#CSS.

Typical use:

 Report myReport = new Report();
 myReport.addError(...);
 myReport.addWarning(...);
 myReport.addTip(...);
 myReport.addInfo(...);
 
 ReportDialog dlg = new ReportDialog(parent, navigationService, modelioHelpService, myReport);
 dlg.open();
 

Since:

4.1

Constructor Summary

Constructors

Constructor and Description
ReportDialog(Shell parentShell, IModelingSession session, INavigationService navigationService, Report report) C'tor

Method Summary

Modifier and Type	Method and Description
protected void	addButtonsInButtonBar(Composite parent)
protected Control	createContentArea(Composite parent)
protected Point	getInitialSize()
protected void	init()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDialog

public ReportDialog(Shell parentShell,
                    IModelingSession session,
                    INavigationService navigationService,
                    Report report)

C'tor

Parameters:

parentShell - the parent shell. Can be null.

session - access to the project's model. Can be null in which case element links are not displayed and no navigation is possible..

navigationService - the Modelio navigation service. Can be null in which case element links are not displayed and no navigation is possible.

report - the report to display. Cannot be null.

Method Detail

addButtonsInButtonBar

protected void addButtonsInButtonBar(Composite parent)

init

protected void init()

createContentArea

protected Control createContentArea(Composite parent)

getInitialSize

protected Point getInitialSize()