jpen.owner

Class ScreenPenOwner

java.lang.Object

jpen.owner.ScreenPenOwner

All Implemented Interfaces:

PenOwner

public class ScreenPenOwner
extends java.lang.Object
implements PenOwner

Defines a PenClip for all the screen. Its PenManager is unpaused when the current application has an active window.

Nested Class Summary

Nested classes/interfaces inherited from interface jpen.owner.PenOwner

PenOwner.PenManagerHandle

Method Summary

Modifier and Type	Method and Description
boolean	enforceSinglePenManager()
java.lang.Object	evalPenEventTag(PenEvent ev) This method is called by the PenManager's machinary when creating a PenEvent.
static ScreenPenOwner	getInstance()
PenClip	getPenClip()
java.util.Collection<PenProvider.Constructor>	getPenProviderConstructors() Called once by the PenManager.PenManager(PenOwner) constructor to get the available PenProvider.Constructors and use them to setup the PenProviders.
boolean	isDraggingOut() Called by the PenManager to avoid sending PLevelEvents to clients when the location is outside the PenClip and this method returns false.
void	setPenManagerHandle(PenOwner.PenManagerHandle penManagerHandle) Called once by the PenManager.PenManager(PenOwner) constructor to allow this PenOwner to access the PenManager through the given PenOwner.PenManagerHandle.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ScreenPenOwner getInstance()

getPenProviderConstructors

public java.util.Collection<PenProvider.Constructor> getPenProviderConstructors()

Description copied from interface: PenOwner

Called once by the PenManager.PenManager(PenOwner) constructor to get the available PenProvider.Constructors and use them to setup the PenProviders.

Specified by:

getPenProviderConstructors in interface PenOwner

setPenManagerHandle

public void setPenManagerHandle(PenOwner.PenManagerHandle penManagerHandle)

Description copied from interface: PenOwner

Called once by the PenManager.PenManager(PenOwner) constructor to allow this PenOwner to access the PenManager through the given PenOwner.PenManagerHandle.

Specified by:

setPenManagerHandle in interface PenOwner

getPenClip

public PenClip getPenClip()

Specified by:

getPenClip in interface PenOwner

Returns:

The PenClip associated with this PenOwner.

isDraggingOut

public boolean isDraggingOut()

Description copied from interface: PenOwner

Called by the PenManager to avoid sending PLevelEvents to clients when the location is outside the PenClip and this method returns false. The PenManager calls this method holding the PenOwner.PenManagerHandle.getPenSchedulerLock() synchronization lock.

Specified by:

isDraggingOut in interface PenOwner

Returns:

true if this PenOwner is currently in a drag-out operation.

evalPenEventTag

public java.lang.Object evalPenEventTag(PenEvent ev)

Description copied from interface: PenOwner

This method is called by the PenManager's machinary when creating a PenEvent. This method returns a tag to be stored on the given PenEvent or null if no tagging is needed (the PenManager machinary stores this tag on the private PenEvent's penOwnerTag field ). The tag can be later retrieved using PenOwner.PenManagerHandle.retrievePenEventTag(PenEvent).

Specified by:

evalPenEventTag in interface PenOwner

enforceSinglePenManager

public boolean enforceSinglePenManager()

Specified by:

enforceSinglePenManager in interface PenOwner

Returns:

true if you want to allow only one PenManager per JVM---attempting to create more than one PenManager instance will cause an IllegalStateException to be thrown by the PenManager's constructor.