com.levigo.util.swing.effect
Class EffectContainer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLayeredPane
                  com.levigo.util.swing.effect.EffectContainer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class EffectContainer
extends JLayeredPane
implements Scrollable

A container for effect boxes like the FadeBox or the RolloutBox. It automatically configures itself with a EffectLayout and sets its baseComponent. The EffectLayout is configured to use the visible bounds as the reference bounds for the layout of the effect boxes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JLayeredPane

JLayeredPane.AccessibleJLayeredPane

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

EffectContainer()
Create an empty effect container.

EffectContainer(JComponent baseComponent)
Create an effect container for the given base component.

Method Summary

protected void	addImpl(Component comp, Object constraints, int index)
void	addMouseListener(MouseListener l)
void	addMouseMotionListener(MouseMotionListener l)
void	addMouseWheelListener(MouseWheelListener l)
void	addNotify()
static EffectContainer	get(JComponent comp) Returns the first ancestor of comp that is a EffectContainer or null if comp is NotActiveException contained in a EffectContainer.
Dimension	getPreferredScrollableViewportSize()
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
boolean	getScrollableTracksViewportHeight()
boolean	getScrollableTracksViewportWidth()
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
void	paint(Graphics g)
void	remove(Component comp)
void	removeMouseListener(MouseListener l)
void	removeMouseMotionListener(MouseMotionListener l)
void	removeMouseWheelListener(MouseWheelListener l)
void	removeNotify()
void	setLayout(LayoutManager mgr)

Methods inherited from class javax.swing.JLayeredPane

getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paramString, putLayer, remove, removeAll, setLayer, setLayer, setPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

EffectContainer

@CallOnEDT
public EffectContainer()

Create an empty effect container.

EffectContainer

@CallOnEDT
public EffectContainer(JComponent baseComponent)

Create an effect container for the given base component.

Method Detail

get

@CallOnEDT
public static EffectContainer get(JComponent comp)

Returns the first ancestor of comp that is a EffectContainer or null if comp is NotActiveException contained in a EffectContainer.

Parameters:

comp - the component for which the lookup should be done

Returns:

the EffectContainer parent or null if not available

setLayout

@CallOnEDT
public void setLayout(LayoutManager mgr)

Overrides:

setLayout in class Container

addNotify

@CallOnEDT
public void addNotify()

Overrides:

addNotify in class JComponent

removeNotify

@CallOnEDT
public void removeNotify()

Overrides:

removeNotify in class JComponent

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

Overrides:

addImpl in class JLayeredPane

remove

@CallOnEDT
public void remove(Component comp)

Overrides:

remove in class Container

addMouseListener

@CallableOffEDT
public void addMouseListener(MouseListener l)

Overrides:

addMouseListener in class Component

removeMouseListener

@CallableOffEDT
public void removeMouseListener(MouseListener l)

Overrides:

removeMouseListener in class Component

addMouseMotionListener

@CallableOffEDT
public void addMouseMotionListener(MouseMotionListener l)

Overrides:

addMouseMotionListener in class Component

removeMouseMotionListener

@CallableOffEDT
public void removeMouseMotionListener(MouseMotionListener l)

Overrides:

removeMouseMotionListener in class Component

addMouseWheelListener

@CallableOffEDT
public void addMouseWheelListener(MouseWheelListener l)

Overrides:

addMouseWheelListener in class Component

removeMouseWheelListener

@CallableOffEDT
public void removeMouseWheelListener(MouseWheelListener l)

Overrides:

removeMouseWheelListener in class Component

getPreferredScrollableViewportSize

@CallOnEDT
public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

getScrollableBlockIncrement

@CallOnEDT
public int getScrollableBlockIncrement(Rectangle visibleRect,
                                                 int orientation,
                                                 int direction)

Specified by:

getScrollableBlockIncrement in interface Scrollable

getScrollableTracksViewportHeight

@CallOnEDT
public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

getScrollableTracksViewportWidth

@CallOnEDT
public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

getScrollableUnitIncrement

@CallOnEDT
public int getScrollableUnitIncrement(Rectangle visibleRect,
                                                int orientation,
                                                int direction)

Specified by:

getScrollableUnitIncrement in interface Scrollable

paint

@CallOnEDT
public void paint(Graphics g)

Overrides:

paint in class JLayeredPane