SwingNode (JavaFX 8.0)

java.lang.Object
- javafx.scene.Node
- - javafx.embed.swing.SwingNode

All Implemented Interfaces:: Styleable, EventTarget

public class SwingNode
extends Node

This class is used to embed a Swing content into a JavaFX application. The content to be displayed is specified with the setContent(javax.swing.JComponent) method that accepts an instance of Swing JComponent. The hierarchy of components contained in the JComponent instance should not contain any heavyweight components, otherwise SwingNode may fail to paint it. The content gets repainted automatically. All the input and focus events are forwarded to the JComponent instance transparently to the developer.

Here is a typical pattern which demonstrates how SwingNode can be used:

     public class SwingFx extends Application {

         private SwingNode swingNode;

         @Override
         public void start(Stage stage) {
             swingNode = new SwingNode();

             createAndSetSwingContent();

             StackPane pane = new StackPane();
             pane.getChildren().add(swingNode);

             stage.setScene(new Scene(pane, 100, 50));
             stage.show();
         }

         private void createAndSetSwingContent() {
             SwingUtilities.invokeLater(new Runnable() {
                 @Override
                 public void run() {
                     swingNode.setContent(new JButton("Click me!"));
                 }
             });
         }
     }

Property Summary
- Properties inherited from class javafx.scene.Node
  blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Constructor Summary

Constructors
Constructor and Description

SwingNode()
Constructs a new instance of SwingNode.

Constructors
Constructor and Description
`SwingNode()` Constructs a new instance of `SwingNode`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.swing.JComponent`	`getContent()` Returns the `JComponent` instance attached to this `SwingNode`.
`protected boolean`	`impl_computeContains(double localX, double localY)`
`com.sun.javafx.geom.BaseBounds`	`impl_computeGeomBounds(com.sun.javafx.geom.BaseBounds bounds, com.sun.javafx.geom.transform.BaseTransform tx)` Computes the geometric bounds for this Node.
`protected com.sun.javafx.sg.PGNode`	`impl_createPGNode()`
`java.lang.Object`	`impl_processMXNode(com.sun.javafx.jmx.MXNodeAlgorithm alg, com.sun.javafx.jmx.MXNodeAlgorithmContext ctx)` This method is used by Scene-graph JMX bean to obtain the Scene-graph structure.
`void`	`impl_updatePG()` This function is called during synchronization to update the state of the PG Node from the FX Node.
`boolean`	`isResizable()` Indicates whether this node is a type which can be resized by its parent.
`double`	`maxHeight(double width)` Returns the node's maximum height for use in layout calculations.
`double`	`maxWidth(double height)` Returns the node's maximum width for use in layout calculations.
`double`	`minHeight(double width)` Returns the node's minimum height for use in layout calculations.
`double`	`minWidth(double height)` Returns the node's minimum width for use in layout calculations.
`double`	`prefHeight(double width)` Returns the node's preferred height for use in layout calculations.
`double`	`prefWidth(double height)` Returns the node's preferred width for use in layout calculations.
`void`	`resize(double width, double height)` If the node is resizable, will set its layout bounds to the specified width and height.
`void`	`setContent(javax.swing.JComponent content)` Attaches a `JComponent` instance to display in this `SwingNode`.

Methods inherited from class javafx.scene.Node
addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBaselineOffset, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCssMetaData, 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, 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, lookup, 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

- Constructor Detail
  - SwingNode
```
public SwingNode()
```
    Constructs a new instance of SwingNode.
- Method Detail
  - setContent
```
public void setContent(javax.swing.JComponent content)
```
    Attaches a JComponent instance to display in this SwingNode.
    The method can be called either on the JavaFX Application thread or the Swing thread. Note however, that access to a Swing component must occur from the Swing thread according to the Swing threading restrictions.
    
    Parameters:
    
    content - a Swing component to display in this SwingNode
    
    See Also:
    
    EventQueue.isDispatchThread(), Platform.isFxApplicationThread()
  - getContent
```
public javax.swing.JComponent getContent()
```
    Returns the JComponent instance attached to this SwingNode.
    The method can be called either on the JavaFX Application thread or the Swing thread. Note however, that access to a Swing component must occur from the Swing thread according to the Swing threading restrictions.
    
    Returns:
    
    the Swing component attached to this SwingNode
    
    See Also:
    
    EventQueue.isDispatchThread(), Platform.isFxApplicationThread()
  - isResizable
```
public boolean isResizable()
```
    Description copied from class: Node
    
    Indicates whether this node is a type which can be resized by its parent. If this method returns true, then the parent will resize the node (ideally within its size range) by calling node.resize(width,height) during the layout pass. All Regions, Controls, and WebView are resizable classes which depend on their parents resizing them during layout once all sizing and CSS styling information has been applied.
    If this method returns false, then the parent cannot resize it during layout (resize() is a no-op) and it should return its layoutBounds for minimum, preferred, and maximum sizes. Group, Text, and all Shapes are not resizable and hence depend on the application to establish their sizing by setting appropriate properties (e.g. width/height for Rectangle, text on Text, and so on). Non-resizable nodes may still be relocated during layout.
    
    Overrides:
    
    isResizable in class Node
    
    Returns:
    
    whether or not this node type can be resized by its parent during layout
    
    See Also:
    
    Node.getContentBias(), Node.minWidth(double), Node.minHeight(double), Node.prefWidth(double), Node.prefHeight(double), Node.maxWidth(double), Node.maxHeight(double), Node.resize(double, double), Node.getLayoutBounds()
  - resize
```
public void resize(double width,
                   double height)
