Package org.pentaho.reporting.engine.classic.demo.util

Interface InternalDemoHandler

All Superinterfaces:

DemoHandler

All Known Subinterfaces:

XmlDemoHandler

All Known Implementing Classes:

AbstractDemoHandler, AbstractXmlDemoHandler, AutoTableAPIDemo, AutoTableBundleDemo, BandInBandStackingDemoHandler, BasicExtXmlChartDemo, BasicSimpleXmlChartDemo, BookstoreDemo, CombinedAdvertisingDemoHandler, ComponentDrawingDemoHandler, ConditionalGroupDemo, CountryReportAPIDemoHandler, CountryReportExtXMLDemoHandler, CountryReportSecurityXMLDemoHandler, CountryReportXMLDemoHandler, CSVReaderDemo, ExtSubReportDemo, FileLoadingDemo, FontDemo, GroupsDemo, I18nDemo, InlineSubReportDemo, InteractiveHtmlDemo, InteractiveSwingDemo, InternalFrameDemoHandler, ItemHidingDemoHandler, LeadingEmptyCardsDemoHandler, LGPLTextDemo, LogEventDemo, MultiAPIChartDemo, MultiExtXmlChartDemo, MultiPageCountryDataDemoHandler, MultiReportDemo, MultiSimpleXmlChartDemo, OneFileSubReportDemo, OpenSourceAPIDemoHandler, OpenSourceXMLDemoHandler, PaintComponentDemoHandler, ParameterDemo, PeopleReportAPIDemoHandler, PeopleReportXmlDemoHandler, PercentageDemo, RectanglesDemo, ReportFooter2Demo, ReportFooterDemo, RowbandingDemo, ShapeAndDrawableDemoHandler, SimpleAdvertisingDemoHandler, SimpleBarcodesAPIDemo, SimpleBarcodesODFDemo, SimpleBarcodesXMLDemo, SimpleCardDemoHandler, SimpleInvoiceDemoHandler, SimplePatientFormDemo, SparklineAPIDemo, SparklineODFDemo, SparklineXMLDemo, SportsCouncilDemo, SQLDataSourceDemo, SQLSubReportDemo, StackedLayoutAPIDemoHandler, StackedLayoutXMLDemoHandler, StaticDataSourceDemo, SubReportDemo, SurveyScaleAPIDemoHandler, SurveyScaleXMLDemoHandler, SwingIconsDemo, TableJFreeChartDemo, ThreeMultiReportDemo, ThreeSubReportDemo, TrafficLightingDemo, VeryLargeReportDemo, WayBillDemoHandler

public interface InternalDemoHandler
extends DemoHandler

A demo handler allows the generic use of demos in the framework.

Every demo has a name, a way to create a report and a description in HTML documenting the demo. A demo also provides a presentation component to either show the data or control the demo's appearance.

Author:

Thomas Morgner

Method Summary

Modifier and Type	Method	Description
org.pentaho.reporting.engine.classic.core.MasterReport	createReport()	Creates the report.
DemoController	getController()	Returns the demo controler for this demo.
URL	getDemoDescriptionSource()	Returns the URL of the HTML document describing this demo.
String	getDemoName()	Returns the display name of the demo.
JComponent	getPresentationComponent()	Returns the presentation component for this demo.
void	setController(DemoController controler)	Assigns a demo controler to this demo.

Methods inherited from interface org.pentaho.reporting.engine.classic.demo.util.DemoHandler

getPreviewHandler

Method Detail

getDemoName

String getDemoName()

Returns the display name of the demo.

Specified by:

getDemoName in interface DemoHandler

Returns:

the name.

setController

void setController(DemoController controler)

Assigns a demo controler to this demo. It is guaranteed, that a controler is set, before the presentation component is queried or a report is created.

Parameters:

controler - the controler.

getController

DemoController getController()

Returns the demo controler for this demo. The demo controler is supplied by the user of the demo handler.

Returns:

the demo controler for this demo handler.

createReport

org.pentaho.reporting.engine.classic.core.MasterReport createReport()
                                                             throws ReportDefinitionException

Creates the report. For XML reports, this will most likely call the ReportGenerator, while API reports may use this function to build and return a new, fully initialized report object.

Returns:

the fully initialized JFreeReport object.

Throws:

ReportDefinitionException - if an error occured preventing the report definition.

getDemoDescriptionSource

URL getDemoDescriptionSource()

Returns the URL of the HTML document describing this demo.

Returns:

the demo description.

getPresentationComponent

JComponent getPresentationComponent()

Returns the presentation component for this demo. This component is shown before the real report generation is started. Ususally it contains a JTable with the demo data and/or input components, which allow to configure the report.

Returns:

the presentation component, never null.