Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class PopupFactory

public class PopupFactory
extends Object
A factory for Popup objects. These are used to managed little windows that float over everything else, typically containing a popup menu.
Since:
1.4

Constructor Summary

PopupFactory()
Constructs a new PopupFactory.

Method Summary

Popup
getPopup(Component owner, Component contents, int x, int y)
Creates a new Popup given its owner, contents and the screen position where the popup will appear.
static PopupFactory
getSharedInstance()
Retrieves the shared factory, creating a new factory if necessary.
static void
setSharedInstance(PopupFactory factory)
Sets the shared factory.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PopupFactory

public PopupFactory()
Constructs a new PopupFactory. Usually, a single PopupFactory is shared among multiple consumers of Popup. Use getSharedInstance() to retrieve the current factory.

Method Details

getPopup

public Popup getPopup(Component owner,
                      Component contents,
                      int x,
                      int y)
Creates a new Popup given its owner, contents and the screen position where the popup will appear.
Parameters:
owner - the Component to which x and y are relative, or null for placing the popup relative to the origin of the screen.
contents - the contents that will be displayed inside the Popup.
x - the horizontal position where the Popup will appear.
y - the vertical position where the Popup will appear.
Throws:
IllegalArgumentException - if contents is null.

getSharedInstance

public static PopupFactory getSharedInstance()
Retrieves the shared factory, creating a new factory if necessary.
Returns:
a PopupFactory that can be used to create Popup objects.

setSharedInstance

public static void setSharedInstance(PopupFactory factory)
Sets the shared factory.
Parameters:
factory - the PopupFactory that future invocations of getSharedInstance() will return.
Throws:
IllegalArgumentException - if factory is null.
PopupFactory.java -- Copyright (C) 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About