```
    Description copied from class: Node
    
    If the node is resizable, will set its layout bounds to the specified width and height. If the node is not resizable, this method is a no-op.
    This method should generally only be called by parent nodes from their layoutChildren() methods. All Parent classes will automatically resize resizable children, so resizing done directly by the application will be overridden by the node's parent, unless the child is unmanaged.
    Parents are responsible for ensuring the width and height values fall within the resizable node's preferred range. The autosize() method may be used if the parent just needs to resize the node to its preferred size.
    
    Overrides:
    
    resize in class Node
    
    Parameters:
    
    width - the target layout bounds width
    
    height - the target layout bounds height
    
    See Also:
    
    Node.isResizable(), Node.getContentBias(), Node.autosize(), Node.minWidth(double), Node.minHeight(double), Node.prefWidth(double), Node.prefHeight(double), Node.maxWidth(double), Node.maxHeight(double), Node.getLayoutBounds()
  - maxWidth
```
public double maxWidth(double height)
```
    Description copied from class: Node
    
    Returns the node's maximum width for use in layout calculations. If the node is resizable, its parent should not resize its width any larger than this value. A value of Double.MAX_VALUE indicates the parent may expand the node's width beyond its preferred without limits.
    If the node is not resizable, returns its layoutBounds width.
    Layout code which calls this method should first check the content-bias of the node. If the node has a vertical content-bias, then callers should pass in a height value that the maximum width should be based on. If the node has either a horizontal or null content-bias, then the caller should pass in -1.
    Node subclasses with a vertical content-bias should honor the height parameter whether -1 or a positive value. All other subclasses may ignore the height parameter (which will likely be -1).
    If Node's Node.minWidth(double) is greater, it should take precedence over the maxWidth. This means the Node should never be resized below minWidth.
    
    Overrides:
    
    maxWidth in class Node
    
    Parameters:
    
    height - the height that should be used if maximum width depends on it
    
    Returns:
    
    the maximum width that the node should be resized to during layout
    
    See Also:
    
    Node.isResizable(), Node.getContentBias()
  - maxHeight
```
public double maxHeight(double width)
```
    Description copied from class: Node
    
    Returns the node's maximum height for use in layout calculations. If the node is resizable, its parent should not resize its height any larger than this value. A value of Double.MAX_VALUE indicates the parent may expand the node's height beyond its preferred without limits.
    If the node is not resizable, returns its layoutBounds height.
    Layout code which calls this method should first check the content-bias of the node. If the node has a horizontal content-bias, then callers should pass in a width value that the maximum height should be based on. If the node has either a vertical or null content-bias, then the caller should pass in -1.
    Node subclasses with a horizontal content-bias should honor the width parameter whether -1 or a positive value. All other subclasses may ignore the width parameter (which will likely be -1).
    If Node's Node.minHeight(double) is greater, it should take precedence over the maxHeight. This means the Node should never be resized below minHeight.
    
    Overrides:
    
    maxHeight in class Node
    
    Parameters:
    
    width - the width that should be used if maximum height depends on it
    
    Returns:
    
    the maximum height that the node should be resized to during layout
    
    See Also:
    
    Node.isResizable(), Node.getContentBias()
  - prefWidth
```
public double prefWidth(double height)
```
    Description copied from class: Node
    
    Returns the node's preferred width for use in layout calculations. If the node is resizable, its parent should treat this value as the node's ideal width within its range. If the node is not resizable, just returns its layoutBounds width, which should be treated as the rigid width of the node.
    Layout code which calls this method should first check the content-bias of the node. If the node has a vertical content-bias, then callers should pass in a height value that the preferred width should be based on. If the node has either a horizontal or null content-bias, then the caller should pass in -1.
    Node subclasses with a vertical content-bias should honor the height parameter whether -1 or a positive value. All other subclasses may ignore the height parameter (which will likely be -1).
    
    Overrides:
    
    prefWidth in class Node
    
    Parameters:
    
    height - the height that should be used if preferred width depends on it
    
    Returns:
    
    the preferred width that the node should be resized to during layout
    
    See Also:
    
    Node.isResizable(), Node.getContentBias(), Node.autosize()
  - prefHeight
```
public double prefHeight(double width)
```
    Description copied from class: Node
    
    Returns the node's preferred height for use in layout calculations. If the node is resizable, its parent should treat this value as the node's ideal height within its range. If the node is not resizable, just returns its layoutBounds height, which should be treated as the rigid height of the node.
    Layout code which calls this method should first check the content-bias of the node. If the node has a horizontal content-bias, then callers should pass in a width value that the preferred height should be based on. If the node has either a vertical or null content-bias, then the caller should pass in -1.
    Node subclasses with a horizontal content-bias should honor the height parameter whether -1 or a positive value. All other subclasses may ignore the height parameter (which will likely be -1).
    
    Overrides:
    
    prefHeight in class Node
    
    Parameters:
    
    width - the width that should be used if preferred height depends on it
    
    Returns:
    
    the preferred height that the node should be resized to during layout
    
    See Also:
    
    Node.getContentBias(), Node.autosize()
  - minWidth
```
public double minWidth(double height)
```
    Description copied from class: Node
    
    Returns the node's minimum width for use in layout calculations. If the node is resizable, its parent should not resize its width any smaller than this value. If the node is not resizable, returns its layoutBounds width.
    Layout code which calls this method should first check the content-bias of the node. If the node has a vertical content-bias, then callers should pass in a height value that the minimum width should be based on. If the node has either a horizontal or null content-bias, then the caller should pass in -1.
    Node subclasses with a vertical content-bias should honor the height parameter whether -1 or a positive value. All other subclasses may ignore the height parameter (which will likely be -1).
    If Node's Node.maxWidth(double) is lower than this number, minWidth takes precedence. This means the Node should never be resized below minWidth.
    
    Overrides:
    
    minWidth in class Node
    
    Parameters:
    
    height - the height that should be used if minimum width depends on it
    
    Returns:
    
    the minimum width that the node should be resized to during layout
    
    See Also:
    
    Node.isResizable(), Node.getContentBias()
  - minHeight
```
public double minHeight(double width)
```
    Description copied from class: Node
    
    Returns the node's minimum height for use in layout calculations. If the node is resizable, its parent should not resize its height any smaller than this value. If the node is not resizable, returns its layoutBounds height.
    Layout code which calls this method should first check the content-bias of the node. If the node has a horizontal content-bias, then callers should pass in a width value that the minimum height should be based on. If the node has either a vertical or null content-bias, then the caller should pass in -1.
    Node subclasses with a horizontal content-bias should honor the width parameter whether -1 or a positive value. All other subclasses may ignore the width parameter (which will likely be -1).
    If Node's Node.maxHeight(double) is lower than this number, minHeight takes precedence. This means the Node should never be resized below minHeight.
    
    Overrides:
    
    minHeight in class Node
    
    Parameters:
    
    width - the width that should be used if minimum height depends on it
    
    Returns:
    
    the minimum height that the node should be resized to during layout
    
    See Also:
    
    Node.isResizable(), Node.getContentBias()
  - impl_computeContains
```
protected boolean impl_computeContains(double localX,
                                       double localY)
