de.tesis.dynaware.grapheditor.window

Class PanningWindow

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

de.tesis.dynaware.grapheditor.window.PanningWindow

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

Direct Known Subclasses:

GraphEditorContainer

public class PanningWindow
extends javafx.scene.layout.Region

A window over a large Region of content.

This window can be panned around relative to its content. Only the parts of the content that are inside the window will be rendered. Everything outside it is clipped.

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	windowX The property for the x coordinate of the window relative to the top-left corner of the content.
javafx.beans.property.DoubleProperty	windowY The property for the y coordinate of the window relative to the top-left corner of the content.

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected javafx.event.EventHandler<javafx.scene.input.MouseEvent>	mouseDraggedHandler
protected javafx.event.EventHandler<javafx.scene.input.MouseEvent>	mousePressedHandler
protected javafx.event.EventHandler<javafx.scene.input.MouseEvent>	mouseReleasedHandler

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
PanningWindow() Creates a new PanningWindow.

Method Summary

Modifier and Type	Method and Description
void	checkWindowBounds() Checks that the window bounds are completely inside the content bounds, and repositions if necessary.
boolean	isCacheWhileMouseOutside() Gets whether the content's cache will be set to true when the mouse is outside the panning window.
boolean	isCacheWhilePanning() Gets whether the content's cache will be set to true on the content while panning.
void	panBy(double x, double y) Pans the window by the specified x and y values.
void	panTo(double x, double y) Pans the window to the specified x and y coordinates.
void	panTo(WindowPosition position) Pans the window to the given position.
void	setCacheWhileMouseOutside(boolean cacheWhileMouseOutside) Sets whether the content's cache will be set to true when the mouse is outside the panning window.
void	setCacheWhilePanning(boolean cacheWhilePanning) Sets the content cache value while panning is active.
protected void	setContent(javafx.scene.layout.Region content) Sets the content of the panning window.
javafx.beans.property.DoubleProperty	windowXProperty() The property for the x coordinate of the window relative to the top-left corner of the content.
javafx.beans.property.DoubleProperty	windowYProperty() The property for the y coordinate of the window relative to the top-left corner of the content.

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

accGetAttribute, getBaselineOffset, getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accExecuteAction, accSendNotification, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessible, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

windowX

public javafx.beans.property.DoubleProperty windowXProperty

The property for the x coordinate of the window relative to the top-left corner of the content.

windowY

public javafx.beans.property.DoubleProperty windowYProperty

The property for the y coordinate of the window relative to the top-left corner of the content.

Field Detail

mousePressedHandler

protected javafx.event.EventHandler<javafx.scene.input.MouseEvent> mousePressedHandler

mouseDraggedHandler

protected javafx.event.EventHandler<javafx.scene.input.MouseEvent> mouseDraggedHandler

mouseReleasedHandler

protected javafx.event.EventHandler<javafx.scene.input.MouseEvent> mouseReleasedHandler

Constructor Detail

PanningWindow

public PanningWindow()

Creates a new PanningWindow.

Method Detail

panTo

public void panTo(double x,
                  double y)

Pans the window to the specified x and y coordinates.

The window cannot be panned outside the content. When the window 'hits the edge' of the content it will stop.

Parameters:

x - the x position of the window relative to the top-left corner of the content

y - the y position of the window relative to the top-left corner of the content

panBy

public void panBy(double x,
                  double y)

Pans the window by the specified x and y values.

The window cannot be panned outside the content. When the window 'hits the edge' of the content it will stop.

Parameters:

x - the horizontal distance to move the window by

y - the vertical distance to move the window by

panTo

public void panTo(WindowPosition position)

Pans the window to the given position.

Note:
The current width & height values of the window and its content are used in this method. It should therefore be called after the scene has been drawn.

Parameters:

position - the WindowPosition to pan to

windowXProperty

public javafx.beans.property.DoubleProperty windowXProperty()

The property for the x coordinate of the window relative to the top-left corner of the content.

windowYProperty

public javafx.beans.property.DoubleProperty windowYProperty()

The property for the y coordinate of the window relative to the top-left corner of the content.

checkWindowBounds

public void checkWindowBounds()

Checks that the window bounds are completely inside the content bounds, and repositions if necessary.

Also checks that the window position values are integers to ensure strokes are drawn cleanly.

isCacheWhilePanning

public boolean isCacheWhilePanning()

Gets whether the content's cache will be set to true on the content while panning.

Returns:

true if the content will be cached while panning is active

See Also:

Node.setCache(boolean)

setCacheWhilePanning

public void setCacheWhilePanning(boolean cacheWhilePanning)

Sets the content cache value while panning is active. Defaults to true.

If this is set to true, large graphs will pan more smoothly but require more memory.

Warning: currently works like crap if the content has a scale transform applied to it.

Parameters:

cacheWhilePanning - true if the content will be cached while panning is active

isCacheWhileMouseOutside

public boolean isCacheWhileMouseOutside()

Gets whether the content's cache will be set to true when the mouse is outside the panning window.

Returns:

true if the content will be cached while the mouse is outside the panning window

See Also:

Node.setCache(boolean)

setCacheWhileMouseOutside

public void setCacheWhileMouseOutside(boolean cacheWhileMouseOutside)

Sets whether the content's cache will be set to true when the mouse is outside the panning window.

If the mouse is dragged outside while the primary mouse button is down, the cache will not be turned on until the button is released.

Experimental API. False by default.

Parameters:

cacheWhileMouseOutside - true if the content will be cached while the mouse is outside

setContent

protected void setContent(javafx.scene.layout.Region content)

Sets the content of the panning window.

Note that the content's managed attribute will be set to false. Its size must therefore be set manually using the resize() method of the Node class.

Parameters:

content - the Region to be displayed inside the panning window