public class PopupFactory extends Object
PopupFactory
, as the name implies, is used to obtain
instances of Popup
s. Popup
s are used to
display a Component
above all other Component
s
in a particular containment hierarchy. The general contract is that
once you have obtained a Popup
from a
PopupFactory
, you must invoke hide
on the
Popup
. The typical usage is:
PopupFactory factory = PopupFactory.getSharedInstance(); Popup popup = factory.getPopup(owner, contents, x, y); popup.show(); ... popup.hide();
Popup
Constructor | Description |
---|---|
PopupFactory() |
Modifier and Type | Method | Description |
---|---|---|
Popup |
getPopup(Component owner,
Component contents,
int x,
int y) |
Creates a
Popup for the Component owner
containing the Component contents . |
protected Popup |
getPopup(Component owner,
Component contents,
int x,
int y,
boolean isHeavyWeightPopup) |
Creates a
Popup for the Component owner
containing the Component contents . |
static PopupFactory |
getSharedInstance() |
Returns the shared
PopupFactory which can be used
to obtain Popup s. |
static void |
setSharedInstance(PopupFactory factory) |
Sets the
PopupFactory that will be used to obtain
Popup s. |
public static void setSharedInstance(PopupFactory factory)
PopupFactory
that will be used to obtain
Popup
s.
This will throw an IllegalArgumentException
if
factory
is null.factory
- Shared PopupFactoryIllegalArgumentException
- if factory
is nullgetPopup(java.awt.Component, java.awt.Component, int, int)
public static PopupFactory getSharedInstance()
PopupFactory
which can be used
to obtain Popup
s.public Popup getPopup(Component owner, Component contents, int x, int y) throws IllegalArgumentException
Popup
for the Component owner
containing the Component contents
. owner
is used to determine which Window
the new
Popup
will parent the Component
the
Popup
creates to. A null owner
implies there
is no valid parent. x
and
y
specify the preferred initial location to place
the Popup
at. Based on screen size, or other paramaters,
the Popup
may not display at x
and
y
.owner
- Component mouse coordinates are relative to, may be nullcontents
- Contents of the Popupx
- Initial x screen coordinatey
- Initial y screen coordinateIllegalArgumentException
- if contents is nullprotected Popup getPopup(Component owner, Component contents, int x, int y, boolean isHeavyWeightPopup) throws IllegalArgumentException
Popup
for the Component owner
containing the Component contents
.
The window containing the component owner
will be used as the parent window. A null owner
implies there
is no valid parent. x
and y
specify the preferred
initial location to place the Popup
at. Based on screen size,
or other parameters, the Popup
may not display at x
and
y
. isHeavyWeightPopup
specifies if the Popup
will be heavyweight. Passing true
will force the Popup
type to be heavyweight, otherwise Popup
type will be selected by
Popup
factory. Lightweight Popup
windows are more
efficient than heavyweight (native peer) windows, but lightweight
and heavyweight components do not mix well in a GUI.
This method is intended to be used only by PopupFactory sub-classes.owner
- Component mouse coordinates are relative to, may be nullcontents
- Contents of the Popupx
- Initial x screen coordinatey
- Initial y screen coordinateisHeavyWeightPopup
- true if Popup should be heavy weight,
otherwise popup type will be selected by popup factory.IllegalArgumentException
- if contents is null Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps