The API defninition for the CABAReT platform.

This package includes the interfaces defining the behavior of the key components of the application platform.

First we have the IStage itself, representing the application. This gives access to the viewer, printer and the instruments plugged in. The IViewer defines the behavior of a single open document in the application. There is no restriction in opening the same document more than once. The methods available on the working instance include for example printing, saving or selecting the page for viewing. The viewer may be but does not have to run under control of a IStage. Conceptually it may be used standalone.

To visualize and interact with the user objects of type IPageRenderer and IPageListener may be registered with the viewer objects. When used in the context of an IStage the IViewer should delegate its rendering and listener events to the containing viewer, this is accomplished normally by registering the viewer itself as renderer and listener.

All state changes that are not handled by the IPageListener and IPageRenderer are broadcast by the IStage and IViewer to INotificationListener objects.

The platform is designed to be extended via IInstrument objects. These objects are registered with the IStage and participate in the IStage lifecycle. An IInstrument may be anything from a static initialization, a sophisticated handler for special document features, up to a endpoint for web service call-ins or a scripting engine.