public class DefaultOverlayable extends javax.swing.JPanel implements Overlayable, java.awt.event.ComponentListener
DefaultOverlayable
is the default implementation of Overlayable
using JPanel as the base
component.javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
CLIENT_PROPERTY_OVERLAYABLE
Constructor and Description |
---|
DefaultOverlayable() |
DefaultOverlayable(javax.swing.JComponent component) |
DefaultOverlayable(javax.swing.JComponent actualComponent,
javax.swing.JComponent overlayComponent) |
DefaultOverlayable(javax.swing.JComponent actualComponent,
javax.swing.JComponent overlayComponent,
int overlayLocation) |
Modifier and Type | Method and Description |
---|---|
void |
addOverlayComponent(javax.swing.JComponent component)
Adds an overlay component to the center.
|
void |
addOverlayComponent(javax.swing.JComponent component,
int location)
Adds an overlay component at the specified location.
|
void |
addOverlayComponent(javax.swing.JComponent component,
int location,
int index)
Adds an overlay component at the specified location.
|
void |
componentHidden(java.awt.event.ComponentEvent e) |
void |
componentMoved(java.awt.event.ComponentEvent e) |
void |
componentResized(java.awt.event.ComponentEvent e) |
void |
componentShown(java.awt.event.ComponentEvent e) |
javax.swing.JComponent |
getActualComponent() |
java.awt.Dimension |
getMinimumSize() |
javax.swing.JComponent[] |
getOverlayComponents()
Gets the overlay component.
|
int |
getOverlayLocation(javax.swing.JComponent component)
Gets the overlay component location.
|
java.awt.Insets |
getOverlayLocationInsets()
Gets the insets of the overlay component relative to the border of the component.
|
java.awt.Dimension |
getPreferredSize()
Override to consider the overlayLocationInsets.
|
void |
removeOverlayComponent(javax.swing.JComponent component)
Removes an overlay component that was added before.
|
void |
setActualComponent(javax.swing.JComponent actualComponent) |
void |
setBounds(int x,
int y,
int width,
int height) |
void |
setMinimumSize(java.awt.Dimension minimumSize) |
void |
setOverlayLocation(javax.swing.JComponent component,
int location)
Sets the overlay component location.
|
void |
setOverlayLocationInsets(java.awt.Insets overlayLocationInsets)
Sets the insets of the overlay component relative to the border of the component.
|
void |
setOverlayVisible(boolean visible)
Sets all the overlay components visible or invisible.
|
void |
setPreferredSize(java.awt.Dimension preferredSize) |
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, getNextFocusableComponent, getPopupLocation, 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, 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, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public DefaultOverlayable()
public DefaultOverlayable(javax.swing.JComponent component)
public DefaultOverlayable(javax.swing.JComponent actualComponent, javax.swing.JComponent overlayComponent, int overlayLocation)
public DefaultOverlayable(javax.swing.JComponent actualComponent, javax.swing.JComponent overlayComponent)
public java.awt.Dimension getPreferredSize()
getPreferredSize
in class javax.swing.JComponent
public void setPreferredSize(java.awt.Dimension preferredSize)
setPreferredSize
in class javax.swing.JComponent
public java.awt.Dimension getMinimumSize()
getMinimumSize
in class javax.swing.JComponent
public void setMinimumSize(java.awt.Dimension minimumSize)
setMinimumSize
in class javax.swing.JComponent
public void setBounds(int x, int y, int width, int height)
setBounds
in class java.awt.Component
public int getOverlayLocation(javax.swing.JComponent component)
Overlayable
getOverlayLocation
in interface Overlayable
public void setOverlayLocation(javax.swing.JComponent component, int location)
Overlayable
SwingConstants.CENTER
SwingConstants.SOUTH
SwingConstants.NORTH
SwingConstants.WEST
SwingConstants.EAST
SwingConstants.NORTH_EAST
SwingConstants.NORTH_WEST
SwingConstants.SOUTH_EAST
SwingConstants.SOUTH_WEST
setOverlayLocation
in interface Overlayable
location
- the overlay component location.public void addOverlayComponent(javax.swing.JComponent component)
Overlayable
addOverlayComponent
in interface Overlayable
component
- the overlay component.public void addOverlayComponent(javax.swing.JComponent component, int location)
Overlayable
SwingConstants.CENTER
SwingConstants.SOUTH
SwingConstants.NORTH
SwingConstants.WEST
SwingConstants.EAST
SwingConstants.NORTH_EAST
SwingConstants.NORTH_WEST
SwingConstants.SOUTH_EAST
SwingConstants.SOUTH_WEST
addOverlayComponent
in interface Overlayable
component
- the overlay component.location
- the overlay location.public void addOverlayComponent(javax.swing.JComponent component, int location, int index)
Overlayable
SwingConstants.CENTER
SwingConstants.SOUTH
SwingConstants.NORTH
SwingConstants.WEST
SwingConstants.EAST
SwingConstants.NORTH_EAST
SwingConstants.NORTH_WEST
SwingConstants.SOUTH_EAST
SwingConstants.SOUTH_WEST
addOverlayComponent
in interface Overlayable
component
- the overlay component.location
- the overlay location.index
- the overlay index. 0 means the first overlay component. -1 means the last overlay component.public void removeOverlayComponent(javax.swing.JComponent component)
Overlayable
removeOverlayComponent
in interface Overlayable
public javax.swing.JComponent[] getOverlayComponents()
Overlayable
getOverlayComponents
in interface Overlayable
public javax.swing.JComponent getActualComponent()
public void setActualComponent(javax.swing.JComponent actualComponent)
public java.awt.Insets getOverlayLocationInsets()
Overlayable
getOverlayLocationInsets
in interface Overlayable
public void setOverlayLocationInsets(java.awt.Insets overlayLocationInsets)
Overlayable
setOverlayLocationInsets
in interface Overlayable
overlayLocationInsets
- the insets of the overlay component relative to the border of the component.public void setOverlayVisible(boolean visible)
Overlayable
setOverlayVisible
in interface Overlayable
visible
- true to set it visible. False to invisible.public void componentResized(java.awt.event.ComponentEvent e)
componentResized
in interface java.awt.event.ComponentListener
public void componentMoved(java.awt.event.ComponentEvent e)
componentMoved
in interface java.awt.event.ComponentListener
public void componentShown(java.awt.event.ComponentEvent e)
componentShown
in interface java.awt.event.ComponentListener
public void componentHidden(java.awt.event.ComponentEvent e)
componentHidden
in interface java.awt.event.ComponentListener