Package org.jjazz.uiutilities.api

Class CollapsiblePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jjazz.uiutilities.api.CollapsiblePanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class CollapsiblePanel
extends JPanel

The user-triggered collapsable contentPanel containing the component (trigger) in the titled border

See Also:

• Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_COLLAPSED	newValue = isCollapsed

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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	Description
CollapsiblePanel()
CollapsiblePanel(String text)	Constructor for a label/button controlled collapsable panel.
CollapsiblePanel(String text, int titleJustification, int titlePosition)	Constructor for a label/button controlled collapsable panel.
CollapsiblePanel(JRadioButton component)	Constructor for an option button controlled collapsable panel.

Method Summary

Modifier and Type	Method	Description
JPanel	getContentPane()	This class requires that all content be placed within a designated contentPanel, this method returns that contentPanel.
Dimension	getMinimumSize()	Override make sure minimum width is never smaller than titleComponent preferred size, even when collapsed.
Dimension	getPreferredSize()	Override make sure preferred width is never smaller than titleComponent preferred width, even when collapsed.
String	getTitleComponentText()
boolean	isCollapsed()	Returns the current state of the contentPanel, collapsed (true) or expanded (false).
void	setCollapsed(boolean collapse)	Collapses or expands the panel.
void	setTitleComponentText(String text)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

PROP_COLLAPSED

public static final String PROP_COLLAPSED

newValue = isCollapsed

See Also:

• Constant Field Values

Constructor Details

CollapsiblePanel

public CollapsiblePanel()

CollapsiblePanel

public CollapsiblePanel(JRadioButton component)

Constructor for an option button controlled collapsable panel.

This is useful when a group of options each have unique sub contents. The radio buttons should be created, grouped, and then used to construct their own collapsable panels. This way choosing a different option in the same option group will collapse all unselected options. Expanded panels draw a border around the contents and through the radio button in the fashion of a titled border.

Parameters:

component - Radio button that expands and collapses the contentPanel based on if it is selected or not

CollapsiblePanel

public CollapsiblePanel(String text)

Constructor for a label/button controlled collapsable panel.

Displays a clickable title that resembles a native titled border except for an arrow on the right side indicating an expandable contentPanel. The actual border only appears when the contentPanel is expanded.

Parameters:

text - Title of the collapsable contentPanel in string format, used to create a button with text and an arrow icon

CollapsiblePanel

public CollapsiblePanel(String text,
 int titleJustification,
 int titlePosition)

Constructor for a label/button controlled collapsable panel.

Parameters:

text -

titleJustification - use TitledBorder constant

titlePosition - use TitledBorder constant

Method Details

setTitleComponentText

public void setTitleComponentText(String text)

getTitleComponentText

public String getTitleComponentText()

getContentPane

public JPanel getContentPane()

This class requires that all content be placed within a designated contentPanel, this method returns that contentPanel.

Returns:

contentPanel The content contentPanel

getPreferredSize

public Dimension getPreferredSize()

Override make sure preferred width is never smaller than titleComponent preferred width, even when collapsed.

Overrides:

getPreferredSize in class JComponent

Returns:

getMinimumSize

public Dimension getMinimumSize()

Override make sure minimum width is never smaller than titleComponent preferred size, even when collapsed.

Overrides:

getMinimumSize in class JComponent

Returns:

setCollapsed

public void setCollapsed(boolean collapse)

Collapses or expands the panel.

This is done by adding or removing the content pane, alternating between a frame and empty border, and changing the title arrow. Also, the current state is stored in the collapsed boolean.

Parameters:

collapse - When set to true, the contentPanel is collapsed, else it is expanded

isCollapsed

public boolean isCollapsed()

Returns the current state of the contentPanel, collapsed (true) or expanded (false).

Returns:

collapsed Returns true if the contentPanel is collapsed and false if it is expanded