ilog.views.interactor

Class IlvAbstractScrollInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvAbstractScrollInteractor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvDragRectangleInteractor, IlvMoveRectangleInteractor

public abstract class IlvAbstractScrollInteractor
extends IlvManagerViewInteractor

The IlvAbstractScrollInteractor is a base class for interactors that scroll the view while dragging the mouse.

Since:

JViews 8.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvAbstractScrollInteractor() Creates a new instance of IlvAbstractScrollInteractor.

Method Summary

Modifier and Type	Method and Description
protected void	adjustPointIfOutsideView(IlvPoint p, IlvPoint q) Corrects the input point p so that if p is outside the view, it is only a limited amount outside the view.
protected void	detach() Called when the interactor is detached from the current manager view.
protected boolean	doAutoScroll(MouseEvent event) Checks whether the input event should start the dragging scroll timer.
protected abstract boolean	dragscroll(MouseEvent event) Called by the dragging scroll timer to scroll the view.
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.
boolean	isProgressiveScroll() Returns whether progressive scrolling is enabled.
void	setMaximumScrollDistance(double distance) Sets the maximal distance of scroll operations when the mouse moves outside the manager view.
void	setProgressiveScroll(boolean enable) Sets whether progressive scrolling is enabled.
void	setScrollTiming(int timing) Sets the timing of repetitive scroll operations when the mouse pointer moves outside the manager view.
protected void	startDraggingScrollTimer() Starts the dragging scroll timer.
protected void	stopDraggingScrollTimer() Stop the dragging scroll timer.

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, attach, disableEvents, drawGhost, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, isXORGhost, processEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, 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

IlvAbstractScrollInteractor

public IlvAbstractScrollInteractor()

Creates a new instance of IlvAbstractScrollInteractor.

Method Detail

setScrollTiming

public void setScrollTiming(int timing)

Sets the timing of repetitive scroll operations when the mouse pointer moves outside the manager view. When the mouse pointer moves outside the view while dragging the rectangle, and IlvManagerViewInteractor.ensureVisible(ilog.views.IlvPoint) is allowed, the view starts scrolling in order to make the dragged rectangle visible. If the scroll timing is zero, the view only scrolls when the mouse moves. If the scroll timing is larger than zero, the interactor triggers repetitive scroll operations automatically, that is, the view continues scrolling as long as the mouse pointer is outside the view, even if the mouse pointer does not move. The scroll timing is the time in milliseconds between triggering two scroll operations. Usual timings are between 50 and 1000 ms. By default, the scroll timing is 0.

See Also:

IlvManagerViewInteractor.allowEnsureVisible(), getScrollTiming()

getScrollTiming

public int getScrollTiming()

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

See Also:

setScrollTiming(int)

setMaximumScrollDistance

public void setMaximumScrollDistance(double distance)

Sets the maximal distance of scroll operations when the mouse moves outside the manager view. When the mouse pointer moves outside the view while dragging the rectangle, and IlvManagerViewInteractor.ensureVisible(ilog.views.IlvPoint) is allowed, the view starts scrolling in order to make the dragged rectangle visible. The scroll operations can be repetitive (see setScrollTiming(int)). The speed of the scrolling depends on the scroll timing but also on the distance the view is translated in each scroll step. If the maximum scroll distance is below zero, the scroll distance is unlimited and depends on the how far the mouse pointer is outside the view. If the maximum scroll distance is a positive number, the scroll distance is limited, that is, the view is translated in each scroll step at most this distance. By default, the maximum scroll distance is -1.

See Also:

setScrollTiming(int), setProgressiveScroll(boolean), IlvManagerViewInteractor.allowEnsureVisible(), getMaximumScrollDistance()

getMaximumScrollDistance

public double getMaximumScrollDistance()

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

See Also:

setMaximumScrollDistance(double)

setProgressiveScroll

public void setProgressiveScroll(boolean enable)

Sets whether progressive scrolling is enabled. When the mouse pointer moves outside the view while dragging the rectangle, and IlvManagerViewInteractor.ensureVisible(ilog.views.IlvPoint) is allowed, the view starts scrolling in order to make the dragged rectangle visible. When a maximum scroll distance is given, the view scrolls only a limited amount for each event. If progressive scrolling is enabled, the amount depends on the distance of the mouse pointer outside the view. If progressive scrolling is disabled, the scroll amount is constant. This option has only an effect if the maximum scroll distance is a positive number. By default, progressive scrolling is enabled.

See Also:

isProgressiveScroll(), setMaximumScrollDistance(double), IlvManagerViewInteractor.allowEnsureVisible()

isProgressiveScroll

public boolean isProgressiveScroll()

Returns whether progressive scrolling is enabled.

See Also:

setProgressiveScroll(boolean)

detach

protected void detach()

Called when the interactor is detached from the current manager view.

Overrides:

detach in class IlvManagerViewInteractor

See Also:

IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)

dragscroll

protected abstract boolean dragscroll(MouseEvent event)

Called by the dragging scroll timer to scroll the view.

doAutoScroll

protected boolean doAutoScroll(MouseEvent event)

Checks whether the input event should start the dragging scroll timer. If the event is outside the view and automatic repetitive scrolling is enabled, it starts the dragging scroll timer which will call dragscroll(java.awt.event.MouseEvent) repetitively until the mouse is inside the view again.

Parameters:

event - The event.

Returns:

true if the event has been processed, false otherwise.

startDraggingScrollTimer

protected void startDraggingScrollTimer()

Starts the dragging scroll timer.

stopDraggingScrollTimer

protected void stopDraggingScrollTimer()

Stop the dragging scroll timer.

adjustPointIfOutsideView

protected void adjustPointIfOutsideView(IlvPoint p,
                                        IlvPoint q)

Corrects the input point p so that if p is outside the view, it is only a limited amount outside the view. If p is inside the view, it does nothing. The purpose of this correction is to limit the view shifting caused by IlvManagerViewInteractor.ensureVisible(ilog.views.IlvPoint).

Parameters:

p - The point to be corrected.

q - The reference point before the dragging.