jpen.provider

Class AbstractPenProvider

java.lang.Object

jpen.provider.AbstractPenProvider

All Implemented Interfaces:

PenProvider

Direct Known Subclasses:

CocoaProvider, SystemProvider, WintabProvider, XinputProvider

public abstract class AbstractPenProvider
extends java.lang.Object
implements PenProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPenProvider.AbstractConstructor

Nested classes/interfaces inherited from interface jpen.PenProvider

PenProvider.ConstructionException, PenProvider.Constructor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<PenDevice>	devices

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPenProvider(PenProvider.Constructor constructor)

Method Summary

Modifier and Type	Method and Description
PenProvider.Constructor	getConstructor()
java.util.Collection<PenDevice>	getDevices()
PenManager	getPenManager()
boolean	getUseRelativeLocationFilter()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jpen.PenProvider

penManagerPaused

Field Detail

devices

protected final java.util.List<PenDevice> devices

Constructor Detail

AbstractPenProvider

protected AbstractPenProvider(PenProvider.Constructor constructor)

Method Detail

getDevices

public java.util.Collection<PenDevice> getDevices()

Specified by:

getDevices in interface PenProvider

Returns:

A Collection of devices currently owned by this PenProvider. This Collection can change over the lifetime of this PenProvider. Each time the Collection changes, PenManager.firePenDeviceAdded(PenProvider.Constructor, PenDevice) or PenManager.firePenDeviceRemoved(PenProvider.Constructor, PenDevice) must be called to notify the change. Warning: For convenience, there is no need to call PenManager.firePenDeviceAdded(PenProvider.Constructor, PenDevice) when constructing the PenProvider inside the Constructor#construct(PenManager) method because in this case it is automatically called by the PenManager when calling the Constructor.

getPenManager

public final PenManager getPenManager()

getConstructor

public final PenProvider.Constructor getConstructor()

Specified by:

getConstructor in interface PenProvider

Returns:

The Constructor which constructed this PenProvider.

getUseRelativeLocationFilter

public boolean getUseRelativeLocationFilter()

Specified by:

getUseRelativeLocationFilter in interface PenProvider

Returns:

true if this provider needs a location filter to automatically detect if one of its devices is using mouse (relative) location mode and replace its movement levels values with mouse pointer location values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object