at.tuwien.ifs.commons.gui.controls

Class TitledCollapsiblePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

at.tuwien.ifs.commons.gui.controls.TitledCollapsiblePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

AbstractViewerControl, DocumentListPanel, OptionPanel, SearchPanel

public class TitledCollapsiblePanel
extends javax.swing.JPanel

This component combines a JXCollapsiblePane with a clickable title bar to toggle between collapsed and expanded state.

The methods add(Component), add(Component, Object), remove(Component), remove(int), removeAll() delegate to JXCollapsiblePane.

Use setTitle(String), setIcon(Icon), setIconTitleGap(int), setContentBackground(Color), setContentBorder(Border), setTitleBackground(Color) and setTitleBorder(Border) so set the appearence.

Use setCollapsed(boolean) to collapse/expand the contentPane.

Version:

$Id: TitledCollapsiblePanel.java 4219 2011-05-27 08:52:57Z frank $

Author:

Jakob Frank

See Also:

JXCollapsiblePane, JXTitledPanel, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TitledCollapsiblePanel.Orientation
private class	TitledCollapsiblePanel.TitleRow

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
private org.jdesktop.swingx.JXCollapsiblePane	contentCollapser
private java.awt.Container	contentContainer
private TitledCollapsiblePanel.Orientation	orientation
private static long	serialVersionUID
private TitledCollapsiblePanel.TitleRow	title

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
TitledCollapsiblePanel()
TitledCollapsiblePanel(java.awt.LayoutManager layout)
TitledCollapsiblePanel(java.lang.String title)
TitledCollapsiblePanel(java.lang.String title, boolean collapsed)
TitledCollapsiblePanel(java.lang.String title, CommonSOMViewerStateData state, java.awt.LayoutManager layout)
TitledCollapsiblePanel(java.lang.String title, java.awt.LayoutManager layout)
TitledCollapsiblePanel(java.lang.String title, java.awt.LayoutManager layout, boolean collapsed)

Method Summary

Modifier and Type	Method and Description
java.awt.Component	add(java.awt.Component comp)
java.awt.Component	add(java.awt.Component comp, int index)
void	add(java.awt.Component comp, java.lang.Object constraints)
void	add(java.awt.Component comp, java.lang.Object constraints, int index)
java.awt.Component	add(java.lang.String name, java.awt.Component comp)
java.awt.Color	getContentBackground()
javax.swing.border.Border	getContentBorder()
java.awt.Container	getContentPane()
int	getDecoratorPadding()
int	getHorizontalTitleAlignment()
int	getHorizontalTitleTextPosition()
javax.swing.Icon	getIcon()
int	getIconTitleGap()
java.awt.LayoutManager	getLayout()
TitledCollapsiblePanel.Orientation	getOrientation()
java.awt.Dimension	getPreferredSize() Do not override this method.
boolean	getShowTitleDecoration() see getShowTitleDecoration()
java.lang.String	getTitle()
java.awt.Color	getTitleBackground()
javax.swing.border.Border	getTitleBorder()
private void	init()
private void	initContent()
private void	initTitle()
boolean	isAnimated()
boolean	isCollapsed()
void	remove(java.awt.Component comp)
void	remove(int index)
void	removeAll()
void	setAnimated(boolean animated)
void	setCollapsed(boolean val)
void	setContentBackground(java.awt.Color bg)
void	setContentBorder(javax.swing.border.Border border)
void	setContentPane(java.awt.Container contentPane)
void	setDecoratorPadding(int decoratorPadding)
void	setHorizontalTitleAlignment(int alignment)
void	setHorizontalTitleTextPosition(int textPosition)
void	setIcon(javax.swing.Icon defaultIcon)
void	setIconTitleGap(int iconTextGap)
void	setLayout(java.awt.LayoutManager mgr)
void	setOrientation(TitledCollapsiblePanel.Orientation orientation)
void	setShowTitleDecoration(boolean show) The title decoration is the expand/collapse icon in the top right corner of the title.
void	setTitle(java.lang.String title)
void	setTitleBackground(java.awt.Color bg)
void	setTitleBorder(javax.swing.border.Border border)

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, 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, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

orientation

private TitledCollapsiblePanel.Orientation orientation

title

private final TitledCollapsiblePanel.TitleRow title

contentCollapser

private final org.jdesktop.swingx.JXCollapsiblePane contentCollapser

contentContainer

private java.awt.Container contentContainer

Constructor Detail