```
    Specified by:
    
    impl_computeContains in class Node
  - impl_createPGNode
```
protected com.sun.javafx.sg.PGNode impl_createPGNode()
```
    Specified by:
    
    impl_createPGNode in class Node
  - impl_updatePG
```
public void impl_updatePG()
```
    Description copied from class: Node
    
    This function is called during synchronization to update the state of the PG Node from the FX Node. Subclasses of Node should override this method and must call super.impl_updatePG()
    
    Overrides:
    
    impl_updatePG in class Node
  - impl_computeGeomBounds
```
public com.sun.javafx.geom.BaseBounds impl_computeGeomBounds(com.sun.javafx.geom.BaseBounds bounds,
                                                             com.sun.javafx.geom.transform.BaseTransform tx)
```
    Description copied from class: Node
    
    Computes the geometric bounds for this Node. This method is abstract and must be implemented by each Node subclass.
    
    Specified by:
    
    impl_computeGeomBounds in class Node
  - impl_processMXNode
```
public java.lang.Object impl_processMXNode(com.sun.javafx.jmx.MXNodeAlgorithm alg,
                                           com.sun.javafx.jmx.MXNodeAlgorithmContext ctx)
```
    Description copied from class: Node
    
    This method is used by Scene-graph JMX bean to obtain the Scene-graph structure.
    
    Specified by:
    
    impl_processMXNode in class Node
    
    Parameters:
    
    alg - current algorithm to process this node
    
    ctx - current context
    
    Returns:
    
    the algorithm specific result for this node

Class SwingNode

Property Summary

Properties inherited from class javafx.scene.Node

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Constructor Detail

SwingNode

Method Detail

setContent

getContent

isResizable

resize

maxWidth

maxHeight

prefWidth

prefHeight

minWidth

minHeight

impl_computeContains

impl_createPGNode

impl_updatePG

impl_computeGeomBounds

impl_processMXNode