/******************************************************************************* * Copyright (c) 2007 SAS Institute. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * SAS Institute - initial API and implementation *******************************************************************************/ package org.simantics.utils.ui.internal.awt; import java.awt.Container; import java.awt.EventQueue; import java.awt.Frame; import java.awt.Toolkit; import javax.swing.JApplet; import javax.swing.JComponent; import javax.swing.RootPaneContainer; import javax.swing.SwingUtilities; import javax.swing.UIManager; import javax.swing.plaf.FontUIResource; import org.eclipse.swt.SWT; import org.eclipse.swt.SWTException; import org.eclipse.swt.awt.SWT_AWT; import org.eclipse.swt.graphics.Font; import org.eclipse.swt.graphics.FontData; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Event; import org.eclipse.swt.widgets.Listener; import org.eclipse.swt.widgets.Widget; /** * A SWT composite widget for embedding Swing components in a SWT composite within an RCP or standalone-SWT application. The Eclipse platform * provides limited support for embedding Swing components through {@link org.eclipse.swt.awt.SWT_AWT}. * This class extends that support by * *

* If, rather than embedding Swing components, you are integrating with Swing by opening * Swing dialogs, see the {@link AwtEnvironment} class. *

* This is an abstract that is normally used by extending it and implementing the {@link #createSwingComponent()} method. For example, *

 *        embeddedComposite = new EmbeddedSwingComposite(parent, SWT.NONE) {
 *            protected JComponent createSwingComponent() {
 *                scrollPane = new JScrollPane();
 *                table = new JTable();
 *                scrollPane.setViewportView(table);
 *                return scrollPane;
 *            }
 *        }; 
 *        embeddedComposite.populate();
 * 
*

* The Swing component is created inside a standard Swing containment hierarchy, rooted in * a {@link javax.swing.RootPaneContainer}. The root pane container is placed inside an AWT frame, as * returned by {@link org.eclipse.swt.awt.SWT_AWT#new_Frame(Composite)} *

* Note: When you mix components from Swing/AWT and SWT toolkits, there will be two UI event threads, * one for AWT, one for SWT. Most SWT APIs require that you call them from the SWT thread. Swing * has similar restrictions though it does not enforce them as much as SWT. *

* Applications need to be aware of the current thread, and, where necessary, schedule tasks to run * on another thread. This has always been required in the pure Swing or SWT environments, but when * mixing Swing and SWT, more of this scheduling will be necessary. *

* To schedule work on the AWT event * thread, you can use: *

*

* (or similar methods in {@link java.awt.EventQueue}) *

* To schedule work on the SWT event thread, use: *

* * Of course, as in single-toolkit environments, long-running tasks should be offloaded from either UI * thread to a background thread. The Eclipse jobs API can be used for this purpose. */ public abstract class EmbeddedSwingComposite extends Composite { private static class AwtContext { private Frame frame; private JComponent swingComponent; AwtContext(Frame frame) { assert frame != null; this.frame = frame; } Frame getFrame() { return frame; } void setSwingComponent(JComponent swingComponent) { this.swingComponent = swingComponent; } JComponent getSwingComponent() { return swingComponent; } } private Font currentSystemFont; private AwtContext awtContext; private AwtFocusHandler awtHandler; private Listener settingsListener = new Listener() { public void handleEvent(Event event) { handleSettingsChange(); } }; // This listener helps ensure that Swing popup menus are properly dismissed when // a menu item off the SWT main menu bar is shown. private final Listener menuListener = new Listener() { public void handleEvent(Event event) { assert awtHandler != null; awtHandler.postHidePopups(); } }; /** * Constructs a new instance of this class given its parent * and a style value describing its behavior and appearance. *

* This method must be called from the SWT event thread. *

* The style value is either one of the style constants defined in * class SWT which is applicable to instances of this * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description * lists the style constants that are applicable to the class. * Style bits are also inherited from superclasses. *

*

* The styles SWT.EMBEDDED and SWT.NO_BACKGROUND will be added * to the specified style. Usually, no other style bits are needed. * * @param parent a widget which will be the parent of the new instance (cannot be null) * @param style the style of widget to construct * * @exception IllegalArgumentException

* @exception SWTException * * @see Widget#getStyle */ public EmbeddedSwingComposite(Composite parent, int style) { super(parent, style | SWT.EMBEDDED | SWT.NO_BACKGROUND); getDisplay().addListener(SWT.Settings, settingsListener); setLayout(new FillLayout()); currentSystemFont = getFont(); } /** * Populates the embedded composite with the Swing component. *

* This method must be called from the * SWT event thread. *

* The Swing component will be created by calling {@link #createSwingComponent()}. The creation is * scheduled asynchronously on the AWT event thread. This method does not wait for completion of this * asynchronous task, so it may return before createSwingComponent() is complete. *

* The Swing component is created inside a standard Swing containment hierarchy, rooted in * a {@link javax.swing.RootPaneContainer}. Clients can override {@link #addRootPaneContainer(Frame)} * to provide their own root pane container implementation. *

* This method can be called multiple times for a single instance. If an embedded frame exists from * a previous call, it is disposed. * * @exception SWTException

*/ public void populate() { checkWidget(); createFrame(); scheduleComponentCreation(); } /** * Creates the embedded Swing component. This method is called from the AWT event thread. *

* Implement this method to provide the Swing component that will be shown inside this composite. * The returned component will be added to the Swing content pane. At least one component must * be created by this method; null is not a valid return value. * * @return a non-null Swing component */ protected abstract JComponent createSwingComponent(); /** * Adds a root pane container to the embedded AWT frame. Override this to provide your own * {@link javax.swing.RootPaneContainer} implementation. In most cases, it is not necessary * to override this method. *

* This method is called from the AWT event thread. *

* If you are defining your own root pane container, make sure that there is at least one * heavyweight (AWT) component in the frame's containment hierarchy; otherwise, event * processing will not work correctly. See http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4982522 * for more information. * * @param frame the frame to which the root pane container is added * @return a non-null Swing component */ protected RootPaneContainer addRootPaneContainer(Frame frame) { assert EventQueue.isDispatchThread(); // On AWT event thread assert frame != null; // It is important to set up the proper top level components in the frame: // 1) For Swing to work properly, Sun documents that there must be an implementor of // javax.swing.RootPaneContainer at the top of the component hierarchy. // 2) For proper event handling there must be a heavyweight // an AWT frame must contain a heavyweight component (see // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4982522) // 3) The Swing implementation further narrows the options by expecting that the // top of the hierarchy be a JFrame, JDialog, JWindow, or JApplet. See javax.swing.PopupFactory. // All this drives the choice of JApplet for the top level Swing component. It is the // only single component that satisfies all the above. This does not imply that // we have a true applet; in particular, there is no notion of an applet lifecycle in this // context. JApplet applet = new JApplet(); // In JRE 1.4, the JApplet makes itself a focus cycle root. This // interferes with the focus handling installed on the parent frame, so // change it back to a non-root here. // TODO: consider moving the focus policy from the Frame down to the JApplet applet.setFocusCycleRoot(false); frame.add(applet); return applet; } /** * Performs custom updates to newly set fonts. This method is called whenever a change * to the system font through the system settings (i.e. control panel) is detected. *

* This method is called from the AWT event thread. *

* In most cases it is not necessary to override this method. Normally, the implementation * of this class will automatically propogate font changes to the embedded Swing components * through Swing's Look and Feel support. However, if additional * special processing is necessary, it can be done inside this method. * * @param newFont New AWT font */ protected void updateAwtFont(java.awt.Font newFont) { } /** * Returns the embedded AWT frame. The returned frame is the root of the AWT containment * hierarchy for the embedded Swing component. This method can be called from * any thread. * * @return the embedded frame */ public Frame getFrame() { // Intentionally leaving out checkWidget() call. This may need to be called from within user's // createSwingComponent() method. Accessing from a non-SWT thread is OK, but we still check // for disposal if (getDisplay() == null || isDisposed()) { SWT.error(SWT.ERROR_WIDGET_DISPOSED); } return (awtContext != null) ? awtContext.getFrame() : null; } private void createFrame() { assert Display.getCurrent() != null; // On SWT event thread // Make sure Awt environment is initialized. AwtEnvironment.getInstance(getDisplay()); if (awtContext != null) { final Frame oldFrame = awtContext.getFrame(); // Schedule disposal of old frame on AWT thread so that there are no problems with // already-scheduled operations that have not completed. // Note: the implementation of Frame.dispose() would schedule the use of the AWT // thread even if it was not done here, but it uses invokeAndWait() which is // prone to deadlock (and not necessary for this case). EventQueue.invokeLater(new Runnable() { public void run() { oldFrame.dispose(); } }); } Frame frame = SWT_AWT.new_Frame(this); awtContext = new AwtContext(frame); // Glue the two frameworks together. Do this before anything is added to the frame // so that all necessary listeners are in place. createFocusHandlers(); // This listener clears garbage during resizing, making it looker much cleaner addControlListener(new CleanResizeListener()); } private void createFocusHandlers() { assert awtContext != null; assert Display.getCurrent() != null; // On SWT event thread Frame frame = awtContext.getFrame(); awtHandler = new AwtFocusHandler(frame); SwtFocusHandler swtHandler = new SwtFocusHandler(this); awtHandler.setSwtHandler(swtHandler); swtHandler.setAwtHandler(awtHandler); // Ensure that AWT popups are dimissed whenever a SWT menu is shown getDisplay().addFilter(SWT.Show, menuListener); EmbeddedChildFocusTraversalPolicy policy = new EmbeddedChildFocusTraversalPolicy(awtHandler); frame.setFocusTraversalPolicy(policy); } private void scheduleComponentCreation() { assert awtContext != null; // Create AWT/Swing components on the AWT thread. This is // especially necessary to avoid an AWT leak bug (6411042). final AwtContext currentContext = awtContext; EventQueue.invokeLater(new Runnable() { public void run() { RootPaneContainer container = addRootPaneContainer(currentContext.getFrame()); JComponent swingComponent = createSwingComponent(); currentContext.setSwingComponent(swingComponent); container.getRootPane().getContentPane().add(swingComponent); setComponentFont(); } }); } private void setComponentFont() { assert currentSystemFont != null; assert EventQueue.isDispatchThread(); // On AWT event thread JComponent swingComponent = (awtContext != null) ? awtContext.getSwingComponent() : null; if ((swingComponent != null) && !currentSystemFont.getDevice().isDisposed()) { FontData fontData = currentSystemFont.getFontData()[0]; // AWT font sizes assume a 72 dpi resolution, always. The true screen resolution must be // used to convert the platform font size into an AWT point size that matches when displayed. int resolution = Toolkit.getDefaultToolkit().getScreenResolution(); int awtFontSize = (int)Math.round((double)fontData.getHeight() * resolution / 72.0); // The style constants for SWT and AWT map exactly, and since they are int constants, they should // never change. So, the SWT style is passed through as the AWT style. java.awt.Font awtFont = new java.awt.Font(fontData.getName(), fontData.getStyle(), awtFontSize); // Update the look and feel defaults to use new font. updateLookAndFeel(awtFont); // Allow subclasses to react to font change if necessary. updateAwtFont(awtFont); // Allow components to update their UI based on new font // TODO: should the update method be called on the root pane instead? Container contentPane = swingComponent.getRootPane().getContentPane(); SwingUtilities.updateComponentTreeUI(contentPane); } } private void updateLookAndFeel(java.awt.Font awtFont) { assert awtFont != null; assert EventQueue.isDispatchThread(); // On AWT event thread // The FontUIResource class marks the font as replaceable by the look and feel // implementation if font settings are later changed. FontUIResource fontResource = new FontUIResource(awtFont); // Assign the new font to the relevant L&F font properties. These are // the properties that are initially assigned to the system font // under the Windows look and feel. // TODO: It's possible that other platforms will need other assignments. // TODO: This does not handle fonts other than the "system" font. // Other fonts may change, and the Swing L&F may not be adjusting. UIManager.put("Button.font", fontResource); //$NON-NLS-1$ UIManager.put("CheckBox.font", fontResource); //$NON-NLS-1$ UIManager.put("ComboBox.font", fontResource); //$NON-NLS-1$ UIManager.put("EditorPane.font", fontResource); //$NON-NLS-1$ UIManager.put("Label.font", fontResource); //$NON-NLS-1$ UIManager.put("List.font", fontResource); //$NON-NLS-1$ UIManager.put("Panel.font", fontResource); //$NON-NLS-1$ UIManager.put("ProgressBar.font", fontResource); //$NON-NLS-1$ UIManager.put("RadioButton.font", fontResource); //$NON-NLS-1$ UIManager.put("ScrollPane.font", fontResource); //$NON-NLS-1$ UIManager.put("TabbedPane.font", fontResource); //$NON-NLS-1$ UIManager.put("Table.font", fontResource); //$NON-NLS-1$ UIManager.put("TableHeader.font", fontResource); //$NON-NLS-1$ UIManager.put("TextField.font", fontResource); //$NON-NLS-1$ UIManager.put("TextPane.font", fontResource); //$NON-NLS-1$ UIManager.put("TitledBorder.font", fontResource); //$NON-NLS-1$ UIManager.put("ToggleButton.font", fontResource); //$NON-NLS-1$ UIManager.put("TreeFont.font", fontResource); //$NON-NLS-1$ UIManager.put("ViewportFont.font", fontResource); //$NON-NLS-1$ } private void handleSettingsChange() { Font newFont = getDisplay().getSystemFont(); if (!newFont.equals(currentSystemFont)) { currentSystemFont = newFont; EventQueue.invokeLater(new Runnable() { public void run() { setComponentFont(); } }); } } private boolean isFocusable() { if (awtContext == null) { return false; } JComponent swingComponent = awtContext.getSwingComponent(); return (swingComponent != null) && swingComponent.isFocusable(); } /* (non-Javadoc) * @see org.eclipse.swt.widgets.Control#setFocus() */ public boolean setFocus() { checkWidget(); if (!isFocusable()) { return false; } return super.setFocus(); } /* (non-Javadoc) * @see org.eclipse.swt.widgets.Control#forceFocus() */ public boolean forceFocus() { checkWidget(); if (!isFocusable()) { return false; } return super.forceFocus(); } /* (non-Javadoc) * @see org.eclipse.swt.widgets.Widget#dispose() */ public void dispose() { if (!isDisposed()) { getDisplay().removeListener(SWT.Settings, settingsListener); getDisplay().removeFilter(SWT.Show, menuListener); super.dispose(); } } }