| Overview | Package | Class | Tree | Deprecated | Index | Help | Legend |
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--javax.swing.SwingUtilities
Safe: A collection of utility methods for Swing.
| Field Summary | |
private static boolean |
canAccessEventQueue
|
private static boolean |
eventQueueTested
|
private static Object |
sharedOwnerFrameKey
|
| Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
| Constructor Summary | |
private |
SwingUtilities()
|
| Method Summary | |
(package private) static Object |
appContextGet(Object key)
|
(package private) static void |
appContextPut(Object key,
Object value)
|
(package private) static void |
appContextRemove(Object key)
|
static Rectangle |
calculateInnerArea(JComponent c,
Rectangle r)
Suppressed: Stores the position and size of the inner painting area of the specified component in r and returns r. |
static Rectangle[] |
computeDifference(Rectangle rectA,
Rectangle rectB)
Suppressed: Convenience returning an array of rect representing the regions within rectA that do not overlap with rectB. |
static Rectangle |
computeIntersection(int x,
int y,
int width,
int height,
Rectangle dest)
Suppressed: Convenience to calculate the intersection of two rectangles without allocating a new rectangle. |
static int |
computeStringWidth(FontMetrics fm,
String str)
Enabled: Compute the width of the string using a font with the specified "metrics" (sizes). |
static Rectangle |
computeUnion(int x,
int y,
int width,
int height,
Rectangle dest)
Suppressed: Convenience method that calculates the union of two rectangles without allocating a new rectangle. |
static MouseEvent |
convertMouseEvent(Component source,
MouseEvent sourceEvent,
Component destination)
Suppressed: Returns a MouseEvent similar to sourceEvent except that its x
and y members have been converted to destination's coordinate
system. |
static Point |
convertPoint(Component source,
int x,
int y,
Component destination)
Suppressed: Convert the point (x,y) in source coordinate system to
destination coordinate system. |
static Point |
convertPoint(Component source,
Point aPoint,
Component destination)
Enabled: Convert a aPoint in source coordinate system to
destination coordinate system. |
static void |
convertPointFromScreen(Point p,
Component c)
Enabled: Convert a point from a screen coordinates to a component's coordinate system |
static void |
convertPointToScreen(Point p,
Component c)
Enabled: Convert a point from a component's coordinate system to screen coordinates. |
static Rectangle |
convertRectangle(Component source,
Rectangle aRectangle,
Component destination)
Enabled: Convert the rectangle aRectangle in source coordinate system to
destination coordinate system. |
(package private) static Point |
convertScreenLocationToParent(Container parent,
int x,
int y)
Converts the location x y to the
parents coordinate system, returning the location. |
(package private) static boolean |
doesIconReferenceImage(Icon icon,
Image image)
Returns true if the Icon icon is an instance of
ImageIcon, and the image it contains is the same as image. |
(package private) static void |
doPrivileged(Runnable doRun)
|
(package private) static int |
findDisplayedMnemonicIndex(String text,
int mnemonic)
Returns index of the first occurrence of mnemonic
within string text. |
static Component |
findFocusOwner(Component c)
Deprecated. As of 1.4, replaced by KeyboardFocusManager.getFocusOwner(). |
static Accessible |
getAccessibleAt(Component c,
Point p)
Suppressed: Returns the Accessible child contained at the
local coordinate Point, if one exists. |
static Accessible |
getAccessibleChild(Component c,
int i)
Suppressed: Return the nth Accessible child of the object. |
static int |
getAccessibleChildrenCount(Component c)
Suppressed: Returns the number of accessible children in the object. |
static int |
getAccessibleIndexInParent(Component c)
Suppressed: Get the index of this object in its accessible parent. |
static AccessibleStateSet |
getAccessibleStateSet(Component c)
Suppressed: Get the state of this object. |
static Container |
getAncestorNamed(String name,
Component comp)
Suppressed: Convenience method for searching above comp in the
component hierarchy and returns the first object of name it
finds. |
static Container |
getAncestorOfClass(Class c,
Component comp)
Suppressed: Convenience method for searching above comp in the
component hierarchy and returns the first object of class c it
finds. |
private static CellRendererPane |
getCellRendererPane(Component c,
Container p)
|
static Component |
getDeepestComponentAt(Component parent,
int x,
int y)
Enabled: Returns the deepest visible descendent Component of parent
that contains the location x, y. |
static Rectangle |
getLocalBounds(Component aComponent)
Enabled: Return the rectangle (0,0,bounds.width,bounds.height) for the component aComponent |
static Component |
getRoot(Component c)
Suppressed: Returns the root component for the current component tree. |
static JRootPane |
getRootPane(Component c)
Suppressed: If c is a JRootPane descendant return its JRootPane ancestor. |
(package private) static Frame |
getSharedOwnerFrame()
Returns a toolkit-private, shared, invisible Frame to be the owner for JDialogs and JWindows created with null owners. |
static ActionMap |
getUIActionMap(JComponent component)
Suppressed: Returns the ActionMap provided by the UI in component component. |
static InputMap |
getUIInputMap(JComponent component,
int condition)
Suppressed: Returns the InputMap provided by the UI for condition condition in component component. |
static Window |
getWindowAncestor(Component c)
Suppressed: @return the first Window ancestor of c, or null if component is not contained inside a window |
static void |
invokeAndWait(Runnable doRun)
Suppressed: Causes doRun.run() to be executed synchronously on the AWT event dispatching thread. |
static void |
invokeLater(Runnable doRun)
Suppressed: Causes doRun.run() to be executed asynchronously on the AWT event dispatching thread. |
static boolean |
isDescendingFrom(Component a,
Component b)
Enabled: Return true if a component a descends from a component b |
static boolean |
isEventDispatchThread()
Suppressed: Returns true if the current thread is an AWT event dispatching thread. |
static boolean |
isLeftMouseButton(MouseEvent anEvent)
Enabled: Returns true if the mouse event specifies the left mouse button. |
(package private) static boolean |
isLeftToRight(Component c)
|
static boolean |
isMiddleMouseButton(MouseEvent anEvent)
Enabled: Returns true if the mouse event specifies the middle mouse button. |
static boolean |
isRectangleContainingRectangle(Rectangle a,
Rectangle b)
Enabled: Return true if a contains b |
static boolean |
isRightMouseButton(MouseEvent anEvent)
Enabled: Returns true if the mouse event specifies the right mouse button. |
(package private) static boolean |
isValidKeyEventForKeyBindings(KeyEvent e)
Returns true if the e is a valid KeyEvent to use in
processing the key bindings associated with JComponents. |
static String |
layoutCompoundLabel(FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
Enabled: Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string. |
static String |
layoutCompoundLabel(JComponent c,
FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
Enabled: Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string. |
private static String |
layoutCompoundLabelImpl(JComponent c,
FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string. |
(package private) static Class |
loadSystemClass(String className)
|
static boolean |
notifyAction(Action action,
KeyStroke ks,
KeyEvent event,
Object sender,
int modifiers)
Suppressed: Invokes actionPerformed on action if
action is enabled (and non null). |
static void |
paintComponent(Graphics g,
Component c,
Container p,
int x,
int y,
int w,
int h)
Suppressed: Paints a component c on an arbitrary graphics
g in the
specified rectangle, specifying the rectangle's upper left corner
and size. |
static void |
paintComponent(Graphics g,
Component c,
Container p,
Rectangle r)
Suppressed: Paints a component c on an arbitrary graphics
g in the specified rectangle, specifying a Rectangle object. |
static boolean |
processKeyBindings(KeyEvent event)
Suppressed: Process the key bindings for the Component associated with
event. |
static void |
replaceUIActionMap(JComponent component,
ActionMap uiActionMap)
Suppressed: Convenience method to change the UI ActionMap for component
to uiActionMap. |
static void |
replaceUIInputMap(JComponent component,
int type,
InputMap uiInputMap)
Suppressed: Convenience method to change the UI InputMap for component
to uiInputMap. |
static void |
updateComponentTreeUI(Component c)
Suppressed: A simple minded look and feel change: ask each node in the tree to updateUI() -- that is, to initialize its UI property
with the current look and feel. |
private static void |
updateComponentTreeUI0(Component c)
|
static Window |
windowForComponent(Component aComponent)
Suppressed: Return aComponent's window |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
private static boolean canAccessEventQueue
private static boolean eventQueueTested
private static final Object sharedOwnerFrameKey
| Constructor Detail |
private SwingUtilities()
| Method Detail |
public static final boolean isRectangleContainingRectangle(Rectangle a,
Rectangle b)
a contains b
public static Rectangle getLocalBounds(Component aComponent)
aComponent
public static Window getWindowAncestor(Component c)
static Point convertScreenLocationToParent(Container parent,
int x,
int y)
x y to the
parents coordinate system, returning the location.
public static Point convertPoint(Component source,
Point aPoint,
Component destination)
aPoint in source coordinate system to
destination coordinate system.
If source>is null,aPoint is assumed to be in destination's
root component coordinate system.
If destinationis null, aPoint will be converted to source's
root component coordinate system.
If both source and destination are null, return aPoint
without any conversion.
public static Point convertPoint(Component source,
int x,
int y,
Component destination)
(x,y) in source coordinate system to
destination coordinate system.
If source>is null,(x,y) is assumed to be in destination's
root component coordinate system.
If destinationis null, (x,y) will be converted to source's
root component coordinate system.
If both source and destination are null, return (x,y)
without any conversion.
public static Rectangle convertRectangle(Component source,
Rectangle aRectangle,
Component destination)
aRectangle in source coordinate system to
destination coordinate system.
If source>is null,aRectangle is assumed to be in destination's
root component coordinate system.
If destinationis null, aRectangle will be converted to source's
root component coordinate system.
If both source and destination are null, return aRectangle
without any conversion.
public static Container getAncestorOfClass(Class c,
Component comp)
comp in the
component hierarchy and returns the first object of class c it
finds. Can return null, if a class c cannot be found.
public static Container getAncestorNamed(String name,
Component comp)
comp in the
component hierarchy and returns the first object of name it
finds. Can return null, if name cannot be found.
public static Component getDeepestComponentAt(Component parent,
int x,
int y)
parent
that contains the location x, y.
If parent does not contain the specified location,
then null is returned. If parent is not a
container, or none of parent's visible descendents
contain the specified location, parent is returned.
parent - the root component to begin the searchx - the x target locationy - the y target location
public static MouseEvent convertMouseEvent(Component source,
MouseEvent sourceEvent,
Component destination)
sourceEvent except that its x
and y members have been converted to destination's coordinate
system. If source is null, sourceEvent x and y members
are assumed to be into destination's root component coordinate system.
If destination is null, the
returned MouseEvent will be in source's coordinate system.
sourceEvent will not be changed. A new event is returned.
the source field of the returned event will be set
to destination if destination is non null
use the translateMouseEvent() method to translate a mouse event from
one component to another without changing the source.
public static void convertPointToScreen(Point p,
Component c)
p - a Point object (converted to the new coordinate system)c - a Component object
public static void convertPointFromScreen(Point p,
Component c)
p - a Point object (converted to the new coordinate system)c - a Component objectpublic static Window windowForComponent(Component aComponent)
aComponent's window
public static boolean isDescendingFrom(Component a,
Component b)
true if a component a descends from a component b
public static Rectangle computeIntersection(int x,
int y,
int width,
int height,
Rectangle dest)
x - the X coordinate of the first rectangle's top-left pointy - the Y coordinate of the first rectangle's top-left pointwidth - the width of the first rectangleheight - the height of the first rectangledest - the second rectangle
dest, modified to specify the intersection
public static Rectangle computeUnion(int x,
int y,
int width,
int height,
Rectangle dest)
x - the x-coordinate of the first rectangley - the y-coordinate of the first rectanglewidth - the width of the first rectangleheight - the height of the first rectangledest - the coordinates of the second rectangle; the union
of the two rectangles is returned in this rectangle
dest Rectangle
public static Rectangle[] computeDifference(Rectangle rectA,
Rectangle rectB)
rectA that do not overlap with rectB. If the
two Rects do not overlap, returns an empty array
public static boolean isLeftMouseButton(MouseEvent anEvent)
anEvent - a MouseEvent object
public static boolean isMiddleMouseButton(MouseEvent anEvent)
anEvent - a MouseEvent object
public static boolean isRightMouseButton(MouseEvent anEvent)
anEvent - a MouseEvent object
public static int computeStringWidth(FontMetrics fm,
String str)
fm - a FontMetrics object to compute withstr - the String to compute
public static String layoutCompoundLabel(JComponent c,
FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
public static String layoutCompoundLabel(FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
private static String layoutCompoundLabelImpl(JComponent c,
FontMetrics fm,
String text,
Icon icon,
int verticalAlignment,
int horizontalAlignment,
int verticalTextPosition,
int horizontalTextPosition,
Rectangle viewR,
Rectangle iconR,
Rectangle textR,
int textIconGap)
public static void paintComponent(Graphics g,
Component c,
Container p,
int x,
int y,
int w,
int h)
c on an arbitrary graphics
g in the
specified rectangle, specifying the rectangle's upper left corner
and size. The component is reparented to a private
container (whose parent becomes p) which prevents
c.validate() and c.repaint()
calls from propagating up the tree. The intermediate
container has no other effect.
The component should either descend from JComponent
or be another kind of lightweight component.
A lightweight component is one whose "lightweight" property
(returned by the Component
isLightweight method)
is true. If the Component is not lightweight, bad things map happen:
crashes, exceptions, painting problems...
g - the Graphics object to draw onc - the Component to drawp - the intermediate Containerx - an int specifying the left side of the area draw in, in pixels,
measured from the left edge of the graphics contexty - an int specifying the top of the area to draw in, in pixels
measured down from the top edge of the graphics contextw - an int specifying the width of the area draw in, in pixelsh - an int specifying the height of the area draw in, in pixelsjava.awt.Component#isLightweight
public static void paintComponent(Graphics g,
Component c,
Container p,
Rectangle r)
c on an arbitrary graphics
g in the specified rectangle, specifying a Rectangle object.
The component is reparented to a private
container (whose parent becomes p) which prevents
c.validate() and c.repaint()
calls from propagating up the tree. The intermediate
container has no other effect.
The component should either descend from JComponent
or be another kind of lightweight component.
A lightweight component is one whose "lightweight" property
(returned by the Component
isLightweight method)
is true. If the Component is not lightweight, bad things map happen:
crashes, exceptions, painting problems...
g - the Graphics object to draw onc - the Component to drawp - the intermediate Containerr - the Rectangle to draw injava.awt.Component#isLightweight
private static CellRendererPane getCellRendererPane(Component c,
Container p)
public static void updateComponentTreeUI(Component c)
updateUI() -- that is, to initialize its UI property
with the current look and feel.
private static void updateComponentTreeUI0(Component c)
public static void invokeLater(Runnable doRun)
invokeLater call queues
the Runnable object doHelloWorld
on the event dispatching thread and
then prints a message.
Runnable doHelloWorld = new Runnable() {
public void run() {
System.out.println("Hello World on " + Thread.currentThread());
}
};
SwingUtilities.invokeLater(doHelloWorld);
System.out.println("This might well be displayed before the other message.");
If invokeLater is called from the event dispatching thread --
for example, from a JButton's ActionListener -- the doRun.run() will
still be deferred until all pending events have been processed.
Note that if the doRun.run() throws an uncaught exception
the event dispatching thread will unwind (not the current thread).
Additional documentation and examples for this method can be found in How to Use Threads, in The Java Tutorial.
As of 1.3 this method is just a cover for java.awt.EventQueue.invokeLater().
invokeAndWait(java.lang.Runnable)
public static void invokeAndWait(Runnable doRun)
throws InterruptedException,
java.lang.reflect.InvocationTargetException
final Runnable doHelloWorld = new Runnable() {
public void run() {
System.out.println("Hello World on " + Thread.currentThread());
}
};
Thread appThread = new Thread() {
public void run() {
try {
SwingUtilities.invokeAndWait(doHelloWorld);
}
catch (Exception e) {
e.printStackTrace();
}
System.out.println("Finished on " + Thread.currentThread());
}
};
appThread.start();
Note that if the Runnable.run() method throws an uncaught exception
(on the event dispatching thread) it's caught and rethrown, as
an InvocationTargetException, on the callers thread.
Additional documentation and examples for this method can be found in How to Use Threads, in The Java Tutorial.
As of 1.3 this method is just a cover for java.awt.EventQueue.invokeAndWait().
InterruptedException
java.lang.reflect.InvocationTargetExceptioninvokeLater(java.lang.Runnable)public static boolean isEventDispatchThread()
As of 1.3 this method is just a cover for
java.awt.EventQueue.isDispatchThread().
public static int getAccessibleIndexInParent(Component c)
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
public static Accessible getAccessibleAt(Component c,
Point p)
Accessible child contained at the
local coordinate Point, if one exists.
Otherwise returns null.
Accessible at the specified location,
if it exists; otherwise nullpublic static AccessibleStateSet getAccessibleStateSet(Component c)
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
AccessibleStatepublic static int getAccessibleChildrenCount(Component c)
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
public static Accessible getAccessibleChild(Component c,
int i)
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
i - zero-based index of child
public static Component findFocusOwner(Component c)
KeyboardFocusManager.getFocusOwner().
Component of the specified
Component that is the focus owner, if any.
null if there is no focus
owner, or if the focus owner is not comp, or a
descendant of compjava.awt.KeyboardFocusManager#getFocusOwnerpublic static JRootPane getRootPane(Component c)
public static Component getRoot(Component c)
public static boolean processKeyBindings(KeyEvent event)
Component associated with
event. This method is only useful if
event.getComponent() does not descend from
JComponent, or your are not invoking
super.processKeyEvent from within your
JComponent subclass. JComponent
automatically processes bindings from within its
processKeyEvent method, hence you rarely need
to directly invoke this method.
event - KeyEvent used to identify which bindings to process, as
well as which Component has focus.
static boolean isValidKeyEventForKeyBindings(KeyEvent e)
e is a valid KeyEvent to use in
processing the key bindings associated with JComponents.
public static boolean notifyAction(Action action,
KeyStroke ks,
KeyEvent event,
Object sender,
int modifiers)
actionPerformed on action if
action is enabled (and non null). The command for the
ActionEvent is determined by:
registerKeyboardAction, then the command string
passed in (null will be used if null was passed in).
getKeyChar
returns KeyEvent.CHAR_UNDEFINED..
action is non-null and
actionPerformed is invoked on it.
public static void replaceUIInputMap(JComponent component,
int type,
InputMap uiInputMap)
component
to uiInputMap. If uiInputMap is null,
this removes any previously installed UI InputMap.
public static void replaceUIActionMap(JComponent component,
ActionMap uiActionMap)
component
to uiActionMap. If uiActionMap is null,
this removes any previously installed UI ActionMap.
public static InputMap getUIInputMap(JComponent component,
int condition)
condition in component component.
This will return null if the UI has not installed a InputMap of the specified type.
public static ActionMap getUIActionMap(JComponent component)
component.
This will return null if the UI has not installed an ActionMap.
static Frame getSharedOwnerFrame()
throws HeadlessException
HeadlessExceptionjava.awt.GraphicsEnvironment#isHeadlessstatic Object appContextGet(Object key)
static void appContextPut(Object key,
Object value)
static void appContextRemove(Object key)
static Class loadSystemClass(String className)
throws ClassNotFoundException
ClassNotFoundExceptionstatic final void doPrivileged(Runnable doRun)
static boolean isLeftToRight(Component c)
static boolean doesIconReferenceImage(Icon icon,
Image image)
icon is an instance of
ImageIcon, and the image it contains is the same as image.
static int findDisplayedMnemonicIndex(String text,
int mnemonic)
mnemonic
within string text. Matching algorithm is not
case-sensitive.
text - The text to search through, may be nullmnemonic - The mnemonic to find the character for.
public static Rectangle calculateInnerArea(JComponent c,
Rectangle r)
r and returns r.
The position and size specify the bounds of the component,
adjusted so as not to include the border area (the insets).
This method is useful for classes
that implement painting code.
c - the JComponent in question; if null, this method returns nullr - the Rectangle instance to be modified;
may be null
|
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
