SwingNode

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

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 {

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

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

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

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

         public static void main(String[] args) {
             launch(args);
         }
     }

Since:: JavaFX 8.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`SwingNode.PostEventAction`
`private class`	`SwingNode.SwingKeyEventHandler`
`private class`	`SwingNode.SwingMouseEventHandler`
`private static class`	`SwingNode.SwingNodeWindowFocusListener`
`private class`	`SwingNode.SwingScrollEventHandler`

Field Summary

Fields
Modifier and Type	Field and Description
`private javax.swing.JComponent`	`content`
`private javax.swing.Timer`	`deactivate`
`private double`	`fxHeight`
`private double`	`fxWidth`
`private boolean`	`grabbed`
`private Window`	`hWindow`
`private static InteropFactory`	`iopFactoryInstance`
`private static boolean`	`isThreadMerged`
`private InvalidationListener`	`locationListener`
`private java.lang.Object`	`lwFrame`
`private java.util.concurrent.locks.ReentrantLock`	`paintLock`
`private NGExternalNode`	`peer`
`private java.util.List<java.lang.Runnable>`	`peerRequests`
`private <any>`	`sceneWindowListener`
`private boolean`	`skipBackwardUnrgabNotification`
`private int`	`swingMaxHeight`
`private int`	`swingMaxWidth`
`private int`	`swingMinHeight`
`private int`	`swingMinWidth`
`private int`	`swingPrefHeight`
`private int`	`swingPrefWidth`
`private SwingNodeInterop`	`swNodeIOP`
`private <any>`	`ungrabHandler`
`private EventHandler`	`windowHiddenHandler`
`private <any>`	`windowVisibleListener`

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
`private void`	`activateLwFrame(boolean activate)`
`private void`	`addSceneListeners(Scene scene)`
`private void`	`addWindowListeners(Window window)`
`private void`	`disposeLwFrame()`
`private boolean`	`doComputeContains(double localX, double localY)`
`private BaseBounds`	`doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)`
`private NGNode`	`doCreatePeer()`
`private void`	`doUpdatePeer()`
`javax.swing.JComponent`	`getContent()` Returns the `JComponent` instance attached to this `SwingNode`.
`private java.lang.Object`	`getLightweightFrame()`
`private java.util.concurrent.locks.ReentrantLock`	`getPaintLock()`
`boolean`	`isResizable()`
`private void`	`locateLwFrame()`
`double`	`maxHeight(double width)` Returns the `SwingNode`'s maximum height for use in layout calculations.
`double`	`maxWidth(double height)` Returns the `SwingNode`'s maximum width for use in layout calculations.
`double`	`minHeight(double width)` Returns the `SwingNode`'s minimum height for use in layout calculations.
`double`	`minWidth(double height)` Returns the `SwingNode`'s minimum width for use in layout calculations.
`private void`	`notifyNativeHandle(Window window)`
`double`	`prefHeight(double width)` Returns the `SwingNode`'s preferred height for use in layout calculations.
`double`	`prefWidth(double height)` Returns the `SwingNode`'s preferred width for use in layout calculations.
`private void`	`removeSceneListeners(Scene scene)`
`private void`	`removeWindowListeners(Window window)`
`(package private) void`	`repaintDirtyRegion(int dirtyX, int dirtyY, int dirtyWidth, int dirtyHeight)`
`void`	`resize(double width, double height)` Invoked by the `SwingNode`'s parent during layout to set the `SwingNode`'s width and height.
`void`	`setContent(javax.swing.JComponent content)` Attaches a `JComponent` instance to display in this `SwingNode`.
`private void`	`setContentImpl(javax.swing.JComponent content)`
`(package private) void`	`setImageBounds(int x, int y, int w, int h)`
`(package private) void`	`setImageBuffer(int[] data, int x, int y, int w, int h, int linestride, double scaleX, double scaleY)`
`private void`	`setLwFrameScale(double scaleX, double scaleY)`
`private void`	`setLwFrameVisible(boolean visible)`
`private void`	`ungrabFocus(boolean postUngrabEvent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - isThreadMerged
```
private static boolean isThreadMerged
```
  - swNodeIOP
```
private SwingNodeInterop swNodeIOP
```
  - iopFactoryInstance
```
private static InteropFactory iopFactoryInstance
```
  - fxWidth
```
private double fxWidth
```
  - fxHeight
```
private double fxHeight
```
  - swingPrefWidth
```
private int swingPrefWidth
```
  - swingPrefHeight
```
private int swingPrefHeight
```
  - swingMaxWidth
```
private int swingMaxWidth
```
  - swingMaxHeight
```
private int swingMaxHeight
```
  - swingMinWidth
```
private int swingMinWidth
```
  - swingMinHeight
```
private int swingMinHeight
```
  - content
```
private volatile javax.swing.JComponent content
```
  - lwFrame
```
private volatile java.lang.Object lwFrame
```
  - peer
```
private NGExternalNode peer
```
  - paintLock
```
private final java.util.concurrent.locks.ReentrantLock paintLock
```
  - skipBackwardUnrgabNotification
```
private boolean skipBackwardUnrgabNotification
```
  - grabbed
```
private boolean grabbed
```
  - deactivate
```
private javax.swing.Timer deactivate
```
  - windowHiddenHandler
```
private EventHandler windowHiddenHandler
```
  - hWindow
```
private Window hWindow
```
  - peerRequests
```
private java.util.List<java.lang.Runnable> peerRequests
```
  - locationListener
```
private final InvalidationListener locationListener
```
  - ungrabHandler
```
private final <any> ungrabHandler
```
  - windowVisibleListener
```
private final <any> windowVisibleListener
```
  - sceneWindowListener
```
private final <any> sceneWindowListener
```
- Constructor Detail
  - SwingNode
```
public SwingNode()
```
    Constructs a new instance of SwingNode.
- Method Detail
  - getLightweightFrame
```
private final java.lang.Object getLightweightFrame()
```
  - getPaintLock
```
private java.util.concurrent.locks.ReentrantLock getPaintLock()
```
  - notifyNativeHandle
```
private void notifyNativeHandle(Window window)
```
  - 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 Event Dispatch thread. Note however, that access to a Swing component must occur from the Event Dispatch thread according to the Swing threading restrictions.
    
    Parameters:
    
    content - a Swing component to display in this SwingNode
    
    See Also:
    
    EventQueue.isDispatchThread(), javafx.application.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 Event Dispatch thread. Note however, that access to a Swing component must occur from the Event Dispatch thread according to the Swing threading restrictions.
    
    Returns:
    
    the Swing component attached to this SwingNode
    
    See Also:
    
    EventQueue.isDispatchThread(), javafx.application.Platform#isFxApplicationThread()
  - setContentImpl
```
private void setContentImpl(javax.swing.JComponent content)
```
  - setImageBuffer
```
void setImageBuffer(int[] data,
                    int x,
                    int y,
                    int w,
                    int h,
                    int linestride,
                    double scaleX,
                    double scaleY)
