com.sharkysoft.fig.interactive

Class InteractiveFigureViewDelegate

java.lang.Object

com.sharkysoft.fig.core.FigureViewDelegate

com.sharkysoft.fig.interactive.InteractiveFigureViewDelegate

All Implemented Interfaces:

FigureObserver, FigureViewManager, InteractiveFigureViewManager

Direct Known Subclasses:

AwtFigureViewDelegate, SwtFigureViewDelegate

public class InteractiveFigureViewDelegate
extends FigureViewDelegate
implements InteractiveFigureViewManager

Generic figure drawing and mouse support.

Details: An InteractiveFigureViewDelegate provides generic figure drawing and mouse support to a InteractiveFigureView, thus allowing the InteractiveFigureView to become a view of the figure. The features offered in this class are generic and useful for implementing figure views in any GUI platform, including AWT, Swing, and SWT. To access platform-specific support, refer to the appropriate subclass instead.

Any UI component that implements InteractiveFigureView can become a view of a Figure by creating a private, concrete instance of this class and decorating it with the desired public methods (read up on the "decorator design pattern," if necessary). Minimally, only the original widget's paint requests need to be forwarded to this class.

A FigureViewDelegate can render its figure in any translation, scale, or rotation. Methods provided in this class make it possible to change the view's orientation at any time.

A FigureViewDelegate also maintains a registry of FigMouseListeners, sending them FigMouseEvents whenever applicable mouse events occur.

Author:

Sharky

Field Summary

Fields inherited from class com.sharkysoft.fig.core.FigureViewDelegate

mFigure, mTransform, mWidget

Constructor Summary

Constructors

Constructor and Description
InteractiveFigureViewDelegate(InteractiveFigureView iCanvas, FigureTransform iTransform)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMouseButtonListener(Doodle iDoodle, FigMouseButtonListener iListener) Registers mouse button listener.
void	addMouseMotionListener(Doodle iDoodle, FigMouseMotionListener iListener) Registers mouse motion listener.
void	addMouseWheelListener(Doodle iDoodle, FigMouseWheelListener iListener) Registers mouse wheel listener.
void	addTransformInteractor(TransformInteractor iInteractor) Attaches transform interactor.
protected FigMouseEvent.ConstructorForm	createFigMouseEventForm(EventObject iEvent, int iX, int iY) Prepares parameter form for FigMouseEvent constructor.
void	dispose()
void	doodleRemoved(Figure iFigure, Doodle iDoodle) Doodle was removed from figure.
Object	getCachedHint(Object iKey)
protected void	mouseMoved(FigMouseEvent iEvent)
protected void	mousePressed(FigMouseEvent iEvent)
protected void	mouseReleased(FigMouseEvent iEvent)
void	mouseWheelMoved(FigMouseEvent iEvent)
void	removeMouseButtonListener(Doodle iDoodle, FigMouseButtonListener iListener) Unregisters mouse button listener.
void	removeMouseMotionListener(Doodle iDoodle, FigMouseMotionListener iListener) Unregisters mouse motion listener.
void	removeMouseWheelListener(Doodle iDoodle, FigMouseWheelListener iListener) Unregisters mouse wheel listener.
void	removeTransformInteractor(TransformInteractor iInteractor) Detaches transform interactor.
void	setCachedHint(Object iKey, Object iValue)

Methods inherited from class com.sharkysoft.fig.core.FigureViewDelegate

doodleAdded, doodleChanged, getDetailLevel, getFigure, getTransform, paint, setDetailLevel, setFigure

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sharkysoft.fig.core.FigureViewManager

getDetailLevel, getFigure, getTransform, paint, setDetailLevel, setFigure

Constructor Detail

InteractiveFigureViewDelegate

public InteractiveFigureViewDelegate(InteractiveFigureView iCanvas,
                             FigureTransform iTransform)

Method Detail

addTransformInteractor

public final void addTransformInteractor(TransformInteractor iInteractor)

Description copied from interface: InteractiveFigureViewManager

Attaches transform interactor.

Details: This method attaches the given transform interactor to the view.

Specified by:

addTransformInteractor in interface InteractiveFigureViewManager

Parameters:

iInteractor - the interactor

removeTransformInteractor

public final void removeTransformInteractor(TransformInteractor iInteractor)

