The BIRT Design Engine API provides the IBirtViewerExtension, IBirtViewerContext, IBirtViewerOp, and IBirtViewer Session Java interfaces to extend the functionality of BIRT Viewer. Classes implementing these interfaces are associated with the BIRT Viewer web application when they are added in the birtviewer-extension.xml configuration file. Its location is:For example, to enable myIVExtension.jar to operate on the BIRT Viewer, add an entry to birtviewer-extension.xml as follows:<InteractiveViewer>com.actuate.sample.MyIvExtension
</InteractiveViewer>Save the compiled code archive to the <context root>\WEB-INF\lib folder for the BIRT Viewer web application and restart the application to enable the custom interface. The interfaces are part of the com.actuate.birtviewer.extension package of the BIRT Design Engine API.The IBirtViewerExtension interface defines the event handler methods that activate implemented code, as follows:void afterDesignChange( IBirtViewerContext context, IBirtViewerOp operation, ReportDesignHandle designHandle );void afterDesignOpen( IBirtViewerContext context, ReportDesignHandle designHandle );void afterDesignSave( IBirtViewerContext context, IBirtViewerOp operation, ReportDesignHandle designHandle, String path );void beforeDesignChange( IBirtViewerContext context, IBirtViewerOp operation, ReportDesignHandle designHandle );boolean beforeDesignSave( IBirtViewerContext context, IBirtViewerOp operation, ReportDesignHandle designHandle, String path );void beforeResponse( IBirtViewerContext context, IBirtViewerOp operation, GetUpdatedObjectsResponse response );The IBirtViewerContext interface defines methods that retrieve information from the HTTP session, as follows:The IBirtViewerOp interface defines methods that retrieve information from the extended session for BIRT Viewer, as follows:The IBirtViewerSession interface defines methods that retrieve and set a session from the extended session for BIRT Viewer, as follows:
|
|
Copyright Actuate Corporation 2012 |