jpen

Interface PenProvider.Constructor

All Known Implementing Classes:

AbstractPenProvider.AbstractConstructor, CocoaProvider.Constructor, SystemProvider.Constructor, WintabProvider.Constructor, XinputProvider.Constructor

Enclosing interface:

PenProvider

public static interface PenProvider.Constructor

Each PenProvider is constructed using a Constructor. The available Constructors are given by the PenOwner.getPenProviderConstructors() and are used by the PenManager to try to construct one PenProvider for each Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	construct(PenManager pm) This method constructs the PenProvider.
boolean	constructable(PenManager pm)
PenProvider	getConstructed()
PenProvider.ConstructionException	getConstructionException()
int	getExpectedNativeBuild()
java.lang.String	getName()
int	getNativeBuild()
int	getNativeVersion()
PenManager	getPenManager()

Method Detail

getName

java.lang.String getName()

Returns:

The name of this provider. It corresponds to the method used by the PenProvider to access the pen/tablet.

constructable

boolean constructable(PenManager pm)

Returns:

true if the PenProvider can be constructed on this system, false otherwise.This method usually test for the name of the operating system and returns true if it matches an operating system in which this provider can run.

construct

boolean construct(PenManager pm)

This method constructs the PenProvider. It is called only when constructable(PenManager) returns true. When this methods completes, it is expected that the getConstructed() method returns the PenProvider constructed. If the PenProvider couldn't be constructed due to some condition (e.g. the required native drivers are not present) then the getConstructionException() method is expected to return an exception describing the condition.

Returns:

true if the PenProvider was constructed. false if the PenProvider couldn't be constructed.

getPenManager

PenManager getPenManager()

Returns:

The PenManager which called the construct(PenManager) method. null if the construct(PenManager) has not being called.

getConstructionException

PenProvider.ConstructionException getConstructionException()

Returns:

An exception describing an unexpected condition which prevented the PenProvider from being constructed. null if the PenProvider was constructed on the construct(PenManager) method call or if it has not yet being called.

getConstructed

PenProvider getConstructed()

Returns:

The PenProvider constructed when construct(PenManager) was called. null if it couldn't be constructed or if it has not yet being called.

getNativeVersion

int getNativeVersion()

Returns:

the native library version number. -1 if the provider does not use a native library. The version is used to construct the native library name.

getNativeBuild

int getNativeBuild()

Returns:

the loaded native library build number. -1 if the provider does not use a native library.

getExpectedNativeBuild

int getExpectedNativeBuild()

Returns:

the expected native library build number. -1 if the provider does not use a native library.