- java.lang.Object
-
- javax.swing.SwingUtilities
-
- All Implemented Interfaces:
SwingConstants
public class SwingUtilities extends Object implements SwingConstants
A collection of utility methods for Swing.- Since:
- 1.2
-
-
Field Summary
-
Fields declared in 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
-
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static RectanglecalculateInnerArea(JComponent c, Rectangle r)Stores the position and size of the inner painting area of the specified component inrand returnsr.static Rectangle[]computeDifference(Rectangle rectA, Rectangle rectB)Convenience returning an array of rect representing the regions withinrectAthat do not overlap withrectB.static RectanglecomputeIntersection(int x, int y, int width, int height, Rectangle dest)Convenience to calculate the intersection of two rectangles without allocating a new rectangle.static intcomputeStringWidth(FontMetrics fm, String str)Compute the width of the string using a font with the specified "metrics" (sizes).static RectanglecomputeUnion(int x, int y, int width, int height, Rectangle dest)Convenience method that calculates the union of two rectangles without allocating a new rectangle.static MouseEventconvertMouseEvent(Component source, MouseEvent sourceEvent, Component destination)Returns a MouseEvent similar tosourceEventexcept that its x and y members have been converted todestination's coordinate system.static PointconvertPoint(Component source, int x, int y, Component destination)Convert the point(x,y)insourcecoordinate system todestinationcoordinate system.static PointconvertPoint(Component source, Point aPoint, Component destination)Convert aaPointinsourcecoordinate system todestinationcoordinate system.static voidconvertPointFromScreen(Point p, Component c)Convert a point from a screen coordinates to a component's coordinate systemstatic voidconvertPointToScreen(Point p, Component c)Convert a point from a component's coordinate system to screen coordinates.static RectangleconvertRectangle(Component source, Rectangle aRectangle, Component destination)Convert the rectangleaRectangleinsourcecoordinate system todestinationcoordinate system.static ComponentfindFocusOwner(Component c)Deprecated.As of 1.4, replaced byKeyboardFocusManager.getFocusOwner().static AccessiblegetAccessibleAt(Component c, Point p)Returns theAccessiblechild contained at the local coordinatePoint, if one exists.static AccessiblegetAccessibleChild(Component c, int i)Return the nth Accessible child of the object.static intgetAccessibleChildrenCount(Component c)Returns the number of accessible children in the object.static intgetAccessibleIndexInParent(Component c)Get the index of this object in its accessible parent.static AccessibleStateSetgetAccessibleStateSet(Component c)Get the state of this object.static ContainergetAncestorNamed(String name, Component comp)Convenience method for searching abovecompin the component hierarchy and returns the first object ofnameit finds.static ContainergetAncestorOfClass(Class<?> c, Component comp)Convenience method for searching abovecompin the component hierarchy and returns the first object of classcit finds.static ComponentgetDeepestComponentAt(Component parent, int x, int y)Returns the deepest visible descendent Component ofparentthat contains the locationx,y.static RectanglegetLocalBounds(Component aComponent)Return the rectangle (0,0,bounds.width,bounds.height) for the componentaComponentstatic ComponentgetRoot(Component c)Returns the root component for the current component tree.static JRootPanegetRootPane(Component c)If c is a JRootPane descendant return its JRootPane ancestor.static ActionMapgetUIActionMap(JComponent component)Returns the ActionMap provided by the UI in componentcomponent.static InputMapgetUIInputMap(JComponent component, int condition)Returns the InputMap provided by the UI for conditionconditionin componentcomponent.static ContainergetUnwrappedParent(Component component)Returns the first ancestor of thecomponentwhich is not an instance ofJLayer.static ComponentgetUnwrappedView(JViewport viewport)Returns the firstJViewport's descendant which is not an instance ofJLayer.static WindowgetWindowAncestor(Component c)Returns the firstWindowancestor ofc, ornullifcis not contained inside aWindow.static voidinvokeAndWait(Runnable doRun)CausesdoRun.run()to be executed synchronously on the AWT event dispatching thread.static voidinvokeLater(Runnable doRun)Causes doRun.run() to be executed asynchronously on the AWT event dispatching thread.static booleanisDescendingFrom(Component a, Component b)Returntrueif a componentadescends from a componentbstatic booleanisEventDispatchThread()Returns true if the current thread is an AWT event dispatching thread.static booleanisLeftMouseButton(MouseEvent anEvent)Returns true if the mouse event specifies the left mouse button.static booleanisMiddleMouseButton(MouseEvent anEvent)Returns true if the mouse event specifies the middle mouse button.static booleanisRectangleContainingRectangle(Rectangle a, Rectangle b)Returntrueif @{code a} containsbstatic booleanisRightMouseButton(MouseEvent anEvent)Returns true if the mouse event specifies the right mouse button.static StringlayoutCompoundLabel(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.static StringlayoutCompoundLabel(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.static booleannotifyAction(Action action, KeyStroke ks, KeyEvent event, Object sender, int modifiers)InvokesactionPerformedonactionifactionis non-nulland accepts the sender object.static voidpaintComponent(Graphics g, Component c, Container p, int x, int y, int w, int h)Paints a component to the specifiedGraphics.static voidpaintComponent(Graphics g, Component c, Container p, Rectangle r)Paints a component to the specifiedGraphics.static booleanprocessKeyBindings(KeyEvent event)Process the key bindings for theComponentassociated withevent.static voidreplaceUIActionMap(JComponent component, ActionMap uiActionMap)Convenience method to change the UI ActionMap forcomponenttouiActionMap.static voidreplaceUIInputMap(JComponent component, int type, InputMap uiInputMap)Convenience method to change the UI InputMap forcomponenttouiInputMap.static voidupdateComponentTreeUI(Component c)A simple minded look and feel change: ask each node in the tree toupdateUI()-- that is, to initialize its UI property with the current look and feel.static WindowwindowForComponent(Component c)Returns the firstWindowancestor ofc, ornullifcis not contained inside aWindow.
-
-
-
Method Detail
-
isRectangleContainingRectangle
public static final boolean isRectangleContainingRectangle(Rectangle a, Rectangle b)
Returntrueif @{code a} containsb- Parameters:
a- the first rectangleb- the second rectangle- Returns:
trueif @{code a} containsb
-
getLocalBounds
public static Rectangle getLocalBounds(Component aComponent)
Return the rectangle (0,0,bounds.width,bounds.height) for the componentaComponent- Parameters:
aComponent- a component- Returns:
- the local bounds for the component
aComponent
-
getWindowAncestor
public static Window getWindowAncestor(Component c)
Returns the firstWindowancestor ofc, ornullifcis not contained inside aWindow.- Parameters:
c-Componentto getWindowancestor of.- Returns:
- the first
Windowancestor ofc, ornullifcis not contained inside aWindow. - Since:
- 1.3
-
convertPoint
public static Point convertPoint(Component source, Point aPoint, Component destination)
Convert aaPointinsourcecoordinate system todestinationcoordinate system. Ifsourceisnull,aPointis assumed to be indestination's root component coordinate system. Ifdestinationisnull,aPointwill be converted tosource's root component coordinate system. If bothsourceanddestinationarenull, returnaPointwithout any conversion.- Parameters:
source- the source componentaPoint- the pointdestination- the destination component- Returns:
- the converted coordinate
-
convertPoint
public static Point convertPoint(Component source, int x, int y, Component destination)
Convert the point(x,y)insourcecoordinate system todestinationcoordinate system. Ifsourceisnull,(x,y)is assumed to be indestination's root component coordinate system. Ifdestinationisnull,(x,y)will be converted tosource's root component coordinate system. If bothsourceanddestinationarenull, return(x,y)without any conversion.- Parameters:
source- the source componentx- the x-coordinate of the pointy- the y-coordinate of the pointdestination- the destination component- Returns:
- the converted coordinate
-
convertRectangle
public static Rectangle convertRectangle(Component source, Rectangle aRectangle, Component destination)
Convert the rectangleaRectangleinsourcecoordinate system todestinationcoordinate system. Ifsourceisnull,aRectangleis assumed to be indestination's root component coordinate system. Ifdestinationisnull,aRectanglewill be converted tosource's root component coordinate system. If bothsourceanddestinationarenull, returnaRectanglewithout any conversion.- Parameters:
source- the source componentaRectangle- a rectangledestination- the destination component- Returns:
- the converted rectangle
-
getAncestorOfClass
public static Container getAncestorOfClass(Class<?> c, Component comp)
Convenience method for searching abovecompin the component hierarchy and returns the first object of classcit finds. Can returnnull, if a classccannot be found.- Parameters:
c- the class of a componentcomp- the component- Returns:
- the ancestor of the
comp, ornullifccannot be found.
-
getAncestorNamed
public static Container getAncestorNamed(String name, Component comp)
Convenience method for searching abovecompin the component hierarchy and returns the first object ofnameit finds. Can returnnull, ifnamecannot be found.- Parameters:
name- the name of a componentcomp- the component- Returns:
- the ancestor of the
comp, ornullifnamecannot be found.
-
getDeepestComponentAt
public static Component getDeepestComponentAt(Component parent, int x, int y)
Returns the deepest visible descendent Component ofparentthat contains the locationx,y. Ifparentdoes not contain the specified location, thennullis returned. Ifparentis not a container, or none ofparent's visible descendents contain the specified location,parentis returned.- Parameters:
parent- the root component to begin the searchx- the x target locationy- the y target location- Returns:
- the deepest component
-
convertMouseEvent
public static MouseEvent convertMouseEvent(Component source, MouseEvent sourceEvent, Component destination)
Returns a MouseEvent similar tosourceEventexcept that its x and y members have been converted todestination's coordinate system. Ifsourceisnull,sourceEventx and y members are assumed to be intodestination's root component coordinate system. Ifdestinationisnull, the returned MouseEvent will be insource's coordinate system.sourceEventwill not be changed. A new event is returned. thesourcefield of the returned event will be set todestinationif destination is non-nulluse the translateMouseEvent() method to translate a mouse event from one component to another without changing the source.- Parameters:
source- the source componentsourceEvent- the source mouse eventdestination- the destination component- Returns:
- the new mouse event
-
convertPointToScreen
public static void convertPointToScreen(Point p, Component c)
Convert a point from a component's coordinate system to screen coordinates.- Parameters:
p- a Point object (converted to the new coordinate system)c- a Component object
-
convertPointFromScreen
public static void convertPointFromScreen(Point p, Component c)
Convert a point from a screen coordinates to a component's coordinate system- Parameters:
p- a Point object (converted to the new coordinate system)c- a Component object
-
windowForComponent
public static Window windowForComponent(Component c)
Returns the firstWindowancestor ofc, ornullifcis not contained inside aWindow.Note: This method provides the same functionality as
getWindowAncestor.- Parameters:
c-Componentto getWindowancestor of.- Returns:
- the first
Windowancestor ofc, ornullifcis not contained inside aWindow.
-
isDescendingFrom
public static boolean isDescendingFrom(Component a, Component b)
Returntrueif a componentadescends from a componentb- Parameters:
a- the first componentb- the second component- Returns:
trueif a componentadescends from a componentb
-
computeIntersection
public static Rectangle computeIntersection(int x, int y, int width, int height, Rectangle dest)
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.- Parameters:
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- Returns:
dest, modified to specify the intersection
-
computeUnion
public static Rectangle computeUnion(int x, int y, int width, int height, Rectangle dest)
Convenience method that calculates the union of two rectangles without allocating a new rectangle.- Parameters:
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- Returns:
- the
destRectangle
-
computeDifference
public static Rectangle[] computeDifference(Rectangle rectA, Rectangle rectB)
Convenience returning an array of rect representing the regions withinrectAthat do not overlap withrectB. If the two Rects do not overlap, returns an empty array- Parameters:
rectA- the first rectanglerectB- the second rectangle- Returns:
- an array of rectangles representing the regions within
rectAthat do not overlap withrectB.
-
isLeftMouseButton
public static boolean isLeftMouseButton(MouseEvent anEvent)
Returns true if the mouse event specifies the left mouse button.- Parameters:
anEvent- a MouseEvent object- Returns:
- true if the left mouse button was active
-
isMiddleMouseButton
public static boolean isMiddleMouseButton(MouseEvent anEvent)
Returns true if the mouse event specifies the middle mouse button.- Parameters:
anEvent- a MouseEvent object- Returns:
- true if the middle mouse button was active
-
isRightMouseButton
public static boolean isRightMouseButton(MouseEvent anEvent)
Returns true if the mouse event specifies the right mouse button.- Parameters:
anEvent- a MouseEvent object- Returns:
- true if the right mouse button was active
-
computeStringWidth
public static int computeStringWidth(FontMetrics fm, String str)
Compute the width of the string using a font with the specified "metrics" (sizes).- Parameters:
fm- a FontMetrics object to compute withstr- the String to compute- Returns:
- an int containing the string width
-
layoutCompoundLabel
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)
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.- Parameters:
c- the componentfm- the instance ofFontMetricstext- the texticon- the iconverticalAlignment- the vertical alignmenthorizontalAlignment- the horizontal alignmentverticalTextPosition- the vertical text positionhorizontalTextPosition- the horizontal text positionviewR- the available rectangleiconR- the rectangle for the icontextR- the rectangle for the texttextIconGap- the gap between text and icon- Returns:
- the possibly clipped version of the compound labels string
-
layoutCompoundLabel
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)
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.- Parameters:
fm- the instance ofFontMetricstext- the texticon- the iconverticalAlignment- the vertical alignmenthorizontalAlignment- the horizontal alignmentverticalTextPosition- the vertical text positionhorizontalTextPosition- the horizontal text positionviewR- the available rectangleiconR- the rectangle for the icontextR- the rectangle for the texttextIconGap- the gap between text and icon- Returns:
- the possibly clipped version of the compound labels string
-
paintComponent
public static void paintComponent(Graphics g, Component c, Container p, int x, int y, int w, int h)
Paints a component to the specifiedGraphics. This method is primarily useful to renderComponents 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 ofJLabel'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
CellRendererPaneto 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, asJTabledoes, useCellRendererPanedirectly. Otherwise, as described below, you could end up with aCellRendererPaneperComponent.If
c's parent is not aCellRendererPane, a newCellRendererPaneis created,cis added to it, and theCellRendererPaneis added top. Ifc's parent is aCellRendererPaneand theCellRendererPanes parent is notp, it is added top.The component should either descend from
JComponentor be another kind of lightweight component. A lightweight component is one whose "lightweight" property (returned by theComponentisLightweightmethod) is true. If the Component is not lightweight, bad things map happen: crashes, exceptions, painting problems...- Parameters:
g- theGraphicsobject to draw onc- theComponentto drawp- the intermediateContainerx- 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 pixels- See Also:
CellRendererPane,Component.isLightweight()
-
paintComponent
public static void paintComponent(Graphics g, Component c, Container p, Rectangle r)
Paints a component to the specifiedGraphics. This is a cover method forpaintComponent(Graphics,Component,Container,int,int,int,int). Refer to it for more information.- Parameters:
g- theGraphicsobject to draw onc- theComponentto drawp- the intermediateContainerr- theRectangleto draw in- See Also:
paintComponent(Graphics,Component,Container,int,int,int,int),CellRendererPane
-
updateComponentTreeUI
public static void updateComponentTreeUI(Component c)
A simple minded look and feel change: ask each node in the tree toupdateUI()-- that is, to initialize its UI property with the current look and feel.- Parameters:
c- the component
-
invokeLater
public static void invokeLater(Runnable 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 theinvokeLatercall queues theRunnableobjectdoHelloWorldon 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 Concurrency in Swing.
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.
- Parameters:
doRun- the instance ofRunnable- See Also:
invokeAndWait(java.lang.Runnable)
-
invokeAndWait
public static void invokeAndWait(Runnable doRun) throws InterruptedException, InvocationTargetException
CausesdoRun.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 usesinvokeAndWaitto 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 theRunnable.runmethod throws an uncaught exception (on the event dispatching thread) it's caught and rethrown, as anInvocationTargetException, on the caller's thread.Additional documentation and examples for this method can be found in Concurrency in Swing.
As of 1.3 this method is just a cover for
java.awt.EventQueue.invokeAndWait().- Parameters:
doRun- the instance ofRunnable- Throws:
InterruptedException- if we're interrupted while waiting for the event dispatching thread to finish executingdoRun.run()InvocationTargetException- if an exception is thrown while runningdoRun- See Also:
invokeLater(java.lang.Runnable)
-
isEventDispatchThread
public static boolean isEventDispatchThread()
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 current thread is an AWT event dispatching thread
-
getAccessibleIndexInParent
public static int getAccessibleIndexInParent(Component c)
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.
- Parameters:
c- the component- Returns:
- -1 of this object does not have an accessible parent. Otherwise, the index of the child in its accessible parent.
-
getAccessibleAt
public static Accessible getAccessibleAt(Component c, Point p)
Returns theAccessiblechild contained at the local coordinatePoint, if one exists. Otherwise returnsnull.- Parameters:
c- the componentp- the local coordinate- Returns:
- the
Accessibleat the specified location, if it exists; otherwisenull
-
getAccessibleStateSet
public static AccessibleStateSet getAccessibleStateSet(Component c)
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.
- Parameters:
c- the component- Returns:
- an instance of AccessibleStateSet containing the current state set of the object
- See Also:
AccessibleState
-
getAccessibleChildrenCount
public static int getAccessibleChildrenCount(Component c)
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.
- Parameters:
c- the component- Returns:
- the number of accessible children in the object.
-
getAccessibleChild
public static Accessible getAccessibleChild(Component c, int i)
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.
- Parameters:
c- the componenti- zero-based index of child- Returns:
- the nth Accessible child of the object
-
findFocusOwner
@Deprecated public static Component findFocusOwner(Component c)
Deprecated.As of 1.4, replaced byKeyboardFocusManager.getFocusOwner().Return the childComponentof the specifiedComponentthat is the focus owner, if any.- Parameters:
c- the root of theComponenthierarchy to search for the focus owner- Returns:
- the focus owner, or
nullif there is no focus owner, or if the focus owner is notcomp, or a descendant ofcomp - See Also:
KeyboardFocusManager.getFocusOwner()
-
getRootPane
public static JRootPane getRootPane(Component c)
If c is a JRootPane descendant return its JRootPane ancestor. If c is a RootPaneContainer then return its JRootPane.- Parameters:
c- the component- Returns:
- the JRootPane for Component c or
null.
-
getRoot
public static Component getRoot(Component c)
Returns the root component for the current component tree.- Parameters:
c- the component- Returns:
- the first ancestor of c that's a Window or the last Applet ancestor
-
processKeyBindings
public static boolean processKeyBindings(KeyEvent event)
Process the key bindings for theComponentassociated withevent. This method is only useful ifevent.getComponent()does not descend fromJComponent, or your are not invokingsuper.processKeyEventfrom within yourJComponentsubclass.JComponentautomatically processes bindings from within itsprocessKeyEventmethod, hence you rarely need to directly invoke this method.- Parameters:
event- KeyEvent used to identify which bindings to process, as well as which Component has focus.- Returns:
- true if a binding has found and processed
- Since:
- 1.4
-
notifyAction
public static boolean notifyAction(Action action, KeyStroke ks, KeyEvent event, Object sender, int modifiers)
InvokesactionPerformedonactionifactionis non-nulland accepts the sender object. The command for the ActionEvent is determined by:- If the action was registered via
registerKeyboardAction, then the command string passed in (nullwill be used ifnullwas passed in). - Action value with name Action.ACTION_COMMAND_KEY, unless
null. - String value of the KeyEvent, unless
getKeyCharreturns KeyEvent.CHAR_UNDEFINED..
actionis non-nulland actionPerformed is invoked on it.- Parameters:
action- an actionks- a key strokeevent- a key eventsender- a sendermodifiers- action modifiers- Returns:
trueifactionis non-nulland actionPerformed is invoked on it.- Since:
- 1.3
- See Also:
Action.accept(java.lang.Object)
- If the action was registered via
-
replaceUIInputMap
public static void replaceUIInputMap(JComponent component, int type, InputMap uiInputMap)
Convenience method to change the UI InputMap forcomponenttouiInputMap. IfuiInputMapisnull, this removes any previously installed UI InputMap.- Parameters:
component- a componenttype- a typeuiInputMap- anInputMap- Since:
- 1.3
-
replaceUIActionMap
public static void replaceUIActionMap(JComponent component, ActionMap uiActionMap)
Convenience method to change the UI ActionMap forcomponenttouiActionMap. IfuiActionMapisnull, this removes any previously installed UI ActionMap.- Parameters:
component- a componentuiActionMap- anActionMap- Since:
- 1.3
-
getUIInputMap
public static InputMap getUIInputMap(JComponent component, int condition)
Returns the InputMap provided by the UI for conditionconditionin componentcomponent.This will return
nullif the UI has not installed an InputMap of the specified type.- Parameters:
component- a componentcondition- a condition- Returns:
- the
ActionMapprovided by the UI forconditionin the component, ornullif the UI has not installed an InputMap of the specified type. - Since:
- 1.3
-
getUIActionMap
public static ActionMap getUIActionMap(JComponent component)
Returns the ActionMap provided by the UI in componentcomponent.This will return
nullif the UI has not installed an ActionMap.- Parameters:
component- a component- Returns:
- the
ActionMapprovided by the UI in the component, ornullif the UI has not installed an ActionMap. - Since:
- 1.3
-
calculateInnerArea
public static Rectangle calculateInnerArea(JComponent c, Rectangle r)
Stores the position and size of the inner painting area of the specified component inrand returnsr. 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.- Parameters:
c- the JComponent in question; ifnull, this method returnsnullr- the Rectangle instance to be modified; may benull- Returns:
nullif the Component isnull; otherwise, returns the passed-in rectangle (if non-null) or a new rectangle specifying position and size information- Since:
- 1.4
-
getUnwrappedParent
public static Container getUnwrappedParent(Component component)
Returns the first ancestor of thecomponentwhich is not an instance ofJLayer.- Parameters:
component-Componentto get the first ancestor of, which is not aJLayerinstance.- Returns:
- the first ancestor of the
componentwhich is not an instance ofJLayer. If such an ancestor can not be found,nullis returned. - Throws:
NullPointerException- ifcomponentisnull- Since:
- 1.7
- See Also:
JLayer
-
getUnwrappedView
public static Component getUnwrappedView(JViewport viewport)
Returns the firstJViewport's descendant which is not an instance ofJLayer. If such a descendant can not be found,nullis returned. If theviewport's view component is not aJLayer, this method is equivalent toJViewport.getView()otherwiseJLayer.getView()will be recursively called on all descendingJLayers.- Parameters:
viewport-JViewportto get the first descendant of, which in not aJLayerinstance.- Returns:
- the first
JViewport's descendant which is not an instance ofJLayer. If such a descendant can not be found,nullis returned. - Throws:
NullPointerException- ifviewportisnull- Since:
- 1.7
- See Also:
JViewport.getView(),JLayer
-
-