1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
/* * @(#)Popup.java 1.20 06/04/26 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing; import java.awt.*; import sun.awt.ModalExclude; /** * Popups are used to display a <code>Component</code> to the user, typically * on top of all the other <code>Component</code>s in a particular containment * hierarchy. <code>Popup</code>s have a very small life cycle. Once you * have obtained a <code>Popup</code>, and hidden it (invoked the * <code>hide</code> method), you should no longer * invoke any methods on it. This allows the <code>PopupFactory</code> to cache * <code>Popup</code>s for later use. * <p> * The general contract is that if you need to change the size of the * <code>Component</code>, or location of the <code>Popup</code>, you should * obtain a new <code>Popup</code>. * <p> * <code>Popup</code> does not descend from <code>Component</code>, rather * implementations of <code>Popup</code> are responsible for creating * and maintaining their own <code>Component</code>s to render the * requested <code>Component</code> to the user. * <p> * You typically do not explicitly create an instance of <code>Popup</code>, * instead obtain one from a <code>PopupFactory</code>. * * @see PopupFactory * * @version 1.20 04/26/06 * @since 1.4 */ public class Popup { /** * The Component representing the Popup. */ private Component component; /** * Creates a <code>Popup</code> for the Component <code>owner</code> * containing the Component <code>contents</code>. <code>owner</code> * is used to determine which <code>Window</code> the new * <code>Popup</code> will parent the <code>Component</code> the * <code>Popup</code> creates to. * A null <code>owner</code> implies there is no valid parent. * <code>x</code> and * <code>y</code> specify the preferred initial location to place * the <code>Popup</code> at. Based on screen size, or other paramaters, * the <code>Popup</code> may not display at <code>x</code> and * <code>y</code>. * * @param owner Component mouse coordinates are relative to, may be null * @param contents Contents of the Popup * @param x Initial x screen coordinate * @param y Initial y screen coordinate * @exception IllegalArgumentException if contents is null */ protected Popup(Component owner, Component contents, int x, int y) { this(); if (contents == null) { throw new IllegalArgumentException("Contents must be non-null"); } reset(owner, contents, x, y); } /** * Creates a <code>Popup</code>. This is provided for subclasses. */ protected Popup() { } /** * Makes the <code>Popup</code> visible. If the <code>Popup</code> is * currently visible, this has no effect. */ public void show() { Component component = getComponent(); if (component != null) { component.show(); } } /** * Hides and disposes of the <code>Popup</code>. Once a <code>Popup</code> * has been disposed you should no longer invoke methods on it. A * <code>dispose</code>d <code>Popup</code> may be reclaimed and later used * based on the <code>PopupFactory</code>. As such, if you invoke methods * on a <code>disposed</code> <code>Popup</code>, indeterminate * behavior will result. */ public void hide() { Component component = getComponent(); if (component instanceof JWindow) { component.hide(); ((JWindow)component).getContentPane().removeAll(); } dispose(); } /** * Frees any resources the <code>Popup</code> may be holding onto. */ void dispose() { Component component = getComponent(); Window window = SwingUtilities.getWindowAncestor(component); if (component instanceof JWindow) { ((Window)component).dispose(); component = null; } // If our parent is a DefaultFrame, we need to dispose it, too. if (window instanceof DefaultFrame) { window.dispose(); } } /** * Resets the <code>Popup</code> to an initial state. */ void reset(Component owner, Component contents, int ownerX, int ownerY) { if (getComponent() == null) { component = createComponent(owner); } Component c = getComponent(); if (c instanceof JWindow) { JWindow component = (JWindow)getComponent(); component.setLocation(ownerX, ownerY); component.getContentPane().add(contents, BorderLayout.CENTER); contents.invalidate(); if(component.isVisible()) { // Do not call pack() if window is not visible to // avoid early native peer creation pack(); } } } /** * Causes the <code>Popup</code> to be sized to fit the preferred size * of the <code>Component</code> it contains. */ void pack() { Component component = getComponent(); if (component instanceof Window) { ((Window)component).pack(); } } /** * Returns the <code>Window</code> to use as the parent of the * <code>Window</code> created for the <code>Popup</code>. This creates * a new <code>DefaultFrame</code>, if necessary. */ private Window getParentWindow(Component owner) { Window window = null; if (owner instanceof Window) { window = (Window)owner; } else if (owner != null) { window = SwingUtilities.getWindowAncestor(owner); } if (window == null) { window = new DefaultFrame(); } return window; } /** * Creates the Component to use as the parent of the <code>Popup</code>. * The default implementation creates a <code>Window</code>, subclasses * should override. */ Component createComponent(Component owner) { if (GraphicsEnvironment.isHeadless()) { // Generally not useful, bail. return null; } return new HeavyWeightWindow(getParentWindow(owner)); } /** * Returns the <code>Component</code> returned from * <code>createComponent</code> that will hold the <code>Popup</code>. */ Component getComponent() { return component; } /** * Component used to house window. */ static class HeavyWeightWindow extends JWindow implements ModalExclude { HeavyWeightWindow(Window parent) { super(parent); setFocusableWindowState(false); setName("###overrideRedirect###"); // Popups are typically transient and most likely won't benefit // from true double buffering. Turn it off here. getRootPane().setUseTrueDoubleBuffering(false); } public void update(Graphics g) { paint(g); } public void show() { this.pack(); super.show(); } } /** * Used if no valid Window ancestor of the supplied owner is found. * <p> * PopupFactory uses this as a way to know when the Popup shouldn't * be cached based on the Window. */ static class DefaultFrame extends Frame { } }