Home » openjdk-7 » javax » swing » [javadoc | source]
javax.swing
public class: SwingUtilities [javadoc | source]
java.lang.Object
   javax.swing.SwingUtilities

All Implemented Interfaces:
    SwingConstants

A collection of utility methods for Swing.
Nested Class Summary:
static class  SwingUtilities.SharedOwnerFrame   
Method from javax.swing.SwingUtilities Summary:
appContextGet,   appContextPut,   appContextRemove,   calculateInnerArea,   computeDifference,   computeIntersection,   computeStringWidth,   computeUnion,   convertMouseEvent,   convertPoint,   convertPoint,   convertPointFromScreen,   convertPointToScreen,   convertRectangle,   convertScreenLocationToParent,   doesIconReferenceImage,   findDisplayedMnemonicIndex,   findFocusOwner,   getAccessibleAt,   getAccessibleChild,   getAccessibleChildrenCount,   getAccessibleIndexInParent,   getAccessibleStateSet,   getAncestorNamed,   getAncestorOfClass,   getDeepestComponentAt,   getLocalBounds,   getPaintingOrigin,   getRoot,   getRootPane,   getSharedOwnerFrame,   getSharedOwnerFrameShutdownListener,   getUIActionMap,   getUIInputMap,   getUnwrappedParent,   getUnwrappedView,   getValidateRoot,   getWindowAncestor,   installSwingDropTargetAsNecessary,   invokeAndWait,   invokeLater,   isDescendingFrom,   isEventDispatchThread,   isLeftMouseButton,   isLeftToRight,   isMiddleMouseButton,   isRectangleContainingRectangle,   isRightMouseButton,   isValidKeyEventForKeyBindings,   layoutCompoundLabel,   layoutCompoundLabel,   loadSystemClass,   notifyAction,   paintComponent,   paintComponent,   processKeyBindings,   replaceUIActionMap,   replaceUIInputMap,   updateComponentTreeUI,   updateRendererOrEditorUI,   windowForComponent
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.SwingUtilities Detail:
 static Object appContextGet(Object key) 
 static  void appContextPut(Object key,
    Object value) 
 static  void appContextRemove(Object key) 
 public static Rectangle calculateInnerArea(JComponent c,
    Rectangle r) 
    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.
 public static Rectangle[] computeDifference(Rectangle rectA,
    Rectangle rectB) 
    Convenience 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
 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.
 public static int computeStringWidth(FontMetrics fm,
    String str) 
    Compute the width of the string using a font with the specified "metrics" (sizes).
 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.
 public static MouseEvent convertMouseEvent(Component source,
    MouseEvent sourceEvent,
    Component destination) 
    Returns a MouseEvent similar to sourceEvent except that its x and y members have been converted to destination's coordinate system. If source is {@code 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-{@code null} use the translateMouseEvent() method to translate a mouse event from one component to another without changing the source.
 public static Point convertPoint(Component source,
    Point aPoint,
    Component destination) 
    Convert a aPoint in source coordinate system to destination coordinate system. If source is {@code null}, aPoint is assumed to be in destination's root component coordinate system. If destination is {@code null}, aPoint will be converted to source's root component coordinate system. If both source and destination are {@code null}, return aPoint without any conversion.
 public static Point convertPoint(Component source,
    int x,
    int y,
    Component destination) 
    Convert the point (x,y) in source coordinate system to destination coordinate system. If source is {@code null}, (x,y) is assumed to be in destination's root component coordinate system. If destination is {@code null}, (x,y) will be converted to source's root component coordinate system. If both source and destination are {@code null}, return (x,y) without any conversion.
 public static  void convertPointFromScreen(Point p,
    Component c) 
    Convert a point from a screen coordinates to a component's coordinate system
 public static  void convertPointToScreen(Point p,
    Component c) 
    Convert a point from a component's coordinate system to screen coordinates.
 public static Rectangle convertRectangle(Component source,
    Rectangle aRectangle,
    Component destination) 
    Convert the rectangle aRectangle in source coordinate system to destination coordinate system. If source is {@code null}, aRectangle is assumed to be in destination's root component coordinate system. If destination is {@code null}, aRectangle will be converted to source's root component coordinate system. If both source and destination are {@code null}, return aRectangle without any conversion.
 static Point convertScreenLocationToParent(Container parent,
    int x,
    int y) 
    Converts the location x y to the parents coordinate system, returning the location.
 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.
 static int findDisplayedMnemonicIndex(String text,
    int mnemonic) 
    Returns index of the first occurrence of mnemonic within string text. Matching algorithm is not case-sensitive.
 public static Component findFocusOwner(Component c) 