Description copied from interface: InteractiveFigureViewManager

Detaches transform interactor.

Details: This method detaches the given transform interactor from the view.

Specified by:

removeTransformInteractor in interface InteractiveFigureViewManager

Parameters:

iInteractor - the interactor

addMouseButtonListener

public final void addMouseButtonListener(Doodle iDoodle,
                          FigMouseButtonListener iListener)

Description copied from interface: InteractiveFigureViewManager

Registers mouse button listener.

Details: This method registers the given mouse button listener with the view and given doodle. When mouse button events occur in this view over the given doodle, those events will be transmitted to the listener through its callback methods.

Specified by:

addMouseButtonListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

removeMouseButtonListener

public final void removeMouseButtonListener(Doodle iDoodle,
                             FigMouseButtonListener iListener)

Description copied from interface: InteractiveFigureViewManager

Unregisters mouse button listener.

Details: This method unregisters the given mouse button listener from the view and given doodle. The listener will no longer receive events related to the view and given doodle.

Specified by:

removeMouseButtonListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

mousePressed

protected void mousePressed(FigMouseEvent iEvent)

mouseReleased

protected void mouseReleased(FigMouseEvent iEvent)

addMouseMotionListener

public final void addMouseMotionListener(Doodle iDoodle,
                          FigMouseMotionListener iListener)

Description copied from interface: InteractiveFigureViewManager

Registers mouse motion listener.

Details: This method registers the given mouse motion listener with the view and given doodle. When mouse motion events occur in this view over the given doodle, those events will be transmitted to the listener through its callback methods.

Specified by:

addMouseMotionListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

removeMouseMotionListener

public final void removeMouseMotionListener(Doodle iDoodle,
                             FigMouseMotionListener iListener)

Description copied from interface: InteractiveFigureViewManager

Unregisters mouse motion listener.

Details: This method unregisters the given mouse motion listener from the view and given doodle. The listener will no longer receive events related to the view and given doodle.

Specified by:

removeMouseMotionListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

mouseMoved

protected void mouseMoved(FigMouseEvent iEvent)

addMouseWheelListener

public final void addMouseWheelListener(Doodle iDoodle,
                         FigMouseWheelListener iListener)

Description copied from interface: InteractiveFigureViewManager

Registers mouse wheel listener.

Details: This method registers the given mouse motion listener with the view and given doodle. When mouse wheel events (i.e. rotations) occur in this view over the given doodle, those events will be transmitted to the listener through its callback methods.

Specified by:

addMouseWheelListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

removeMouseWheelListener

public final void removeMouseWheelListener(Doodle iDoodle,
                            FigMouseWheelListener iListener)

Description copied from interface: InteractiveFigureViewManager

Unregisters mouse wheel listener.

Details: This method unregisters the given mouse wheel listener from the view and given doodle. The listener will no longer receive events related to the view and given doodle.

Specified by:

removeMouseWheelListener in interface InteractiveFigureViewManager

Parameters:

iDoodle - the doodle

iListener - the listener

mouseWheelMoved

public void mouseWheelMoved(FigMouseEvent iEvent)

doodleRemoved

public void doodleRemoved(Figure iFigure,
                 Doodle iDoodle)

Description copied from interface: FigureObserver

Doodle was removed from figure.

Details: doodleRemoved notifies this listener that a doodle was removed from the figure. This callback will always be followed by a call to FigureObserver.doodleChanged(Figure, Doodle), so it is not critical to respond to this message.

Specified by:

doodleRemoved in interface FigureObserver

Overrides:

doodleRemoved in class FigureViewDelegate

Parameters:

iFigure - affected figure

iDoodle - removed doodle

dispose

public void dispose()

getCachedHint

public final Object getCachedHint(Object iKey)

setCachedHint

public final void setCachedHint(Object iKey,
                 Object iValue)

createFigMouseEventForm

protected final FigMouseEvent.ConstructorForm createFigMouseEventForm(EventObject iEvent,
                                                    int iX,
                                                    int iY)

Prepares parameter form for FigMouseEvent constructor.

Details: This method creates, fills out, and returns a new parameter form for the FigMouseEvent constructor.

Parameters:

iEvent - the platform event

iX - physical x-coordinate of event

iY - physical y-coordinate of event

Returns:

the parameter form