org.eclipse.gef4.mvc.fx.policies

Class FXPanOnTypePolicy

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.policies.AbstractFXOnTypePolicy

org.eclipse.gef4.mvc.fx.policies.FXPanOnTypePolicy

All Implemented Interfaces:

IAdaptable.Bound<IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>>, IPolicy<javafx.scene.Node>

public class FXPanOnTypePolicy
extends AbstractFXOnTypePolicy

The FXPanOnTypePolicy is an AbstractFXOnTypePolicy that performs viewport panning via the keyboard.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_SCROLL_AMOUNT_PER_SECOND The default scroll amount per second, i.e. how many pixels the viewport is moved per second.

Constructor Summary

Constructors

Constructor and Description
FXPanOnTypePolicy()

Method Summary

Modifier and Type	Method and Description
double	getScrollAmountPerSecond() Returns the amount of units scrolled per second when a direction key is pressed.
protected ViewportModel	getViewportModel() Returns the ViewportModel of the IViewer which the host belongs to.
void	pressed(javafx.scene.input.KeyEvent event) This callback method is invoked when the user presses a key while the host has keyboard focus.
void	released(javafx.scene.input.KeyEvent event) This callback method is invoked when the user releases a key while the host has keyboard focus.
protected void	updateScrollPosition() Computes the viewport translation and applies it to the viewport model.

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractPolicy

commit, disableRefreshVisuals, enableRefreshVisuals, getAdaptable, getHost, init, setAdaptable

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCROLL_AMOUNT_PER_SECOND

public static final double DEFAULT_SCROLL_AMOUNT_PER_SECOND

The default scroll amount per second, i.e. how many pixels the viewport is moved per second.

See Also:

Constant Field Values

Constructor Detail

FXPanOnTypePolicy

public FXPanOnTypePolicy()

Method Detail

getScrollAmountPerSecond

public double getScrollAmountPerSecond()

Returns the amount of units scrolled per second when a direction key is pressed.

Returns:

The amount of units scrolled per second when a direction key is pressed.

getViewportModel

protected ViewportModel getViewportModel()

Returns the ViewportModel of the IViewer which the host belongs to.

Returns:

The ViewportModel of the IViewer which the host belongs to.

pressed

public void pressed(javafx.scene.input.KeyEvent event)

Description copied from class: AbstractFXOnTypePolicy

This callback method is invoked when the user presses a key while the host has keyboard focus.

Specified by:

pressed in class AbstractFXOnTypePolicy

Parameters:

event - The original KeyEvent.

released

public void released(javafx.scene.input.KeyEvent event)

Description copied from class: AbstractFXOnTypePolicy

This callback method is invoked when the user releases a key while the host has keyboard focus.

Specified by:

released in class AbstractFXOnTypePolicy

Parameters:

event - The original KeyEvent.

updateScrollPosition

protected void updateScrollPosition()

Computes the viewport translation and applies it to the viewport model.