agile2d
Class PluggableRendererSpi

java.lang.Object
  |
  +--agile2d.PluggableRendererSpi

Direct Known Subclasses:

AGLPluggableRendererProvider

public abstract class PluggableRendererSpi

extends Object

The Service Provider Interface (SPI) for pluggable renderers in Agile2D. A pluggable renderer is responsible for rendering the contents of a Agile2D frame. Two renderers are implemented: One using the standard Java2D classes built into the Java runtime, and one using an experimental renderer which uses OpenGL to perform rendering.

The agile2d.opengl package contains the OpenGL renderer implementation.

Constructor Summary

PluggableRendererSpi()

Method Summary

abstract PluggableRenderer	createRenderer(AgileJFrame frame) Called by AgileJFrame to create a pluggable renderer instance for the frame.
static PluggableRendererSpi	getActiveProvider() Returns the currently active provider.
static PluggableRendererSpi	getJava2DProvider() Returns an instance of the Java2D Provider

Methods inherited from class java.lang.Object

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

Constructor Detail

PluggableRendererSpi

public PluggableRendererSpi()

Method Detail

getActiveProvider

public static PluggableRendererSpi getActiveProvider()

Returns the currently active provider. This method uses the System property "agile2d.provider" to determine what kind of provider to use, as follows:

• If the system property "agile2d.provider" is "java2d", getProvider() returns a pluggable renderer provider which renders graphics using the standard builtin Java2D graphics renderer. Such pluggable renderers can be identified by calling the PluggableRenderer.getName() method - if this returns "java2d", the standard Java2D renderer is in use.

• If the system property "agile2d.provider" is "opengl", getProvider() attempts to load the Agile2D OpenGL Pluggable Renderer package and returns an instance of the provider defined in that package. Loading the Agile2D OpenGL Pluggable Renderer package may fail for several reasons (e.g. the package is unavailable, native code needed by the package is unavailable, the application does not have security permission to load native code, etc.). If the Agile2D OpenGL Pluggable Renderer cannot be loaded, getProvider() falls back to using the Java2D provider.

• If the system property "agile.provider" is set to something other than "java2d" or "opengl", it is assumed to be the name of a Java class which extends PluggableRendererSpi. getProvider() attempts to load that class and return an instance of it. If the class does not exist or is an invalid type, getProvider() falls back to using the default provider.

Returns:

DOCUMENT ME!

getJava2DProvider

public static PluggableRendererSpi getJava2DProvider()

Returns an instance of the Java2D Provider

Returns:

DOCUMENT ME!

createRenderer

public abstract PluggableRenderer createRenderer(AgileJFrame frame)

Called by AgileJFrame to create a pluggable renderer instance for the frame. Providers must implement this method to create provider-specific renderers.

Returns:

DOCUMENT ME!