de.tesis.dynaware.grapheditor.window

Class AutoScrollingParameters

java.lang.Object

de.tesis.dynaware.grapheditor.window.AutoScrollingParameters

public class AutoScrollingParameters
extends java.lang.Object

The parameters controlling the auto-scrolling rate. Change at your own risk.

Constructor Summary

Constructors

Constructor and Description
AutoScrollingParameters()

Method Summary

Modifier and Type	Method and Description
double	getBaseJumpAmount() Gets the amount by which the window jumps when the cursor is dragged to the window-edge.
double	getInsetToBeginScroll() Gets the inset from the window-edge where auto-scrolling will begin.
double	getJumpAmountIncreasePerJump() Gets how much (in pixels) that the jump-amount increases with each jump.
double	getJumpPeriod() Gets the interval at which auto-scroll 'jumps' occur when the cursor is dragged outside the window.
double	getMaxJumpAmount() Gets the maximum amount by which the window will jump when the cursor is dragged far outside the window.
void	setBaseJumpAmount(double baseJumpAmount) Sets the amount by which the window will jump when the cursor is dragged to the window-edge.
void	setInsetToBeginScroll(double insetToBeginScroll) Sets the inset from the window-edge where auto-scrolling will begin.
void	setJumpAmountIncreasePerJump(double jumpAmountIncreasePerJump) Sets how much (in pixels) that the jump-amount increases with each jump.
void	setJumpPeriod(double jumpPeriod) Sets the interval at which auto-scroll 'jumps' occur when the cursor is dragged outside the window.
void	setMaxJumpAmount(double maxJumpAmount) Gets the maximum amount by which the window will jump when the cursor is dragged far outside the window.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoScrollingParameters

public AutoScrollingParameters()

Method Detail

getJumpPeriod

public double getJumpPeriod()

Gets the interval at which auto-scroll 'jumps' occur when the cursor is dragged outside the window.

Returns:

the jump period in milliseconds

setJumpPeriod

public void setJumpPeriod(double jumpPeriod)

Sets the interval at which auto-scroll 'jumps' occur when the cursor is dragged outside the window.

Defaults to 25ms. It shouldn't be necessary to change this unless performance is slow.

Parameters:

jumpPeriod - a value in milliseconds

getBaseJumpAmount

public double getBaseJumpAmount()

Gets the amount by which the window jumps when the cursor is dragged to the window-edge.

Returns:

the jump amount in pixels

setBaseJumpAmount

public void setBaseJumpAmount(double baseJumpAmount)

Sets the amount by which the window will jump when the cursor is dragged to the window-edge.

Defaults to 10 pixels.

Parameters:

baseJumpAmount - a value in pixels

getMaxJumpAmount

public double getMaxJumpAmount()

Gets the maximum amount by which the window will jump when the cursor is dragged far outside the window.

Returns:

maxJumpAmount the maximum jump-amount in pixels

setMaxJumpAmount

public void setMaxJumpAmount(double maxJumpAmount)

Gets the maximum amount by which the window will jump when the cursor is dragged far outside the window.

getJumpAmountIncreasePerJump

public double getJumpAmountIncreasePerJump()

Gets how much (in pixels) that the jump-amount increases with each jump.

Returns:

the amount that the jump-amount increases with each jump

setJumpAmountIncreasePerJump

public void setJumpAmountIncreasePerJump(double jumpAmountIncreasePerJump)

Sets how much (in pixels) that the jump-amount increases with each jump.

This leads to an "acceleration" effect. Defaults to 0.5.

Parameters:

jumpAmountIncreasePerJump - the amount that the jump-amount increases with each jump

getInsetToBeginScroll

public double getInsetToBeginScroll()

Gets the inset from the window-edge where auto-scrolling will begin.

Returns:

the inset from the window-edge where auto-scrolling begins

setInsetToBeginScroll

public void setInsetToBeginScroll(double insetToBeginScroll)

Sets the inset from the window-edge where auto-scrolling will begin.

Defaults to 1 pixel. Should not be 0 if the graph-editor can be full-screen.

Parameters:

insetToBeginScroll - the inset from the window-edge where auto-scrolling begins