info.aduna.swing.sidebar
Class SideBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  info.aduna.swing.sidebar.SideBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer

public class SideBar
extends JPanel
implements RootPaneContainer

See Also:

Serialized Form

Nested Class Summary

class

SideBar.ComponentsPanel

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 Color	DEFAULT_BOTTOM_BACKGROUND_COLOR
static Color	DEFAULT_TOP_BACKGROUND_COLOR
static int	PADDING

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

SideBar()

Method Summary

Component	add(JComponent component, String name)
Component	add(JComponent component, String name, boolean expanded)
Component	add(JComponent component, String name, Icon icon, boolean expanded)
FoldingPanel	createFoldingPanelFor(JComponent component, String name) Creates a FoldingPanel that will wrap the specified Component.
FoldingPanel	createFoldingPanelFor(JComponent component, String name, Icon icon) Creates a FoldingPanel that will wrap the specified Component.
Color	getBottomBackgroundColor()
Container	getContentPane()
Component	getGlassPane()
JLayeredPane	getLayeredPane()
JScrollPane	getScrollPane()
Color	getTopBackgroundColor()
void	scrollToVisible(FoldingPanel panel)
void	setBottomBackgroundColor(Color color)
void	setContentPane(Container contentPane)
void	setGlassPane(Component glassPane)
void	setLayeredPane(JLayeredPane layeredPane)
void	setTopBackgroundColor(Color color)

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, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

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

Methods inherited from interface javax.swing.RootPaneContainer

getRootPane

Field Detail

DEFAULT_TOP_BACKGROUND_COLOR

public static final Color DEFAULT_TOP_BACKGROUND_COLOR

DEFAULT_BOTTOM_BACKGROUND_COLOR

public static final Color DEFAULT_BOTTOM_BACKGROUND_COLOR

PADDING

public static final int PADDING

See Also:

Constant Field Values

Constructor Detail

SideBar

public SideBar()

Method Detail

getGlassPane

public Component getGlassPane()

Specified by:

getGlassPane in interface RootPaneContainer

setGlassPane

public void setGlassPane(Component glassPane)

Specified by:

setGlassPane in interface RootPaneContainer

getContentPane

public Container getContentPane()

Specified by:

getContentPane in interface RootPaneContainer

setContentPane

public void setContentPane(Container contentPane)

Specified by:

setContentPane in interface RootPaneContainer

getLayeredPane

public JLayeredPane getLayeredPane()

Specified by:

getLayeredPane in interface RootPaneContainer

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

Specified by:

setLayeredPane in interface RootPaneContainer

add

public Component add(JComponent component,
                     String name)

add

public Component add(JComponent component,
                     String name,
                     boolean expanded)

add

public Component add(JComponent component,
                     String name,
                     Icon icon,
                     boolean expanded)

createFoldingPanelFor

public FoldingPanel createFoldingPanelFor(JComponent component,
                                          String name)

Creates a FoldingPanel that will wrap the specified Component. These FoldingPanels are generated when Components are added to this SideBar. Override this method if you want to decorate your FoldingPanels in a special way (e.g. using a different border).

createFoldingPanelFor

public FoldingPanel createFoldingPanelFor(JComponent component,
                                          String name,
                                          Icon icon)

Creates a FoldingPanel that will wrap the specified Component. These FoldingPanels are generated when Components are added to this SideBar. Override this method if you want to decorate your FoldingPanels in a special way (e.g. using a different border).

setTopBackgroundColor

public void setTopBackgroundColor(Color color)

getTopBackgroundColor

public Color getTopBackgroundColor()

setBottomBackgroundColor

public void setBottomBackgroundColor(Color color)

getBottomBackgroundColor

public Color getBottomBackgroundColor()

scrollToVisible

public void scrollToVisible(FoldingPanel panel)

getScrollPane

public JScrollPane getScrollPane()