jpen.owner

Class AbstractPenOwner

java.lang.Object

jpen.owner.AbstractPenOwner

All Implemented Interfaces:

PenOwner

Direct Known Subclasses:

ComponentPenOwner

public abstract class AbstractPenOwner
extends java.lang.Object
implements PenOwner

Provides a mechanism to start/stop the drag-out operation.

Nested Class Summary

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

PenOwner.PenManagerHandle

Field Summary

Fields

Modifier and Type	Field and Description
protected PenOwner.PenManagerHandle	penManagerHandle

Constructor Summary

Constructors

Constructor and Description
AbstractPenOwner()

Method Summary

Modifier and Type	Method and Description
protected abstract void	draggingOutDisengaged()
boolean	enforceSinglePenManager()
java.lang.Object	evalPenEventTag(PenEvent ev) This method is called by the PenManager's machinary when creating a PenEvent.
protected Pen	getPen()
protected abstract void	init() Override this method to do initialization.
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.
protected boolean	startDraggingOut() Starts a drag-out operation if there are pressed buttons and installs a penListener which automatically stops the drag-out operation when all the buttons are unpressed.
protected boolean	stopDraggingOut() Force stopping a drag-out operation if it was in progress.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jpen.owner.PenOwner

getPenClip, getPenProviderConstructors

Field Detail

penManagerHandle

protected PenOwner.PenManagerHandle penManagerHandle

Constructor Detail

AbstractPenOwner

public AbstractPenOwner()

Method Detail

stopDraggingOut

protected final boolean stopDraggingOut()

Force stopping a drag-out operation if it was in progress. This method must be called when entering the PenClip to stop the drag-out operation if it was still in progress. This method must be called while holding the PenOwner.PenManagerHandle.getPenSchedulerLock() (See PenOwner.isDraggingOut()).

Returns:

true if a drag-out operation was in progress and was stopped.

draggingOutDisengaged

protected abstract void draggingOutDisengaged()

startDraggingOut

protected final boolean startDraggingOut()

Starts a drag-out operation if there are pressed buttons and installs a penListener which automatically stops the drag-out operation when all the buttons are unpressed. This method must be called while holding the PenOwner.PenManagerHandle.getPenSchedulerLock() (See PenOwner.isDraggingOut()).

Returns:

true if a drag-out operation was started or was already in progress.

setPenManagerHandle

public final 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

init

protected abstract void init()

Override this method to do initialization. This method is called after the penManagerHandle is set.

isDraggingOut

public final 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.

getPen

protected final Pen getPen()

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.