org.springframework.richclient.util
Class OverlayHelper

Show UML class diagram

java.lang.Object
  org.springframework.richclient.util.OverlayHelper

All Implemented Interfaces:

SwingConstants

public class OverlayHelper
extends Object
implements SwingConstants

A helper class that attaches one component (the overlay) on top of another component.

Author:

oliverh

Nested Class Summary

static class

OverlayHelper.SingleComponentLayoutManager

Field Summary

protected JComponent	overlay
protected JComponent	overlayClipper
protected JComponent	overlayTarget

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

protected

OverlayHelper(JComponent overlay, JComponent overlayTarget, int center, int xOffset, int yOffset)

Method Summary

static void	attachOverlay(JComponent overlay, JComponent overlayTarget, int center, int xOffset, int yOffset) Attaches an overlay to the specified component.
protected JLayeredPane	getLayeredPane(Container overlayCapableParent)
protected Container	getOverlayCapableParent(JComponent component)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

overlay

protected final JComponent overlay

overlayClipper

protected final JComponent overlayClipper

overlayTarget

protected final JComponent overlayTarget

Constructor Detail

OverlayHelper

protected OverlayHelper(JComponent overlay,
                        JComponent overlayTarget,
                        int center,
                        int xOffset,
                        int yOffset)

Method Detail

attachOverlay

public static void attachOverlay(JComponent overlay,
                                 JComponent overlayTarget,
                                 int center,
                                 int xOffset,
                                 int yOffset)

Attaches an overlay to the specified component.

Parameters:

overlay - the overlay component

overlayTarget - the component over which overlay will be attached

center - position relative to overlayTarget that overlay should be centered. May be one of the SwingConstants compass positions or SwingConstants.CENTER.

xOffset - x offset from center

yOffset - y offset from center

See Also:

SwingConstants

getOverlayCapableParent

protected Container getOverlayCapableParent(JComponent component)

getLayeredPane

protected JLayeredPane getLayeredPane(Container overlayCapableParent)