public class JFXPanel
extends javax.swing.JComponent
JFXPanel
is a component to embed JavaFX content into
Swing applications. The content to be displayed is specified
with the setScene(javafx.scene.Scene)
method that accepts an instance of
JavaFX Scene
. After the scene is assigned, it gets
repainted automatically. All the input and focus events are
forwarded to the scene transparently to the developer.
There are some restrictions related to JFXPanel
. As a
Swing component, it should only be accessed from the event
dispatch thread, except the setScene(javafx.scene.Scene)
method, which can
be called either on the event dispatch thread or on the JavaFX
application thread.
Here is a typical pattern how JFXPanel
can used:
public class Test { private static void initAndShowGUI() { // This method is invoked on Swing thread JFrame frame = new JFrame("FX"); final JFXPanel fxPanel = new JFXPanel(); frame.add(fxPanel); frame.setVisible(true); Platform.runLater(new Runnable() { @Override public void run() { initFX(fxPanel); } }); } private static void initFX(JFXPanel fxPanel) { // This method is invoked on JavaFX thread Scene scene = createScene(); fxPanel.setScene(scene); } public static void main(String[] args) { SwingUtilities.invokeLater(new Runnable() { @Override public void run() { initAndShowGUI(); } }); } }
javax.swing.JComponent.AccessibleJComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
JFXPanel()
Creates a new
JFXPanel object. |
Modifier and Type | Method and Description |
---|---|
void |
addNotify()
Notifies this component that it now has a parent component.
|
java.awt.Dimension |
getPreferredSize()
Returns the preferred size of this
JFXPanel , either
previously set with JComponent.setPreferredSize(Dimension) or
based on the content of the JavaFX scene attached to this JFXPanel . |
Scene |
getScene()
Returns the JavaFX scene attached to this
JFXPanel . |
boolean |
isOpaque()
JFXPanel 's opacity is controlled by the JavaFX content
which is displayed in this component, so this method overrides
JComponent.isOpaque() to always return a
false value. |
protected void |
paintComponent(java.awt.Graphics g)
Overrides the
JComponent.paintComponent(Graphics)
method to paint the content of the JavaFX scene attached to this
JFXpanel . |
protected void |
processComponentEvent(java.awt.event.ComponentEvent e)
Overrides the
Component.processComponentEvent(ComponentEvent)
method to dispatch ComponentEvent.COMPONENT_RESIZED
events to the JavaFX scene attached to this JFXPanel . |
protected void |
processFocusEvent(java.awt.event.FocusEvent e)
Overrides the
Component.processFocusEvent(FocusEvent)
method to dispatch focus events to the JavaFX scene attached to this
JFXPanel . |
protected void |
processHierarchyBoundsEvent(java.awt.event.HierarchyEvent e)
Overrides the
Component.processHierarchyBoundsEvent(HierarchyEvent)
method to process HierarchyEvent.ANCESTOR_MOVED
events and update the JavaFX scene location to match the JFXPanel location on the screen. |
protected void |
processHierarchyEvent(java.awt.event.HierarchyEvent e) |
protected void |
processKeyEvent(java.awt.event.KeyEvent e)
Overrides the
Component.processKeyEvent(KeyEvent)
method to dispatch the key event to the JavaFX scene attached to this
JFXPanel . |
protected void |
processMouseEvent(java.awt.event.MouseEvent e)
Overrides the
Component.processMouseEvent(MouseEvent)
method to dispatch the mouse event to the JavaFX scene attached to this
JFXPanel . |
protected void |
processMouseMotionEvent(java.awt.event.MouseEvent e)
Overrides the
Component.processMouseMotionEvent(MouseEvent)
method to dispatch the mouse motion event to the JavaFX scene attached to
this JFXPanel . |
protected void |
processMouseWheelEvent(java.awt.event.MouseWheelEvent e)
Overrides the
Component.processMouseWheelEvent(MouseWheelEvent)
method to dispatch the mouse wheel event to the JavaFX scene attached
to this JFXPanel . |
void |
removeNotify()
Notifies this component that it no longer has a parent component.
|
void |
setOpaque(boolean opaque)
JFXPanel 's opacity is controlled by the JavaFX content
which is displayed in this component, so this method overrides
JComponent.setOpaque(boolean) to only accept a
false value. |
void |
setScene(Scene newScene)
Attaches a
Scene object to display in this JFXPanel . |
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processInputMethodEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
public JFXPanel()
JFXPanel
object.
Implementation note: when the first JFXPanel
object
is created, it implicitly initializes the JavaFX runtime. This is the
preferred way to initialize JavaFX in Swing.
public Scene getScene()
JFXPanel
.Scene
attached to this JFXPanel
public void setScene(Scene newScene)
Scene
object to display in this JFXPanel
. This method can be called either on the event
dispatch thread or the JavaFX application thread.newScene
- a scene to display in this JFXpanel
EventQueue.isDispatchThread()
,
Platform.isFxApplicationThread()
public final void setOpaque(boolean opaque)
JFXPanel
's opacity is controlled by the JavaFX content
which is displayed in this component, so this method overrides
JComponent.setOpaque(boolean)
to only accept a
false
value. If this method is called with a true
value, no action is performed.setOpaque
in class javax.swing.JComponent
opaque
- must be false
public final boolean isOpaque()
JFXPanel
's opacity is controlled by the JavaFX content
which is displayed in this component, so this method overrides
JComponent.isOpaque()
to always return a
false
value.isOpaque
in class javax.swing.JComponent
false
valueprotected void processMouseEvent(java.awt.event.MouseEvent e)
Component.processMouseEvent(MouseEvent)
method to dispatch the mouse event to the JavaFX scene attached to this
JFXPanel
.processMouseEvent
in class javax.swing.JComponent
e
- the mouse event to dispatch to the JavaFX sceneprotected void processMouseMotionEvent(java.awt.event.MouseEvent e)
Component.processMouseMotionEvent(MouseEvent)
method to dispatch the mouse motion event to the JavaFX scene attached to
this JFXPanel
.processMouseMotionEvent
in class javax.swing.JComponent
e
- the mouse motion event to dispatch to the JavaFX sceneprotected void processMouseWheelEvent(java.awt.event.MouseWheelEvent e)
Component.processMouseWheelEvent(MouseWheelEvent)
method to dispatch the mouse wheel event to the JavaFX scene attached
to this JFXPanel
.processMouseWheelEvent
in class java.awt.Component
e
- the mouse wheel event to dispatch to the JavaFX sceneprotected void processKeyEvent(java.awt.event.KeyEvent e)
Component.processKeyEvent(KeyEvent)
method to dispatch the key event to the JavaFX scene attached to this
JFXPanel
.processKeyEvent
in class javax.swing.JComponent
e
- the key event to dispatch to the JavaFX sceneprotected void processComponentEvent(java.awt.event.ComponentEvent e)
Component.processComponentEvent(ComponentEvent)
method to dispatch ComponentEvent.COMPONENT_RESIZED
events to the JavaFX scene attached to this JFXPanel
. The JavaFX
scene object is then resized to match the JFXPanel
size.processComponentEvent
in class java.awt.Component
e
- the component event to dispatch to the JavaFX sceneprotected void processHierarchyBoundsEvent(java.awt.event.HierarchyEvent e)
Component.processHierarchyBoundsEvent(HierarchyEvent)
method to process HierarchyEvent.ANCESTOR_MOVED
events and update the JavaFX scene location to match the JFXPanel
location on the screen.processHierarchyBoundsEvent
in class java.awt.Component
e
- the hierarchy bounds event to processprotected void processHierarchyEvent(java.awt.event.HierarchyEvent e)
processHierarchyEvent
in class java.awt.Component
protected void processFocusEvent(java.awt.event.FocusEvent e)
Component.processFocusEvent(FocusEvent)
method to dispatch focus events to the JavaFX scene attached to this
JFXPanel
.processFocusEvent
in class java.awt.Component
e
- the focus event to dispatch to the JavaFX sceneprotected void paintComponent(java.awt.Graphics g)
JComponent.paintComponent(Graphics)
method to paint the content of the JavaFX scene attached to this
JFXpanel
.paintComponent
in class javax.swing.JComponent
g
- the Graphics context in which to paintisOpaque()
public java.awt.Dimension getPreferredSize()
JFXPanel
, either
previously set with JComponent.setPreferredSize(Dimension)
or
based on the content of the JavaFX scene attached to this JFXPanel
.getPreferredSize
in class javax.swing.JComponent
JFXPanel
preferred sizepublic void addNotify()
addNotify
in class javax.swing.JComponent
public void removeNotify()
removeNotify
in class javax.swing.JComponent
Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.