```
  - setImageBounds
```
void setImageBounds(int x,
                    int y,
                    int w,
                    int h)
```
  - repaintDirtyRegion
```
void repaintDirtyRegion(int dirtyX,
                        int dirtyY,
                        int dirtyWidth,
                        int dirtyHeight)
```
  - isResizable
```
public boolean isResizable()
```
  - resize
```
public void resize(double width,
                   double height)
```
    Invoked by the SwingNode's parent during layout to set the SwingNode's width and height. Applications should not invoke this method directly. If an application needs to directly set the size of the SwingNode, it should set the Swing component's minimum/preferred/maximum size constraints which will be propagated correspondingly to the SwingNode and it's parent will honor those settings during layout.
    
    Parameters:
    
    width - the target layout bounds width
    
    height - the target layout bounds height
  - prefWidth
```
public double prefWidth(double height)
```
    Returns the SwingNode's preferred width for use in layout calculations. This value corresponds to the preferred width of the Swing component.
    
    Returns:
    
    the preferred width that the node should be resized to during layout
  - prefHeight
```
public double prefHeight(double width)
```
    Returns the SwingNode's preferred height for use in layout calculations. This value corresponds to the preferred height of the Swing component.
    
    Returns:
    
    the preferred height that the node should be resized to during layout
  - maxWidth
```
public double maxWidth(double height)
```
    Returns the SwingNode's maximum width for use in layout calculations. This value corresponds to the maximum width of the Swing component.
    
    Returns:
    
    the maximum width that the node should be resized to during layout
  - maxHeight
```
public double maxHeight(double width)
```
    Returns the SwingNode's maximum height for use in layout calculations. This value corresponds to the maximum height of the Swing component.
    
    Returns:
    
    the maximum height that the node should be resized to during layout
  - minWidth
```
public double minWidth(double height)
```
    Returns the SwingNode's minimum width for use in layout calculations. This value corresponds to the minimum width of the Swing component.
    
    Returns:
    
    the minimum width that the node should be resized to during layout
  - minHeight
```
public double minHeight(double width)
```
    Returns the SwingNode's minimum height for use in layout calculations. This value corresponds to the minimum height of the Swing component.
    
    Returns:
    
    the minimum height that the node should be resized to during layout
  - doComputeContains
```
private boolean doComputeContains(double localX,
                                  double localY)
```
  - removeSceneListeners
```
private void removeSceneListeners(Scene scene)
```
  - addSceneListeners
```
private void addSceneListeners(Scene scene)
```
  - addWindowListeners
```
private void addWindowListeners(Window window)
```
  - removeWindowListeners
```
private void removeWindowListeners(Window window)
```
  - doCreatePeer
```
private NGNode doCreatePeer()
```
  - doUpdatePeer
```
private void doUpdatePeer()
```
  - locateLwFrame
```
private void locateLwFrame()
```
  - activateLwFrame
```
private void activateLwFrame(boolean activate)
```
  - disposeLwFrame
```
private void disposeLwFrame()
```
  - setLwFrameVisible
```
private void setLwFrameVisible(boolean visible)
```
  - setLwFrameScale
```
private void setLwFrameScale(double scaleX,
                             double scaleY)
```
  - doComputeGeomBounds
```
private BaseBounds doComputeGeomBounds(BaseBounds bounds,
                                       BaseTransform tx)
```
  - ungrabFocus
```
private void ungrabFocus(boolean postUngrabEvent)
```

Class SwingNode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isThreadMerged

swNodeIOP

iopFactoryInstance

fxWidth

fxHeight

swingPrefWidth

swingPrefHeight

swingMaxWidth

swingMaxHeight

swingMinWidth

swingMinHeight

content

lwFrame

peer

paintLock

skipBackwardUnrgabNotification

grabbed

deactivate

windowHiddenHandler

hWindow

peerRequests

locationListener

ungrabHandler

windowVisibleListener

sceneWindowListener

Constructor Detail

SwingNode

Method Detail

getLightweightFrame

getPaintLock

notifyNativeHandle

setContent

getContent

setContentImpl

setImageBuffer

setImageBounds

repaintDirtyRegion

isResizable

resize

prefWidth

prefHeight

maxWidth

maxHeight

minWidth

minHeight

doComputeContains

removeSceneListeners

addSceneListeners

addWindowListeners

removeWindowListeners

doCreatePeer

doUpdatePeer

locateLwFrame

activateLwFrame

disposeLwFrame

setLwFrameVisible

setLwFrameScale

doComputeGeomBounds

ungrabFocus