com.redhat.thermostat.client.swing.components

Class OverlayPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.redhat.thermostat.client.swing.components.OverlayPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class OverlayPanel
extends JPanel

A panel meant to be stacked on top of existing components to display informations in an floating overlay.

Note: By default, the panel is invisible even when the component it belongs sets all its children to be visible. For this reason, the setVisible(boolean) method is a no-op when setting the panel visible and the user should only use setOverlayVisible(boolean) to turn on and off the visibility of this panel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OverlayPanel.CloseEvent
static interface	OverlayPanel.CloseEventListener

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

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
OverlayPanel(LocalizedString title) Creates a new OverlayPanel, with an arrow facing upward.
OverlayPanel(LocalizedString title, boolean displayArrow) Creates a new OverlayPanel.
OverlayPanel(LocalizedString title, boolean displayArrow, boolean showCloseButton)

Method Summary

Modifier and Type	Method and Description
Component	add(Component comp)
void	addCloseEventListener(OverlayPanel.CloseEventListener listener) Add a listener which will decide what to do when this OverlayPanel is requested to be closed.
MouseListener	getClickOutCloseListener(Component parent) Provides a MouseListener intended for use in GlassPanes.
protected void	paintComponent(Graphics g)
void	remove(Component comp)
void	removeAll()
void	removeCloseEventListener(OverlayPanel.CloseEventListener listener)
void	setOverlayVisible(boolean visible) Sets the visibility of this panel.
void	setVisible(boolean visible) No-op when setting the panel visible.

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, addContainerListener, addImpl, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

OverlayPanel

public OverlayPanel(LocalizedString title)

Creates a new OverlayPanel, with an arrow facing upward.

OverlayPanel

public OverlayPanel(LocalizedString title,
                    boolean displayArrow)

Creates a new OverlayPanel. The panel will display an up facing arrow if displayArrow is true.

OverlayPanel

public OverlayPanel(LocalizedString title,
                    boolean displayArrow,
                    boolean showCloseButton)

Method Detail

add

public Component add(Component comp)

Overrides:

add in class Container

remove

public void remove(Component comp)

Overrides:

remove in class Container

removeAll

public void removeAll()

Overrides:

removeAll in class Container

getClickOutCloseListener

public MouseListener getClickOutCloseListener(Component parent)

Provides a MouseListener intended for use in GlassPanes. This listener generates close events if the overlay is visible, and notifies all registered OverlayPanel.CloseEventListener instances on this overlay of the close event. Then the click event is passed through to whichever component would have received the event had the GlassPane not intercepted it. This allows for clicking outside of an overlay to notify the hosting view that it should close the overlay.

addCloseEventListener

public void addCloseEventListener(OverlayPanel.CloseEventListener listener)

Add a listener which will decide what to do when this OverlayPanel is requested to be closed. If the host view summons and hides the overlay using a toggle button, for example, then the view should provide a listener which performs a click event upon the toggle button. If there are no other UI elements which reflect the state of the overlay's visibility then it is safe for the listener to simply call setOverlayVisible(boolean) directly.

removeCloseEventListener

public void removeCloseEventListener(OverlayPanel.CloseEventListener listener)

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

setVisible

public void setVisible(boolean visible)

No-op when setting the panel visible. Please, use setOverlayVisible(boolean) instead.

Overrides:

setVisible in class JComponent

See Also:

setOverlayVisible(boolean)

setOverlayVisible

public void setOverlayVisible(boolean visible)

Sets the visibility of this panel. Users of the OverlayPanel generally should not call this method directly. Instead, use getClickOutCloseListener(Component) and addCloseEventListener(CloseEventListener).