jfxtras.labs.scene.control

Class Magnifier

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.control.Control

jfxtras.labs.scene.control.Magnifier

All Implemented Interfaces:

javafx.event.EventTarget, javafx.scene.control.Skinnable

public class Magnifier
extends javafx.scene.control.Control

A control which allows the subsection of its content to be magnified when the mouse hovers over it.

Note : When the magnifier is activated mode, the contents inside this control are not accessible.

Example :

 Magnifier magnifier = new Magnifier();
 magnifier.setContent(someNode);
 or
 Magnifier magnifier = new Magnifier(someNode);
 

Property Summary

Properties

Type	Property and Description
javafx.beans.property.BooleanProperty	active Controls the magnifier whether to activate or not.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	content The content associated with the magnifier.
javafx.beans.property.DoubleProperty	frameWidth Property for setting the frame width of the circular viewer.
javafx.beans.property.DoubleProperty	radius Property for setting the radius of the circular viewer.
javafx.beans.property.BooleanProperty	resizableOnScroll Controls the magnifier whether to resize the viewer on mouse scroll or not.
javafx.beans.property.BooleanProperty	scalableOnScroll Controls the magnifier whether to scale the content on mouse scroll or not.
javafx.beans.property.DoubleProperty	scaleFactor Property for setting the scale factor to which the content need to be magnified.
javafx.beans.property.BooleanProperty	scopeLinesVisible Controls whether lines are displayed to show in the magnifier viewer.
javafx.beans.property.DoubleProperty	scopeLineWidth Property for setting the width of the scope lines that are visible in the circular viewer.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, heightProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, prefHeightProperty, prefWidthProperty, skinClassNameProperty, skinProperty, tooltipProperty, 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, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, 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 inherited from class javafx.scene.control.Control

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
Magnifier() Creates a magnifier pane with empty content.
Magnifier(javafx.scene.Node node) Creates a magnifier pane with the provided content.

Method Summary

Methods

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	activeProperty() Controls the magnifier whether to activate or not.
javafx.beans.property.ObjectProperty<javafx.scene.Node>	contentProperty() The content associated with the magnifier.
javafx.beans.property.DoubleProperty	frameWidthProperty() Property for setting the frame width of the circular viewer.
javafx.scene.Node	getContent() Gets the content of the magnifier.
double	getFrameWidth() Gets the value of the property frameWidth.
double	getRadius() Gets the value of the property radius.
double	getScaleFactor() Gets the value of the property scaleFactor.
double	getScopeLineWidth() Gets the value of the property scopeLineWidth.
protected java.lang.String	getUserAgentStylesheet() Return the path to the CSS file so things are setup right
boolean	isActive() Gets the value of the property active.
boolean	isResizableOnScroll() Gets the value of the property resizableOnScroll.
boolean	isScalableOnScroll() Gets the value of the property scalableOnScroll.
boolean	isScopeLinesVisible() Gets the value of the property scopeLinesVisible.
javafx.beans.property.DoubleProperty	radiusProperty() Property for setting the radius of the circular viewer.
javafx.beans.property.BooleanProperty	resizableOnScrollProperty() Controls the magnifier whether to resize the viewer on mouse scroll or not.
javafx.beans.property.BooleanProperty	scalableOnScrollProperty() Controls the magnifier whether to scale the content on mouse scroll or not.
javafx.beans.property.DoubleProperty	scaleFactorProperty() Property for setting the scale factor to which the content need to be magnified.
javafx.beans.property.BooleanProperty	scopeLinesVisibleProperty() Controls whether lines are displayed to show in the magnifier viewer.
javafx.beans.property.DoubleProperty	scopeLineWidthProperty() Property for setting the width of the scope lines that are visible in the circular viewer.
void	setActive(boolean paramActivate) Sets the value of the property active.
void	setContent(javafx.scene.Node value) Sets the content of the magnifier.
void	setFrameWidth(double paramFrameWidth) Sets the value of the property frameWidth.
void	setRadius(double paramRadius) Sets the value of the property radius.
void	setResizableOnScroll(boolean paramResizableOnScroll) Sets the value of the property resizableOnScroll.
void	setScalableOnScroll(boolean paramScalableOnScroll) Sets the value of the property scalableOnScroll.
void	setScaleFactor(double paramScaleFactor) Sets the value of the property scaleFactor.
void	setScopeLinesVisible(boolean paramScopeLinesVisible) Sets the value of the property scopeLinesVisible.
void	setScopeLineWidth(double paramScopeLineWidth) Sets the value of the property scopeLineWidth.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getSkin, getTooltip, getWidth, heightProperty, impl_computeContains, impl_computeLayoutBounds, impl_CSS_STYLEABLES, impl_cssGetFocusTraversableInitialValue, impl_getStyleableProperties, impl_notifyLayoutBoundsChanged, impl_processCSS, intersects, isResizable, layoutChildren, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, setContextMenu, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setSkinClassName, setTooltip, setWidth, skinClassNameProperty, skinProperty, tooltipProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_computeGeomBounds, impl_createPGNode, impl_cssResetInitialValues, impl_geomChanged, impl_getAllParentStylesheets, impl_pickNodeLocal, impl_pickNodeLocal, impl_processMXNode, impl_traversalEngineProperty, impl_updatePG, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, setImpl_traversalEngine, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, 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, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_createStyleHelper, impl_cssGetCursorInitialValue, impl_getLeafTransform, impl_getPGNode, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getPseudoClassState, impl_getStyleable, impl_getStyleHelper, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_pickNode, impl_pseudoClassStateChanged, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPGNode, impl_transformsChanged, impl_traverse, inputMethodRequestsProperty, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToSceneTransformProperty, lookupAll, managedProperty, mouseTransparentProperty, 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, pickOnBoundsProperty, pressedProperty, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, 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, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

radius

Property for setting the radius of the circular viewer. The default value is 86.0D.

See Also:

setRadius(double), getRadius()

frameWidth

Property for setting the frame width of the circular viewer. The default value is 5.5D.

See Also:

setFrameWidth(double), getFrameWidth()

scaleFactor

Property for setting the scale factor to which the content need to be magnified. The default value is 3.0D.

See Also:

setScaleFactor(double), getScaleFactor()

scopeLineWidth

Property for setting the width of the scope lines that are visible in the circular viewer. The default value is 1.5px.

See Also:

setScopeLineWidth(double), getScopeLineWidth()

scopeLinesVisible

Controls whether lines are displayed to show in the magnifier viewer. Default is false.

See Also:

setScopeLinesVisible(boolean), isScopeLinesVisible()

content

The content associated with the magnifier.

See Also:

setContent(Node), getContent()

active

Controls the magnifier whether to activate or not.

true Shows the magnified viewer on mouse over and does not allow to access the content inside the control. false Does not show the magnified viewer on mouse over and can access the content inside the control.

Default value is true

.

See Also:

setActive(boolean), isActive()

scalableOnScroll

Controls the magnifier whether to scale the content on mouse scroll or not. Content is scaled only when the mouse is scrolled in combination with CTRL key press.

true Allows the content to scale when mouse is scrolled in combination with CTRL key press. false Does not allow the content to scale when mouse is scrolled.

Default value is false

.