Deprecated! As - of 1.4, replaced by KeyboardFocusManager.getFocusOwner().

    Return the child Component of the specified Component that is the focus owner, if any.
 public static Accessible getAccessibleAt(Component c,
    Point p) 
    Returns the Accessible child contained at the local coordinate Point, if one exists. Otherwise returns null.
 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.

 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.

 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.

 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.

 public static Container getAncestorNamed(String name,
    Component comp) 
    Convenience method for searching above comp in the component hierarchy and returns the first object of name it finds. Can return {@code null}, if name cannot be found.
 public static Container getAncestorOfClass(Class<?> c,
    Component comp) 
    Convenience method for searching above comp in the component hierarchy and returns the first object of class c it finds. Can return {@code null}, if a class c cannot be found.
 public static Component getDeepestComponentAt(Component parent,
    int x,
    int y) 
    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.
 public static Rectangle getLocalBounds(Component aComponent) 
    Return the rectangle (0,0,bounds.width,bounds.height) for the component aComponent
 static JComponent getPaintingOrigin(JComponent c) 
 public static Component getRoot(Component c) 
    Returns the root component for the current component tree.
 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.
 static Frame getSharedOwnerFrame() throws HeadlessException 
    Returns a toolkit-private, shared, invisible Frame to be the owner for JDialogs and JWindows created with {@code null} owners.
 static WindowListener getSharedOwnerFrameShutdownListener() throws HeadlessException 
    Returns a SharedOwnerFrame's shutdown listener to dispose the SharedOwnerFrame if it has no more displayable children.
 public static ActionMap getUIActionMap(JComponent component) 
    Returns the ActionMap provided by the UI in component component.

    This will return {@code null} if the UI has not installed an ActionMap.

 public static InputMap getUIInputMap(JComponent component,
    int condition) 
    Returns the InputMap provided by the UI for condition condition in component component.

    This will return {@code null} if the UI has not installed a InputMap of the specified type.

 public static Container getUnwrappedParent(Component component) 
    Returns the first ancestor of the {@code component} which is not an instance of JLayer .
 public static Component getUnwrappedView(JViewport viewport) 
    Returns the first {@code JViewport}'s descendant which is not an instance of {@code JLayer}. If such a descendant can not be found, {@code null} is returned. If the {@code viewport}'s view component is not a {@code JLayer}, this method is equivalent to JViewport#getView() otherwise JLayer#getView() will be recursively called on all descending {@code JLayer}s.
 static Container getValidateRoot(Container c,
    boolean visibleOnly) 
    Retrieves the validate root of a given container. If the container is contained within a {@code CellRendererPane}, this method returns {@code null} due to the synthetic nature of the {@code CellRendererPane}.

    The component hierarchy must be displayable up to the toplevel component (either a {@code Frame} or an {@code Applet} object.) Otherwise this method returns {@code null}.

    If the {@code visibleOnly} argument is {@code true}, the found validate root and all its parents up to the toplevel component must also be visible. Otherwise this method returns {@code null}.

 public static Window getWindowAncestor(Component c) 
    Returns the first Window ancestor of c, or {@code null} if c is not contained inside a Window.
 static  void installSwingDropTargetAsNecessary(Component c,
    TransferHandler t) 
    Installs a {@code DropTarget} on the component as necessary for a {@code TransferHandler} change.
 public static  void invokeAndWait(Runnable doRun) throws InterruptedException, InvocationTargetException 
    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().

 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 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.

 public static boolean isDescendingFrom(Component a,
    Component b) 
    Return true if a component a descends from a component b
 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().

 public static boolean isLeftMouseButton(MouseEvent anEvent) 
    Returns true if the mouse event specifies the left mouse button.
 static boolean isLeftToRight(Component c) 
 public static boolean isMiddleMouseButton(MouseEvent anEvent) 
    Returns true if the mouse event specifies the middle mouse button.
 public static final boolean isRectangleContainingRectangle(Rectangle a,
    Rectangle b) 
    Return true if a contains b
 public static boolean isRightMouseButton(MouseEvent anEvent) 
    Returns true if the mouse event specifies the right mouse button.
 static boolean isValidKeyEventForKeyBindings(KeyEvent e) 
    Returns true if the e is a valid KeyEvent to use in processing the key bindings associated with JComponents.
 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.
 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.
 static Class<?> loadSystemClass(String className) throws ClassNotFoundException 
 public static boolean notifyAction(Action action,
    KeyStroke ks,
    KeyEvent event,
    Object sender,
    int modifiers) 
    Invokes actionPerformed on action if action is enabled (and non-{@code null}). The command for the ActionEvent is determined by:
    1. If the action was registered via registerKeyboardAction, then the command string passed in ({@code null} will be used if {@code null} was passed in).
    2. Action value with name Action.ACTION_COMMAND_KEY, unless {@code null}.
    3. String value of the KeyEvent, unless getKeyChar returns KeyEvent.CHAR_UNDEFINED..
    This will return true if action is non-{@code null} and actionPerformed is invoked on it.
 public static  void paintComponent(Graphics g,
    Component c,
    Container p,
    Rectangle r) 
 public static  void paintComponent(Graphics g,
    Component c,
    Container p,
    int x,
    int y,
    int w,
    int h) 
    Paints a component to the specified Graphics. This method is primarily useful to render Components 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 CellRendererPanes 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...

 public static boolean processKeyBindings(KeyEvent event) 
    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.
 public static  void replaceUIActionMap(JComponent component,
    ActionMap uiActionMap) 
    Convenience method to change the UI ActionMap for component to uiActionMap. If uiActionMap is {@code null}, this removes any previously installed UI ActionMap.
 public static  void replaceUIInputMap(JComponent component,
    int type,
    InputMap uiInputMap) 
    Convenience method to change the UI InputMap for component to uiInputMap. If uiInputMap is {@code null}, this removes any previously installed UI InputMap.
 public static  void updateComponentTreeUI(Component c) 
    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.
 static  void updateRendererOrEditorUI(Object rendererOrEditor) 
 public static Window windowForComponent(Component c) 
    Returns the first Window ancestor of c, or {@code null} if c is not contained inside a Window.

    Note: This method provides the same functionality as getWindowAncestor.