org.eclipse.gef4.mvc.fx.policies

Class FXZoomOnScrollPolicy

java.lang.Object

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

org.eclipse.gef4.mvc.fx.policies.AbstractFXOnScrollPolicy

org.eclipse.gef4.mvc.fx.policies.FXZoomOnScrollPolicy

All Implemented Interfaces:

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

public class FXZoomOnScrollPolicy
extends AbstractFXOnScrollPolicy

The FXZoomOnScrollPolicy is an AbstractFXOnScrollPolicy that scales the viewport when the user scroll with the mouse wheel while pressing either <Control> or <Alt>.

Constructor Summary

Constructors

Constructor and Description
FXZoomOnScrollPolicy()

Method Summary

Modifier and Type	Method and Description
protected boolean	isZoom(javafx.scene.input.ScrollEvent event) Returns true if the given ScrollEvent should trigger zooming.
void	scroll(javafx.scene.input.ScrollEvent event) This callback method is invoked when the user performs mouse scrolling over the host.
void	zoomRelative(double relativeZoom, double sceneX, double sceneY) Scales the viewport by the given relativeZoom factor around the given pivot point in scene coordinates.

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

Constructor Detail

FXZoomOnScrollPolicy

public FXZoomOnScrollPolicy()

Method Detail

isZoom

protected boolean isZoom(javafx.scene.input.ScrollEvent event)

Returns true if the given ScrollEvent should trigger zooming. Otherwise returns false. Per default, either <Control> or <Alt> has to be pressed so that true is returned.

Parameters:

event - The ScrollEvent in question.

Returns:

true if the given ScrollEvent should trigger zooming, otherwise false.

scroll

public void scroll(javafx.scene.input.ScrollEvent event)

Description copied from class: AbstractFXOnScrollPolicy

This callback method is invoked when the user performs mouse scrolling over the host.

Specified by:

scroll in class AbstractFXOnScrollPolicy

Parameters:

event - The original ScrollEvent.

zoomRelative

public void zoomRelative(double relativeZoom,
                         double sceneX,
                         double sceneY)

Scales the viewport by the given relativeZoom factor around the given pivot point in scene coordinates.

Parameters:

relativeZoom - The scale factor.

sceneX - The pivot x-coordinate.

sceneY - The pivot y-coordinate.