org.tbee.swing.glasspane
Class FoggedGlasspane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.tbee.swing.glasspane.FoggedGlasspane

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class FoggedGlasspane
extends JPanel

Add the option to fog out any component and optionally place another component on top. Usage: wrap the original component within a FoggedGlasspane and add that instead of the original component lSomeContainer.add(lSomeComponent); becomes: FoggedGlasspane lFoggedGlasspane = new FoggedGlasspane(lSomeComponent); lSomeContainer.add(lFoggedGlasspane); And then: lFoggedGlasspane.setFogged(true); There are a number of special constructors which make FoggedGlasspane behave like a JDialog. Then setVisible also behaves like setFogged Note: in wrapped mode use "setFogged", in dialog mode use "setVisible"

Author:

User

See Also:

Serialized Form

Nested Class Summary

class

FoggedGlasspane.EnhancedLockableUI Subclass of the LockableUI which shows a button that allows to unlock the JXLayer when it is locked

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

JPanel.AccessibleJPanel

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

static String

SOURCECODE_VERSION Standard variable for determining version of a class file.

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

FoggedGlasspane(JComponent jcomponent)
Wrap a component in a fogged glasspane, so setVisible will make it fogged.

FoggedGlasspane(JComponent jcomponent, JComponent onTopComponent)
Wrap a component in a fogged glasspane, so setVisible will make it fogged.

FoggedGlasspane(JDialog window)

FoggedGlasspane(JFrame window)
Emulate an JDialog in model mode

Method Summary

protected void	addImpl(Component comp, Object constraints, int index) when emulating JDialog, add adds to the on-top panel
void	block()
boolean	getFogged() Fogged
JComponent	getOnTopComponent() OnTopComponent
JComponent	getWrappedComponent() WrappedComponent
void	setFogged(boolean value)
void	setFoggedBalanced(boolean value) This setFogged must be balanced in order to allow fogged-in-fogged.
void	setVisible(boolean value) when emulating JDialog, setVisible also triggers setFogged
void	setWrappedComponent(JComponent value)
static FoggedGlasspane	takeover(Container container) insert a fogged glasspanel as the only full sized child of a panel use the returned FoggedGlasspane as the content pane to add the children that normally would have gone onto the jpanel directly Instead of: this.add(...); Usage: FoggedGlasspane lFoggedGlasspane = FoggedGlasspane.takeover(this); JComponent lContentPane = iFoggedGlasspane.getWrappedComponent(); lContentPane.add(...);
void	unblock()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, unregisterKeyboardAction, update

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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, 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, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Field Detail

SOURCECODE_VERSION

public static final String SOURCECODE_VERSION

Standard variable for determining version of a class file.

See Also:

Constant Field Values

Constructor Detail

FoggedGlasspane

public FoggedGlasspane(JComponent jcomponent)

Wrap a component in a fogged glasspane, so setVisible will make it fogged.

FoggedGlasspane

public FoggedGlasspane(JComponent jcomponent,
                       JComponent onTopComponent)

Wrap a component in a fogged glasspane, so setVisible will make it fogged. But when fogged, display the on-top component.

Parameters:

jcomponent -

onTopComponent -

FoggedGlasspane

public FoggedGlasspane(JFrame window)

Emulate an JDialog in model mode

Parameters:

window -

component -

FoggedGlasspane

public FoggedGlasspane(JDialog window)

Parameters:

window -

component -

onTopComponent -

Method Detail

getWrappedComponent

public JComponent getWrappedComponent()

WrappedComponent

setWrappedComponent

public void setWrappedComponent(JComponent value)

getOnTopComponent

public JComponent getOnTopComponent()

OnTopComponent

getFogged

public boolean getFogged()

Fogged

setFogged

public void setFogged(boolean value)

setFoggedBalanced

public void setFoggedBalanced(boolean value)

This setFogged must be balanced in order to allow fogged-in-fogged.

Parameters:

value -

setVisible

public void setVisible(boolean value)

when emulating JDialog, setVisible also triggers setFogged

Overrides:

setVisible in class JComponent

addImpl

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

when emulating JDialog, add adds to the on-top panel

Overrides:

addImpl in class Container

block

public void block()

unblock

public void unblock()

takeover

public static FoggedGlasspane takeover(Container container)

insert a fogged glasspanel as the only full sized child of a panel use the returned FoggedGlasspane as the content pane to add the children that normally would have gone onto the jpanel directly Instead of: this.add(...); Usage: FoggedGlasspane lFoggedGlasspane = FoggedGlasspane.takeover(this); JComponent lContentPane = iFoggedGlasspane.getWrappedComponent(); lContentPane.add(...);