java.lang.Object | |
↳ | javax.swing.SwingUtilities |
A collection of utility methods for Swing.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Stores the position and size of
the inner painting area of the specified component
in
r and returns r . | |||||||||||
Convenience returning an array of rect representing the regions within
rectA that do not overlap with rectB . | |||||||||||
Convenience to calculate the intersection of two rectangles
without allocating a new rectangle.
| |||||||||||
Compute the width of the string using a font with the specified
"metrics" (sizes).
| |||||||||||
Convenience method that calculates the union of two rectangles
without allocating a new rectangle.
| |||||||||||
Returns a MouseEvent similar to
sourceEvent except that its x
and y members have been converted to destination 's coordinate
system. | |||||||||||
Convert a
aPoint in source coordinate system to
destination coordinate system. | |||||||||||
Convert the point
(x,y) in source coordinate system to
destination coordinate system. | |||||||||||
Convert a point from a screen coordinates to a component's
coordinate system
| |||||||||||
Convert a point from a component's coordinate system to
screen coordinates.
| |||||||||||
Convert the rectangle
aRectangle in source coordinate system to
destination coordinate system. | |||||||||||
This method is deprecated.
As of 1.4, replaced by
KeyboardFocusManager.getFocusOwner() .
| |||||||||||
Returns the
Accessible child contained at the
local coordinate Point , if one exists. | |||||||||||
Return the nth Accessible child of the object.
| |||||||||||
Returns the number of accessible children in the object.
| |||||||||||
Get the index of this object in its accessible parent.
| |||||||||||
Get the state of this object.
| |||||||||||
Convenience method for searching above
comp in the
component hierarchy and returns the first object of name it
finds. | |||||||||||
Convenience method for searching above
comp in the
component hierarchy and returns the first object of class c it
finds. | |||||||||||
Returns the deepest visible descendent Component of
parent
that contains the location x , y . | |||||||||||
Return the rectangle (0,0,bounds.width,bounds.height) for the component
aComponent
| |||||||||||
Returns the root component for the current component tree.
| |||||||||||
If c is a JRootPane descendant return its JRootPane ancestor.
| |||||||||||
Returns the ActionMap provided by the UI
in component
component . | |||||||||||
Returns the InputMap provided by the UI for condition
condition in component component . | |||||||||||
Returns the first
Window ancestor of c , or
null if c is not contained inside a Window . | |||||||||||
Causes
doRun.run() to be executed synchronously on the
AWT event dispatching thread. | |||||||||||
Causes doRun.run() to be executed asynchronously on the
AWT event dispatching thread.
| |||||||||||
Return
true if a component a descends from a component b
| |||||||||||
Returns true if the current thread is an AWT event dispatching thread.
| |||||||||||
Returns true if the mouse event specifies the left mouse button.
| |||||||||||
Returns true if the mouse event specifies the middle mouse button.
| |||||||||||
Return true if
a contains b
| |||||||||||
Returns true if the mouse event specifies the right mouse button.
| |||||||||||
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.
| |||||||||||
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.
| |||||||||||
Invokes
actionPerformed on action if
action is enabled (and non-null ). | |||||||||||
Paints a component to the specified
Graphics . | |||||||||||
Paints a component to the specified
Graphics . | |||||||||||
Process the key bindings for the
Component associated with
event . | |||||||||||
Convenience method to change the UI ActionMap for
component
to uiActionMap . | |||||||||||
Convenience method to change the UI InputMap for
component
to uiInputMap . | |||||||||||
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. | |||||||||||
Returns the first
Window ancestor of c , or
null if c is not contained inside a Window . |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Stores the position and size of
the inner painting area of the specified component
in 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 null |
---|---|
r | the Rectangle instance to be modified;
may be null |
null
if the Component is null
;
otherwise, returns the passed-in rectangle (if non-null
)
or a new rectangle specifying position and size informationConvenience returning an array of rect representing the regions within
rectA
that do not overlap with rectB
. If the
two Rects do not overlap, returns an empty array
Convenience to calculate the intersection of two rectangles without allocating a new rectangle. If the two rectangles don't intersect, then the returned rectangle begins at (0,0) and has zero width and height.
x | the X coordinate of the first rectangle's top-left point |
---|---|
y | the Y coordinate of the first rectangle's top-left point |
width | the width of the first rectangle |
height | the height of the first rectangle |
dest | the second rectangle |
dest
, modified to specify the intersection
Compute the width of the string using a font with the specified "metrics" (sizes).
fm | a FontMetrics object to compute with |
---|---|
str | the String to compute |
Convenience method that calculates the union of two rectangles without allocating a new rectangle.
x | the x-coordinate of the first rectangle |
---|---|
y | the y-coordinate of the first rectangle |
width | the width of the first rectangle |
height | the height of the first rectangle |
dest | the coordinates of the second rectangle; the union of the two rectangles is returned in this rectangle |
dest
Rectangle
Returns a MouseEvent similar to 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.
Convert a 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 destination
is null
, aPoint
will be converted to source
's
root component coordinate system.
If both source
and destination
are null
, return aPoint
without any conversion.
Convert the point (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 destination
is 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.
Convert a point from a screen coordinates to a component's coordinate system
p | a Point object (converted to the new coordinate system) |
---|---|
c | a Component object |
Convert a point from a component's coordinate system to screen coordinates.
p | a Point object (converted to the new coordinate system) |
---|---|
c | a Component object |
Convert the rectangle 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 destination
is null
, aRectangle
will be converted to source
's
root component coordinate system.
If both source
and destination
are null
, return aRectangle
without any conversion.
This method is deprecated.
As of 1.4, replaced by
KeyboardFocusManager.getFocusOwner()
.
Return the child Component
of the specified
Component
that is the focus owner, if any.
c | the root of the Component hierarchy to
search for the focus owner |
---|
null
if there is no focus
owner, or if the focus owner is not comp
, or a
descendant of comp
Returns the Accessible
child contained at the
local coordinate Point
, if one exists.
Otherwise returns null
.
Accessible
at the specified location,
if it exists; otherwise null
Return the nth Accessible child of the object.
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 |
---|
Returns the number of accessible children in the object. If all of the children of this object implement Accessible, than this method should return the number of children of this object.
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
Get the index of this object in its accessible parent.
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
Get the state of this object.
Note: as of the Java 2 platform v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleIndexInParent() instead of using this method.
Convenience method for searching above comp
in the
component hierarchy and returns the first object of name
it
finds. Can return null
, if name
cannot be found.
Convenience method for searching above 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.
Returns the deepest visible descendent Component of 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 search |
---|---|
x | the x target location |
y | the y target location |
Return the rectangle (0,0,bounds.width,bounds.height) for the component aComponent
Returns the root component for the current component tree.
If c is a JRootPane descendant return its JRootPane ancestor. If c is a RootPaneContainer then return its JRootPane.
null
.
Returns the ActionMap provided by the UI
in component component
.
This will return null
if the UI has not installed an ActionMap.
Returns the InputMap provided by the UI for condition
condition
in component component
.
This will return null
if the UI has not installed a InputMap
of the specified type.
Returns the first Window
ancestor of c
, or
null
if c
is not contained inside a Window
.
c | Component to get Window ancestor
of. |
---|
Window
ancestor of c
, or
null
if c
is not contained inside a
Window
.Causes doRun.run()
to be executed synchronously on the
AWT event dispatching thread. This call blocks until
all pending AWT events have been processed and (then)
doRun.run()
returns. This method should
be used when an application thread needs to update the GUI.
It shouldn't be called from the event dispatching thread.
Here's an example that creates a new application thread
that uses invokeAndWait
to print a string from the event
dispatching thread and then, when that's finished, print
a string from the application thread.
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 caller's 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 | if we're interrupted while waiting for
the event dispatching thread to finish excecuting
doRun.run() |
---|---|
InvocationTargetException | if an exception is thrown
while running doRun |
Causes doRun.run() to be executed asynchronously on the
AWT event dispatching thread. This will happen after all
pending AWT events have been processed. This method should
be used when an application thread needs to update the GUI.
In the following example the 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()
.
Unlike the rest of Swing, this method can be invoked from any thread.
Return true
if a component a
descends from a component b
Returns true if the current thread is an AWT event dispatching thread.
As of 1.3 this method is just a cover for
java.awt.EventQueue.isDispatchThread()
.
Returns true if the mouse event specifies the left mouse button.
anEvent | a MouseEvent object |
---|
Returns true if the mouse event specifies the middle mouse button.
anEvent | a MouseEvent object |
---|
Return true if a
contains b
Returns true if the mouse event specifies the right mouse button.
anEvent | a MouseEvent object |
---|
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. Locations are computed relative to the viewR rectangle. This layoutCompoundLabel() does not know how to handle LEADING/TRAILING values in horizontalTextPosition (they will default to RIGHT) and in horizontalAlignment (they will default to CENTER). Use the other version of layoutCompoundLabel() instead.
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. Locations are computed relative to the viewR rectangle. The JComponents orientation (LEADING/TRAILING) will also be taken into account and translated into LEFT/RIGHT values accordingly.
Invokes 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).
null
.
getKeyChar
returns KeyEvent.CHAR_UNDEFINED..
action
is non-null
and
actionPerformed is invoked on it.Paints a component to the specified Graphics
. This
is a cover method for
paintComponent(Graphics, Component, Container, int, int, int, int)
.
Refer to it for more information.
g | the Graphics object to draw on |
---|---|
c | the Component to draw |
p | the intermediate Container |
r | the Rectangle to draw in |
Paints a component to the specified Graphics
.
This method is primarily useful to render
Component
s that don't exist as part of the visible
containment hierarchy, but are used for rendering. For
example, if you are doing your own rendering and want to render
some text (or even HTML), you could make use of
JLabel
's text rendering support and have it paint
directly by way of this method, without adding the label to the
visible containment hierarchy.
This method makes use of CellRendererPane
to handle
the actual painting, and is only recommended if you use one
component for rendering. If you make use of multiple components
to handle the rendering, as JTable
does, use
CellRendererPane
directly. Otherwise, as described
below, you could end up with a CellRendererPane
per Component
.
If c
's parent is not a CellRendererPane
,
a new CellRendererPane
is created, c
is
added to it, and the CellRendererPane
is added to
p
. If c
's parent is a
CellRendererPane
and the CellRendererPane
s
parent is not p
, it is added to p
.
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 on |
---|---|
c | the Component to draw |
p | the intermediate Container |
x | an int specifying the left side of the area draw in, in pixels, measured from the left edge of the graphics context |
y | an int specifying the top of the area to draw in, in pixels measured down from the top edge of the graphics context |
w | an int specifying the width of the area draw in, in pixels |
h | an int specifying the height of the area draw in, in pixels |
Process the key bindings for the 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. |
---|
Convenience method to change the UI ActionMap for component
to uiActionMap
. If uiActionMap
is null
,
this removes any previously installed UI ActionMap.
Convenience method to change the UI InputMap for component
to uiInputMap
. If uiInputMap
is null
,
this removes any previously installed UI InputMap.
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.
Returns the first Window
ancestor of c
, or
null
if c
is not contained inside a Window
.
Note: This method provides the same functionality as
getWindowAncestor
.
c | Component to get Window ancestor
of. |
---|
Window
ancestor of c
, or
null
if c
is not contained inside a
Window
.