com.lf.commons.gui.panel

Class CollapsiblePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.gui.panel.CollapsiblePanel

All Implemented Interfaces:

LookAndFeelListener, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class CollapsiblePanel
extends javax.swing.JPanel
implements LookAndFeelListener, java.awt.event.ActionListener

The container for components that need to be displayed in a small area on the screen.

Basically this container consists of a collapsible header which integrates smoothly into Commons applications and a main display area for the implementation. Here, developers can place their panels with generic of specific combo boxes, radio buttons etc.

Since:

1.6

Version:

$Revision: 1.18 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closable May the collapsible panel be closed by the user (default: false)?
protected java.awt.Component	comp Component to be displayed by the main area, set by sub-classes.
protected boolean	expanded Is the panel currently expanded?
protected java.util.Vector<CollapsibleListener>	listeners Listeners to be informed when panels are expanded/collapsed.
protected java.lang.String	unitID Unique identifier used for the configuration values.

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

Constructors

Constructor and Description
CollapsiblePanel() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever the one of the components was activated.
void	addCollapsibleListener(CollapsibleListener listener) Adds an instance reacting on expanded/collapsed panels.
void	collapse() Let's the collapsible panel collapse its main display area.
void	expand() Let's the collapsible panel expand its main display area.
protected void	finalize() Clean-up method to help the gc.
boolean	getClosable() Shall this collapsible panel be closable by the user (show button)?
GradientPanel	getHeader() Provides the header component for internal use.
javax.swing.JLabel	getHeaderLabel() Provides the header title component for internal use.
java.lang.String	getHeaderTitle() Provides the header title.
java.awt.Component	getMainComponent() Provides the component to be displayed by the main area.
boolean	isExpanded() Is the panel currently expanded (shown)?
void	lookAndFeelChanged(java.lang.String plaf, java.lang.String theme) Automatically called if the look & feel changes.
void	removeCollapsibleListener(CollapsibleListener listener) Removes an instance reacting on expanded/collapsed panels.
void	resetCollapsibleListeners() Removes all instances reacting on expanded/collapsed panels.
void	setClosable(boolean enable) Shall this collapsible panel be closable by the user (show button)?
void	setHeaderTitle(java.lang.String text) Sets the header title (do not pass HTML since the text is converted).
void	setMainComponent(java.awt.Component comp) Sets the component to be displayed by the main area.
protected void	setUnitID(java.lang.String id) Sets the unique identifier for this unit used for the configuration values.
void	updateComponentTreeUI() The (hidden) components should be refreshed by SwingUtilities.updateComponentTreeUI().

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

Methods inherited from class java.lang.Object

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

Field Detail

comp

protected java.awt.Component comp

Component to be displayed by the main area, set by sub-classes.

expanded

protected boolean expanded

Is the panel currently expanded?

unitID

protected java.lang.String unitID

Unique identifier used for the configuration values.

listeners

protected java.util.Vector<CollapsibleListener> listeners

Listeners to be informed when panels are expanded/collapsed.

closable

protected boolean closable

May the collapsible panel be closed by the user (default: false)?

Constructor Detail

CollapsiblePanel

public CollapsiblePanel()

Constructor of this form.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

setMainComponent

public void setMainComponent(java.awt.Component comp)

Sets the component to be displayed by the main area.

Parameters:

comp - The component

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

getMainComponent

public java.awt.Component getMainComponent()

Provides the component to be displayed by the main area.

Returns:

The component

Since:

1.6

setHeaderTitle

public void setHeaderTitle(java.lang.String text)

Sets the header title (do not pass HTML since the text is converted).

Parameters:

text - The header text

Since:

1.6

getHeaderTitle

public java.lang.String getHeaderTitle()

Provides the header title.

Returns:

The header text

Since:

1.6

getHeader

public GradientPanel getHeader()

Provides the header component for internal use.

Returns:

The header

Since:

1.6

getHeaderLabel

public javax.swing.JLabel getHeaderLabel()

Provides the header title component for internal use.

Returns:

The header title

Since:

1.6

setUnitID

protected void setUnitID(java.lang.String id)

Sets the unique identifier for this unit used for the configuration values.

Parameters:

id - The unique identifier

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

expand

public void expand()

Let's the collapsible panel expand its main display area.

Since:

1.6

collapse

public void collapse()

Let's the collapsible panel collapse its main display area.

Since:

1.6

isExpanded

public boolean isExpanded()

Is the panel currently expanded (shown)?

Returns:

Currently expanded?

Since:

1.6

lookAndFeelChanged

public void lookAndFeelChanged(java.lang.String plaf,
                      java.lang.String theme)

Automatically called if the look & feel changes.

Call the UI manager to determine the current look & feel.

Specified by:

lookAndFeelChanged in interface LookAndFeelListener

Parameters:

plaf - The current look & feel in fully qualified notation

theme - The configuration of the specific look & feel, may be null

Since:

1.6

updateComponentTreeUI

public void updateComponentTreeUI()

The (hidden) components should be refreshed by SwingUtilities.updateComponentTreeUI().

May be called by the manager if font sizes, colors etc. have been changed.

Specified by:

updateComponentTreeUI in interface LookAndFeelListener

Since:

1.6

addCollapsibleListener

public void addCollapsibleListener(CollapsibleListener listener)

Adds an instance reacting on expanded/collapsed panels.

Parameters:

listener - Listener to be added

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

removeCollapsibleListener

public void removeCollapsibleListener(CollapsibleListener listener)

Removes an instance reacting on expanded/collapsed panels.

Parameters:

listener - Listener to be removed

Throws:

java.lang.NullPointerException - If listener is null

Since:

1.6

resetCollapsibleListeners

public void resetCollapsibleListeners()

Removes all instances reacting on expanded/collapsed panels.

Since:

1.6

setClosable

public void setClosable(boolean enable)

Shall this collapsible panel be closable by the user (show button)?

Parameters:

enable - Is it closable?

Since:

1.6

getClosable

public boolean getClosable()

Shall this collapsible panel be closable by the user (show button)?

Returns:

Is it closable?

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever the one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6