TitledCollapsiblePanel

public TitledCollapsiblePanel()

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.lang.String title)

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.awt.LayoutManager layout)

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.lang.String title,
                              CommonSOMViewerStateData state,
                              java.awt.LayoutManager layout)

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.lang.String title,
                              java.awt.LayoutManager layout)

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.lang.String title,
                              boolean collapsed)

TitledCollapsiblePanel

public TitledCollapsiblePanel(java.lang.String title,
                              java.awt.LayoutManager layout,
                              boolean collapsed)

Method Detail

getDecoratorPadding

public int getDecoratorPadding()

setDecoratorPadding

public void setDecoratorPadding(int decoratorPadding)

add

public java.awt.Component add(java.awt.Component comp)

Overrides:

add in class java.awt.Container

add

public void add(java.awt.Component comp,
                java.lang.Object constraints)

Overrides:

add in class java.awt.Container

add

public java.awt.Component add(java.awt.Component comp,
                              int index)

Overrides:

add in class java.awt.Container

add

public void add(java.awt.Component comp,
                java.lang.Object constraints,
                int index)

Overrides:

add in class java.awt.Container

add

public java.awt.Component add(java.lang.String name,
                              java.awt.Component comp)

Overrides:

add in class java.awt.Container

getHorizontalTitleAlignment

public int getHorizontalTitleAlignment()

getHorizontalTitleTextPosition

public int getHorizontalTitleTextPosition()

getIcon

public javax.swing.Icon getIcon()

getIconTitleGap

public int getIconTitleGap()

getLayout

public java.awt.LayoutManager getLayout()

Overrides:

getLayout in class java.awt.Container

getTitle

public java.lang.String getTitle()

init

private void init()

initContent

private void initContent()

initTitle

private void initTitle()

setContentBackground

public void setContentBackground(java.awt.Color bg)

setHorizontalTitleAlignment

public void setHorizontalTitleAlignment(int alignment)

setHorizontalTitleTextPosition

public void setHorizontalTitleTextPosition(int textPosition)

setIcon

public void setIcon(javax.swing.Icon defaultIcon)

setIconTitleGap

public void setIconTitleGap(int iconTextGap)

setLayout

public void setLayout(java.awt.LayoutManager mgr)

Overrides:

setLayout in class java.awt.Container

setTitle

public void setTitle(java.lang.String title)

setTitleBackground

public void setTitleBackground(java.awt.Color bg)

setTitleBorder

public void setTitleBorder(javax.swing.border.Border border)

getTitleBorder

public javax.swing.border.Border getTitleBorder()

getTitleBackground

public java.awt.Color getTitleBackground()

setShowTitleDecoration

public void setShowTitleDecoration(boolean show)

The title decoration is the expand/collapse icon in the top right corner of the title.

getShowTitleDecoration

public boolean getShowTitleDecoration()

see getShowTitleDecoration()

getContentBackground

public java.awt.Color getContentBackground()

getContentBorder

public javax.swing.border.Border getContentBorder()

getContentPane

public java.awt.Container getContentPane()

setContentPane

public void setContentPane(java.awt.Container contentPane)

remove

public void remove(java.awt.Component comp)

Overrides:

remove in class java.awt.Container

remove

public void remove(int index)

Overrides:

remove in class java.awt.Container

removeAll

public void removeAll()

Overrides:

removeAll in class java.awt.Container

setContentBorder

public void setContentBorder(javax.swing.border.Border border)

isAnimated

public boolean isAnimated()

Returns:

true if the pane is animated, false otherwise

See Also:

JXCollapsiblePane.isAnimated()

isCollapsed

public boolean isCollapsed()

Returns:

true if the pane is collapsed, false if expanded

See Also:

JXCollapsiblePane.isCollapsed()

setAnimated

public void setAnimated(boolean animated)

See Also:

JXCollapsiblePane.setAnimated(boolean)

setCollapsed

public void setCollapsed(boolean val)

See Also:

JXCollapsiblePane.setCollapsed(boolean)

setOrientation

public void setOrientation(TitledCollapsiblePanel.Orientation orientation)

getOrientation

public TitledCollapsiblePanel.Orientation getOrientation()

getPreferredSize

public final java.awt.Dimension getPreferredSize()

Do not override this method. Use JComponent.setPreferredSize(Dimension) if necessary!

Overrides:

getPreferredSize in class javax.swing.JComponent

See Also:

JComponent.getPreferredSize()