ilog.views.interactor

Class IlvSelectInteractorMoveSelection

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvAbstractScrollInteractor

ilog.views.interactor.IlvMoveRectangleInteractor

ilog.views.interactor.IlvSelectInteractorMoveSelection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IltSelectInteractorMoveSelection

public class IlvSelectInteractorMoveSelection
extends IlvMoveRectangleInteractor

Interactor that is called by IlvSelectInteractor to move selected objects.

See Also:

IlvSelectInteractor.getMoveSelectionInteractor(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvSelectInteractorMoveSelection(IlvSelectInteractor inter) Creates a new IlvSelectInteractorMoveSelection referring to an IlvSelectInteractor.

Method Summary

Modifier and Type	Method and Description
protected void	attach(IlvManagerView v) Called when the interactor is attached to the manager view.
protected void	detach() Called when the interactor is detached from the view.
void	drawGhost(Graphics g) Draws a ghost while the selected objects are being moved.
double	getMaximumScrollDistance() Returns the maximal distance of scroll operations when the mouse moves outside the manager view.
int	getScrollTiming() Returns the timing of repetitive scroll operations when the mouse moves outside the manager view.
IlvSelectInteractor	getSelectInteractor() Returns the associated IlvSelectInteractor.
protected IlvRect	getSelectionBoundingBox(IlvGraphic obj, IlvTransformer t) This method is invoked by setSelectionRect() and is intended to return the bounding box of a given object.
boolean	isOpaqueMode() Returns an indication of whether the interactor is in Opaque mode or not.
boolean	isProgressiveScroll() Returns whether progressive scrolling is enabled.
boolean	isXORGhost() Returns the ghost drawing mode.
protected boolean	objectIsMovable(IlvGraphic object) Deprecated. Beginning with Rogue Wave JViews 6.0 you should instead filter the return of the IlvSelectInteractor.getSelectedMovingObjects(ilog.views.IlvManager) method using a IlvFilteredGraphicEnumeration.
protected void	rectangleDragged(AWTEvent event, double dx, double dy) Called each time the selection is dragged.
protected void	snapRectangleToGrid(IlvRect rectangle) This method is called to snap the given rectangle to the IlvManagerView grid.
protected void	translateSelections(double dx, double dy) This method is called to translate selected objects.
protected boolean	trigger(AWTEvent event, double dx, double dy) Called when the user releases the mouse button.

Methods inherited from class ilog.views.interactor.IlvMoveRectangleInteractor

dragscroll, getCursor, getLineStyle, getMoveThreshold, getRectangle, handleButtonDown, handleButtonDragged, handleButtonUp, isDragging, isGridMode, processMouseEvent, processMouseMotionEvent, setCursor, setGridMode, setLineStyle, setMoveThreshold, setOpaqueMode, setRectangle

Methods inherited from class ilog.views.interactor.IlvAbstractScrollInteractor

adjustPointIfOutsideView, doAutoScroll, setMaximumScrollDistance, setProgressiveScroll, setScrollTiming, startDraggingScrollTimer, stopDraggingScrollTimer

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, processEvent, processFocusEvent, processKeyEvent, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, setXORGhost

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSelectInteractorMoveSelection

public IlvSelectInteractorMoveSelection(IlvSelectInteractor inter)

Creates a new IlvSelectInteractorMoveSelection referring to an IlvSelectInteractor.

Parameters:

inter - The associated IlvSelectInteractor.

See Also:

getSelectInteractor()

Method Detail

isOpaqueMode

public boolean isOpaqueMode()

Returns an indication of whether the interactor is in Opaque mode or not.

This method is overridden in this class to return the opaque move selection mode of the associated IlvSelectInteractor.

Overrides:

isOpaqueMode in class IlvMoveRectangleInteractor

Since:

JViews 5.0

See Also:

IlvSelectInteractor.isOpaqueMove(), IlvMoveRectangleInteractor.setOpaqueMode(boolean)

isXORGhost

public final boolean isXORGhost()

Returns the ghost drawing mode. This method overrides the method of the superclass to return the XOR mode of the associated IlvSelectInteractor. It also forces the XOR mode when the method isOpaqueMode() returns false.

Overrides:

isXORGhost in class IlvMoveRectangleInteractor

Returns:

true if the drawing needs to be performed in XOR mode, false otherwise.

Since:

JViews 5.0

See Also:

IlvManagerViewInteractor.setXORGhost(boolean), IlvManagerViewInteractor.handleExpose(java.awt.Graphics), IlvManagerViewInteractor.drawGhost(java.awt.Graphics)

getScrollTiming

public int getScrollTiming()

Returns the timing of repetitive scroll operations when the mouse moves outside the manager view.

Overrides:

getScrollTiming in class IlvAbstractScrollInteractor

Since:

JViews 8.5

See Also:

IlvAbstractScrollInteractor.setScrollTiming(int)

getMaximumScrollDistance

public double getMaximumScrollDistance()

Returns the maximal distance of scroll operations when the mouse moves outside the manager view.

Overrides:

getMaximumScrollDistance in class IlvAbstractScrollInteractor

Since:

JViews 8.5

See Also:

IlvAbstractScrollInteractor.setMaximumScrollDistance(double)

isProgressiveScroll

public boolean isProgressiveScroll()

Returns whether progressive scrolling is enabled.

Overrides:

isProgressiveScroll in class IlvAbstractScrollInteractor

Since:

JViews 8.5

See Also:

IlvAbstractScrollInteractor.setProgressiveScroll(boolean)

getSelectInteractor

public IlvSelectInteractor getSelectInteractor()

Returns the associated IlvSelectInteractor.

snapRectangleToGrid

protected void snapRectangleToGrid(IlvRect rectangle)

This method is called to snap the given rectangle to the IlvManagerView grid. By default it calls IlvManagerView.snapToGrid(IlvPoint) to snap the top left corner of the rectangle to the grid. This method can be redefined to snap the rectangle differently (like snapping the center of it instead of the top left corner). The dimensions of the rectangle must not be changed by this method; it can only modify the x and y attributes.

Overrides:

snapRectangleToGrid in class IlvMoveRectangleInteractor

Parameters:

rectangle - the rectangle to be snapped

Since:

JViews 6.5

getSelectionBoundingBox

protected IlvRect getSelectionBoundingBox(IlvGraphic obj,
                                          IlvTransformer t)

This method is invoked by setSelectionRect() and is intended to return the bounding box of a given object.

Parameters:

obj - The moveable selected object.

t - The current drawing transformer.

Returns:

The bounding box of the given object.

Since:

JViews 8.0

Internal: do not use!

attach

protected void attach(IlvManagerView v)

Called when the interactor is attached to the manager view.

Overrides:

attach in class IlvMoveRectangleInteractor

Parameters:

v - The manager view.

See Also:

detach()

detach

protected void detach()

Called when the interactor is detached from the view.

Overrides:

detach in class IlvMoveRectangleInteractor

See Also:

attach(ilog.views.IlvManagerView)

objectIsMovable

@Deprecated
protected boolean objectIsMovable(IlvGraphic object)

Deprecated. Beginning with Rogue Wave JViews 6.0 you should instead filter the return of the IlvSelectInteractor.getSelectedMovingObjects(ilog.views.IlvManager) method using a IlvFilteredGraphicEnumeration.

Checks if the graphic object that is part of the current selection is going to be moved by the interactor. The current implementation returns true, meaning that all the selected objects for which IlvManager.isMovable(IlvGraphic) returns true will be moved. You may override it to select the objects that will be moved.

Parameters:

object - The object to test.

drawGhost

public void drawGhost(Graphics g)

Draws a ghost while the selected objects are being moved.

Overrides:

drawGhost in class IlvMoveRectangleInteractor

Parameters:

g - The Graphics.

See Also:

IlvManagerViewInteractor.handleExpose(java.awt.Graphics), IlvManagerViewInteractor.setXORGhost(boolean)

trigger

protected boolean trigger(AWTEvent event,
                          double dx,
                          double dy)

Called when the user releases the mouse button. If the IlvSelectInteractor is not in opaqueMove, this method will call translateSelections to perform the selection translation.

Overrides:

trigger in class IlvMoveRectangleInteractor

Parameters:

event - The event that launches the method.

dx - The x translation of the rectangle.

dy - The y translation of the rectangle.

See Also:

translateSelections(double, double)

rectangleDragged

protected void rectangleDragged(AWTEvent event,
                                double dx,
                                double dy)

Called each time the selection is dragged. If the IlvSelectInteractor is in opaqueMove, this method will call translateSelections to perform the selection translation.

Overrides:

rectangleDragged in class IlvMoveRectangleInteractor

Parameters:

event - The event that launches the method.

dx - The x translation of the rectangle.

dy - The y translation of the rectangle.

See Also:

translateSelections(double, double)

translateSelections

protected void translateSelections(double dx,
                                   double dy)

This method is called to translate selected objects. Its default behavior is to call the IlvManager.translateObjects(ilog.views.IlvGraphicEnumeration, double, double, ilog.views.IlvTransformer) method on the manager and pass the selected objects obtained with IlvSelectInteractor.getSelectedMovingObjects(ilog.views.IlvManager). This manager is obtained by calling the method IlvSelectInteractor.getMoveSelectionManager() on the the associated IlvSelectInteractor (see getSelectInteractor()).

Parameters:

dx - The x translation of the rectangle.

dy - The y translation of the rectangle.