com.alee.extended.panel

Class WebCollapsiblePane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.alee.laf.panel.WebPanel

com.alee.extended.panel.WebCollapsiblePane

All Implemented Interfaces:

com.alee.managers.language.LanguageContainerMethods, com.alee.managers.language.LanguageMethods, com.alee.managers.settings.SettingsMethods, MarginSupport, PaddingSupport, ShapeProvider, Skinnable, Styleable, ToolTipMethods, Paintable, EventMethods, SizeMethods<WebPanel>, com.alee.utils.swing.SwingMethods, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

public class WebCollapsiblePane
extends WebPanel
implements javax.swing.SwingConstants, ShapeProvider, com.alee.managers.language.LanguageMethods, com.alee.managers.settings.SettingsMethods

This extended components allows you to quickly create and manipulate a collapsible pane. Pane title, content and style can be modified in any way you like.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebCollapsiblePane.HeaderPanel Custom header panel.

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 java.lang.Boolean	animate Whether animate transition between states or not.
protected com.alee.utils.swing.WebTimer	animator State change animation timer.
protected javax.swing.ImageIcon	cachedCollapseIcon Cached expanded state icon.
protected javax.swing.ImageIcon	cachedDisabledCollapseIcon Cached disabled expanded state icon.
protected javax.swing.ImageIcon	cachedDisabledExpandIcon Cached disabled collapsed state icon.
protected javax.swing.ImageIcon	cachedExpandIcon Cached collapsed state icon.
static javax.swing.ImageIcon	COLLAPSE_ICON Expanded state icon.
protected javax.swing.ImageIcon	collapseIcon Expanded state icon.
protected java.awt.Component	content Collapsible pane content.
protected WebPanel	contentPanel Content panel.
protected boolean	customTitle Whether custom title component is set or not.
static javax.swing.ImageIcon	EXPAND_ICON Collapsed state icon.
protected WebButton	expandButton State change button.
protected boolean	expanded Whether collapsible pane is expanded or not.
protected javax.swing.ImageIcon	expandIcon Collapsed state icon.
protected float	expandSpeed Collapsible pane expand and collapse speed.
protected WebCollapsiblePane.HeaderPanel	headerPanel Header panel.
protected java.util.List<CollapsiblePaneListener>	listeners Collapsible pane listeners.
protected java.lang.Boolean	rotateStateIcon Whether rotate state icon according to title pane position or not.
protected java.lang.Boolean	showStateIcon Whether display state icon in title pane or not.
protected com.alee.utils.swing.DataProvider<java.lang.Boolean>	stateChangeHandler Handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.
protected int	stateIconPosition State icon position in title pane.
protected java.awt.Component	titleComponent Title component.
protected int	titlePanePosition Title pane position in collapsible pane.
protected float	transitionProgress Current collapsible pane transition progress.

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface com.alee.managers.style.MarginSupport

EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport

EMPTY

Fields inherited from interface com.alee.utils.swing.SizeMethods

UNDEFINED

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
WebCollapsiblePane() Constructs empty collapsible pane.
WebCollapsiblePane(java.awt.Component content) Constructs collapsible pane with specified content.
WebCollapsiblePane(javax.swing.Icon icon, java.lang.String title, java.awt.Component content) Constructs collapsible pane with specified title icon, text and content.
WebCollapsiblePane(javax.swing.ImageIcon icon, java.lang.String title) Constructs empty collapsible pane with specified title icon and text.
WebCollapsiblePane(java.lang.String title) Constructs empty collapsible pane with specified title text.
WebCollapsiblePane(java.lang.String title, java.awt.Component content) Constructs collapsible pane with specified title text and content.
WebCollapsiblePane(StyleId id) Constructs empty collapsible pane.
WebCollapsiblePane(StyleId id, java.awt.Component content) Constructs collapsible pane with specified content.
WebCollapsiblePane(StyleId id, javax.swing.Icon icon, java.lang.String title, java.awt.Component content) Constructs collapsible pane with specified title icon, text and content.
WebCollapsiblePane(StyleId id, javax.swing.ImageIcon icon, java.lang.String title) Constructs empty collapsible pane with specified title icon and text.
WebCollapsiblePane(StyleId id, java.lang.String title) Constructs empty collapsible pane with specified title text.
WebCollapsiblePane(StyleId id, java.lang.String title, java.awt.Component content) Constructs collapsible pane with specified title text and content.

Method Summary

Modifier and Type	Method and Description
void	addCollapsiblePaneListener(CollapsiblePaneListener listener) Adds collapsible pane listener.
protected void	clearCachedCollapseIcons() Clears cached expanded state icons.
protected void	clearCachedExpandIcons() Clears cached collapsed state icons.
boolean	collapse() Changes expanded state to collapsed and returns whether operation succeed or not.
boolean	collapse(boolean animate) Changes expanded state to collapsed and returns whether operation succeed or not.
protected javax.swing.JComponent	createDefaultTitleComponent(javax.swing.Icon icon, java.lang.String title) Returns new default title component with specified icon and text.
boolean	expand() Changes expanded state to expanded and returns whether operation succeed or not.
boolean	expand(boolean animate) Changes expanded state to expanded and returns whether operation succeed or not.
protected void	finishCollapseAction() Finishes collapse action.
protected void	finishExpandAction() Finishes expand action.
void	fireCollapsed() Notifies when collapsible pane finished collapsing.
void	fireCollapsing() Notifies when collapsible pane starts to collapse.
void	fireExpanded() Notifies when collapsible pane finished expanding.
void	fireExpanding() Notifies when collapsible pane starts to expand.
java.awt.Dimension	getBasePreferredSize() Returns preferred size without taking collapsible pane content into account.
protected javax.swing.ImageIcon	getCachedCollapseIcon() Returns cached expanded state icon.
protected javax.swing.ImageIcon	getCachedDisabledCollapseIcon() Returns cached disabled expanded state icon.
protected javax.swing.ImageIcon	getCachedDisabledExpandIcon() Returns cached disabled collapsed state icon.
protected javax.swing.ImageIcon	getCachedExpandIcon() Returns cached collapsed state icon.
javax.swing.ImageIcon	getCollapseIcon() Returns expanded state icon.
java.util.List<CollapsiblePaneListener>	getCollapsiblePaneListeners() Returns collapsible pane listeners.
java.awt.Component	getContent() Returns collapsible pane content.
WebButton	getExpandButton() Returns state change button.
javax.swing.ImageIcon	getExpandIcon() Returns collapsed state icon.
WebPanel	getHeaderPanel() Returns header panel.
javax.swing.Icon	getIcon() Returns default title component icon.
com.alee.utils.swing.DataProvider<java.lang.Boolean>	getStateChangeHandler() Returns handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.
int	getStateIconPosition() Returns state icon position in title pane.
java.lang.String	getTitle() Returns default title component text.
java.awt.Component	getTitleComponent() Returns title component.
int	getTitlePanePosition() Returns title pane position in collapsible pane.
float	getTransitionProgress() Returns current collapsible pane transition progress.
boolean	invertExpandState() Changes expanded state to opposite and returns whether operation succeed or not.
boolean	invertExpandState(boolean animate) Changes expanded state to opposite and returns whether operation succeed or not.
boolean	isAnimate() Returns whether animate transition between states or not.
boolean	isAnimating() Returns whether collapsible pane is performing animated transition at the moment or not.
boolean	isExpanded() Returns whether this collapsible pane is expanded or not.
boolean	isLanguageSet()
boolean	isRotateStateIcon() Returns whether rotate state icon according to title pane position or not.
boolean	isShowStateIcon() Returns whether display state icon in title pane or not.
boolean	isStateChangeEnabled() Returns whether collapsible pane state change is enabled or not.
void	loadSettings()
void	registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)
void	registerSettings(java.lang.String key)
void	registerSettings(java.lang.String key, boolean loadInitialSettings, boolean applySettingsChanges)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass)
<T extends com.alee.managers.settings.DefaultValue> void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Class<T> defaultValueClass, boolean loadInitialSettings, boolean applySettingsChanges)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue)
void	registerSettings(java.lang.String group, java.lang.String key, java.lang.Object defaultValue, boolean loadInitialSettings, boolean applySettingsChanges)
void	removeCollapsiblePaneListener(CollapsiblePaneListener listener) Removes collapsible pane listener.
void	removeLanguage()
void	removeLanguageUpdater()
void	saveSettings()
void	setAnimate(boolean animate) Sets whether animate transition between states or not
void	setCollapseIcon(javax.swing.ImageIcon collapseIcon) Sets expanded state icon.
void	setCollapsiblePaneListeners(java.util.List<CollapsiblePaneListener> listeners) Sets collapsible pane listeners.
void	setContent(java.awt.Component content) Sets collapsible pane content.
boolean	setExpanded(boolean expanded) Changes expanded state to specified one and returns whether operation succeed or not.
boolean	setExpanded(boolean expanded, boolean animate) Changes expanded state to specified one and returns whether operation succeed or not.
void	setExpandIcon(javax.swing.ImageIcon expandIcon) Sets collapsed state icon.
void	setIcon(javax.swing.Icon icon) Sets default title component icon.
void	setLanguage(java.lang.String key, java.lang.Object... data)
void	setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)
void	setRotateStateIcon(boolean rotateStateIcon) Sets whether rotate state icon according to title pane position or not.
void	setShowStateIcon(boolean showStateIcon) Sets whether display state icon in title pane or not.
void	setStateChangeHandler(com.alee.utils.swing.DataProvider<java.lang.Boolean> stateChangeHandler) Sets handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.
void	setStateIconPosition(int stateIconPosition) Sets state icon position in title pane.
protected void	setStateIcons() Installs state icons into state change button.
void	setTitle(java.lang.String title) Sets default title component text.
void	setTitleAlignment(int alignment) Sets default title component text alignment.
void	setTitleComponent(java.awt.Component titleComponent) Sets custom title component.
void	setTitlePanePosition(int titlePanePosition) Sets title pane position in collapsible pane.
protected void	stopAnimation() Stops state transition animation.
protected void	takeFocus() Transfers application focus to this collapsible pane.
void	unregisterSettings()
protected void	updateDefaultTitleComponent() Updates default title component.
protected void	updateDefaultTitleComponent(javax.swing.Icon icon, java.lang.String title) Updates default title component with the specified title icon and text.
protected void	updateHeaderPosition() Updates header panel position.
void	updateLanguage(java.lang.Object... data)
void	updateLanguage(java.lang.String key, java.lang.Object... data)
protected void	updateStateIconPosition() Updates state icon position.
protected void	updateStateIcons() Updates state icons.

Methods inherited from class com.alee.laf.panel.WebPanel

add, add, add, add, add, add, addStyleListener, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, contains, equalizeComponentsHeight, equalizeComponentsSize, equalizeComponentsWidth, getCustomPainter, getCustomPainter, getCustomPainters, getFirstComponent, getLanguageContainerKey, getLastComponent, getMargin, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getPadding, getPreferredHeight, getPreferredSize, getPreferredWidth, getSkin, getStyleId, onDoubleClick, onFocusGain, onFocusLoss, onKeyPress, onKeyPress, onKeyRelease, onKeyRelease, onKeyType, onKeyType, onMenuTrigger, onMouseClick, onMouseClick, onMouseDrag, onMouseDrag, onMouseEnter, onMouseExit, onMousePress, onMousePress, provideShape, remove, remove, removeAll, removeLanguageContainerKey, removeStyleListener, removeToolTip, removeToolTips, removeToolTips, removeToolTips, restoreDefaultPainters, restoreSkin, setCustomPainter, setCustomPainter, setLanguageContainerKey, setMargin, setMargin, setMargin, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setPadding, setPadding, setPadding, setPreferredHeight, setPreferredSize, setPreferredWidth, setSkin, setSkin, setStyleId, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, updateUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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

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

Methods inherited from interface com.alee.managers.style.ShapeProvider

provideShape

Field Detail

EXPAND_ICON

public static javax.swing.ImageIcon EXPAND_ICON

Collapsed state icon.

COLLAPSE_ICON

public static javax.swing.ImageIcon COLLAPSE_ICON

Expanded state icon.

animate

protected java.lang.Boolean animate

Whether animate transition between states or not.

expandIcon

protected javax.swing.ImageIcon expandIcon

Collapsed state icon.

collapseIcon

protected javax.swing.ImageIcon collapseIcon

Expanded state icon.

rotateStateIcon

protected java.lang.Boolean rotateStateIcon

Whether rotate state icon according to title pane position or not.

showStateIcon

protected java.lang.Boolean showStateIcon

Whether display state icon in title pane or not.

stateIconPosition

protected int stateIconPosition

State icon position in title pane.

titlePanePosition

protected int titlePanePosition

Title pane position in collapsible pane.

listeners

protected java.util.List<CollapsiblePaneListener> listeners

Collapsible pane listeners.

cachedExpandIcon

protected javax.swing.ImageIcon cachedExpandIcon

Cached collapsed state icon.

cachedDisabledExpandIcon

protected javax.swing.ImageIcon cachedDisabledExpandIcon

Cached disabled collapsed state icon.

cachedCollapseIcon

protected javax.swing.ImageIcon cachedCollapseIcon

Cached expanded state icon.

cachedDisabledCollapseIcon

protected javax.swing.ImageIcon cachedDisabledCollapseIcon

Cached disabled expanded state icon.

stateChangeHandler

protected com.alee.utils.swing.DataProvider<java.lang.Boolean> stateChangeHandler

Handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.

expanded

protected boolean expanded

Whether collapsible pane is expanded or not.

transitionProgress

protected float transitionProgress

Current collapsible pane transition progress. When pane is fully expanded this variable becomes 1f. When pane is fully collapsed this variable becomes 0f.

expandSpeed

protected float expandSpeed

Collapsible pane expand and collapse speed.

animator

protected com.alee.utils.swing.WebTimer animator

State change animation timer.

customTitle

protected boolean customTitle

Whether custom title component is set or not.

headerPanel

protected WebCollapsiblePane.HeaderPanel headerPanel

Header panel.

titleComponent

protected java.awt.Component titleComponent

Title component.

expandButton

protected WebButton expandButton

State change button.

contentPanel

protected WebPanel contentPanel

Content panel.

content

protected java.awt.Component content

Collapsible pane content.

Constructor Detail

WebCollapsiblePane

public WebCollapsiblePane()

Constructs empty collapsible pane.

WebCollapsiblePane

public WebCollapsiblePane(java.lang.String title)

Constructs empty collapsible pane with specified title text.

Parameters:

title - collapsible pane title text

WebCollapsiblePane

public WebCollapsiblePane(javax.swing.ImageIcon icon,
                          java.lang.String title)

Constructs empty collapsible pane with specified title icon and text.

Parameters:

icon - collapsible pane title icon

title - collapsible pane title text

WebCollapsiblePane

public WebCollapsiblePane(java.awt.Component content)

Constructs collapsible pane with specified content.

Parameters:

content - collapsible pane content

WebCollapsiblePane

public WebCollapsiblePane(java.lang.String title,
                          java.awt.Component content)

Constructs collapsible pane with specified title text and content.

Parameters:

title - collapsible pane title text

content - collapsible pane content

WebCollapsiblePane

public WebCollapsiblePane(javax.swing.Icon icon,
                          java.lang.String title,
                          java.awt.Component content)

Constructs collapsible pane with specified title icon, text and content.

Parameters:

icon - collapsible pane title icon

title - collapsible pane title text

content - collapsible pane content

WebCollapsiblePane

public WebCollapsiblePane(StyleId id)

Constructs empty collapsible pane.

Parameters:

id - style ID

WebCollapsiblePane

public WebCollapsiblePane(StyleId id,
                          java.lang.String title)

Constructs empty collapsible pane with specified title text.

Parameters:

id - style ID

title - collapsible pane title text

WebCollapsiblePane

public WebCollapsiblePane(StyleId id,
                          javax.swing.ImageIcon icon,
                          java.lang.String title)

Constructs empty collapsible pane with specified title icon and text.

Parameters:

id - style ID

icon - collapsible pane title icon

title - collapsible pane title text

WebCollapsiblePane

public WebCollapsiblePane(StyleId id,
                          java.awt.Component content)

Constructs collapsible pane with specified content.

Parameters:

id - style ID

content - collapsible pane content

WebCollapsiblePane

public WebCollapsiblePane(StyleId id,
                          java.lang.String title,
                          java.awt.Component content)

Constructs collapsible pane with specified title text and content.

Parameters:

id - style ID

title - collapsible pane title text

content - collapsible pane content

WebCollapsiblePane

public WebCollapsiblePane(StyleId id,
                          javax.swing.Icon icon,
                          java.lang.String title,
                          java.awt.Component content)

Constructs collapsible pane with specified title icon, text and content.

Parameters:

id - style ID

icon - collapsible pane title icon

title - collapsible pane title text

content - collapsible pane content

Method Detail

takeFocus

protected void takeFocus()

Transfers application focus to this collapsible pane.

updateDefaultTitleComponent

protected void updateDefaultTitleComponent()

Updates default title component.

updateDefaultTitleComponent

protected void updateDefaultTitleComponent(javax.swing.Icon icon,
                                           java.lang.String title)

Updates default title component with the specified title icon and text.

Parameters:

icon - collapsible pane title icon

title - collapsible pane title text

updateHeaderPosition

protected void updateHeaderPosition()

Updates header panel position.

updateStateIconPosition

protected void updateStateIconPosition()

Updates state icon position.

createDefaultTitleComponent

protected javax.swing.JComponent createDefaultTitleComponent(javax.swing.Icon icon,
                                                             java.lang.String title)

Returns new default title component with specified icon and text.

Parameters:

title - collapsible pane title text

icon - collapsible pane title icon

Returns:

new default title component with specified icon and text

getStateChangeHandler

public com.alee.utils.swing.DataProvider<java.lang.Boolean> getStateChangeHandler()

Returns handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.

Returns:

state change handler

setStateChangeHandler

public void setStateChangeHandler(com.alee.utils.swing.DataProvider<java.lang.Boolean> stateChangeHandler)

Sets handler that dynamically enable and disable collapsible pane state changes by providing according boolean value.

Parameters:

stateChangeHandler - new state change handler

isStateChangeEnabled

public boolean isStateChangeEnabled()

Returns whether collapsible pane state change is enabled or not.

Returns:

true if collapsible pane state change is enabled, false otherwise

isAnimating

public boolean isAnimating()

Returns whether collapsible pane is performing animated transition at the moment or not.

Returns:

true if collapsible pane is performing animated transition at the moment, false otherwise

invertExpandState

public boolean invertExpandState()

Changes expanded state to opposite and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Returns:

true if operation succeed, false otherwise

invertExpandState

public boolean invertExpandState(boolean animate)

Changes expanded state to opposite and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Parameters:

animate - whether animate state change transition or not

Returns:

true if operation succeed, false otherwise

isExpanded

public boolean isExpanded()

Returns whether this collapsible pane is expanded or not.

Returns:

true if this collapsible pane is expanded, false otherwise

setExpanded

public boolean setExpanded(boolean expanded)

Changes expanded state to specified one and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Parameters:

expanded - whether collapsible pane should be expanded or collapsed

Returns:

true if operation succeed, false otherwise

setExpanded

public boolean setExpanded(boolean expanded,
                           boolean animate)

Changes expanded state to specified one and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Parameters:

expanded - whether collapsible pane should be expanded or collapsed

animate - whether animate state change transition or not

Returns:

true if operation succeed, false otherwise

collapse

public boolean collapse()

Changes expanded state to collapsed and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Returns:

true if operation succeed, false otherwise

collapse

public boolean collapse(boolean animate)

Changes expanded state to collapsed and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Parameters:

animate - whether animate state change transition or not

Returns:

true if operation succeed, false otherwise

finishCollapseAction

protected void finishCollapseAction()

Finishes collapse action.

expand

public boolean expand()

Changes expanded state to expanded and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Returns:

true if operation succeed, false otherwise

expand

public boolean expand(boolean animate)

Changes expanded state to expanded and returns whether operation succeed or not. Operation might fail in case state change is disabled for some reason.

Parameters:

animate - whether animate state change transition or not

Returns:

true if operation succeed, false otherwise

finishExpandAction

protected void finishExpandAction()

Finishes expand action.

stopAnimation

protected void stopAnimation()

Stops state transition animation.

getTitlePanePosition

public int getTitlePanePosition()

Returns title pane position in collapsible pane.

Returns:

title pane position in collapsible pane

setTitlePanePosition

public void setTitlePanePosition(int titlePanePosition)

Sets title pane position in collapsible pane.

Parameters:

titlePanePosition - new title pane position in collapsible pane

isAnimate

public boolean isAnimate()

Returns whether animate transition between states or not.

Returns:

true if animate transition between states, false otherwise

setAnimate

public void setAnimate(boolean animate)

Sets whether animate transition between states or not

Parameters:

animate - whether animate transition between states or not

getIcon

public javax.swing.Icon getIcon()

Returns default title component icon.

Returns:

default title component icon

setIcon

public void setIcon(javax.swing.Icon icon)

Sets default title component icon.

Parameters:

icon - new default title component icon

getTitle

public java.lang.String getTitle()

Returns default title component text.

Returns:

default title component text

setTitle

public void setTitle(java.lang.String title)

Sets default title component text.

Parameters:

title - new default title component text

setTitleAlignment

public void setTitleAlignment(int alignment)

Sets default title component text alignment.

Parameters:

alignment - new default title component text alignment

getCollapseIcon

public javax.swing.ImageIcon getCollapseIcon()

Returns expanded state icon.

Returns:

expanded state icon

setCollapseIcon

public void setCollapseIcon(javax.swing.ImageIcon collapseIcon)

Sets expanded state icon.

Parameters:

collapseIcon - new expanded state icon

getExpandIcon

public javax.swing.ImageIcon getExpandIcon()

Returns collapsed state icon.

Returns:

collapsed state icon

setExpandIcon

public void setExpandIcon(javax.swing.ImageIcon expandIcon)

Sets collapsed state icon.

Parameters:

expandIcon - new collapsed state icon

isRotateStateIcon

public boolean isRotateStateIcon()

Returns whether rotate state icon according to title pane position or not.

Returns:

true if stat icon must be rotated according to title pane position, false otherwise

setRotateStateIcon

public void setRotateStateIcon(boolean rotateStateIcon)

Sets whether rotate state icon according to title pane position or not.

Parameters:

rotateStateIcon - whether rotate state icon according to title pane position or not

isShowStateIcon

public boolean isShowStateIcon()

Returns whether display state icon in title pane or not.

Returns:

true if state icon must be displayed in title pane, false otherwise

setShowStateIcon

public void setShowStateIcon(boolean showStateIcon)

Sets whether display state icon in title pane or not.

Parameters:

showStateIcon - whether display state icon in title pane or not

getStateIconPosition

public int getStateIconPosition()

Returns state icon position in title pane.

Returns:

state icon position in title pane

setStateIconPosition

public void setStateIconPosition(int stateIconPosition)

Sets state icon position in title pane.

Parameters:

stateIconPosition - new state icon position in title pane

updateStateIcons

protected void updateStateIcons()

Updates state icons.

setStateIcons

protected void setStateIcons()

Installs state icons into state change button.

clearCachedCollapseIcons

protected void clearCachedCollapseIcons()

Clears cached expanded state icons.

getCachedCollapseIcon

protected javax.swing.ImageIcon getCachedCollapseIcon()

Returns cached expanded state icon.

Returns:

cached expanded state icon

getCachedDisabledCollapseIcon

protected javax.swing.ImageIcon getCachedDisabledCollapseIcon()

Returns cached disabled expanded state icon.

Returns:

cached disabled expanded state icon

clearCachedExpandIcons

protected void clearCachedExpandIcons()

Clears cached collapsed state icons.

getCachedExpandIcon

protected javax.swing.ImageIcon getCachedExpandIcon()

Returns cached collapsed state icon.

Returns:

cached collapsed state icon

getCachedDisabledExpandIcon

protected javax.swing.ImageIcon getCachedDisabledExpandIcon()

Returns cached disabled collapsed state icon.

Returns:

cached disabled collapsed state icon

getHeaderPanel

public WebPanel getHeaderPanel()

Returns header panel.

Returns:

header panel

getExpandButton

public WebButton getExpandButton()

Returns state change button.

Returns:

state change button

getTitleComponent

public java.awt.Component getTitleComponent()

Returns title component.

Returns:

title component

setTitleComponent

public void setTitleComponent(java.awt.Component titleComponent)

Sets custom title component.

Parameters:

titleComponent - new custom title component

getContent

public java.awt.Component getContent()

Returns collapsible pane content.

Returns:

collapsible pane content

setContent

public void setContent(java.awt.Component content)

Sets collapsible pane content.

Parameters:

content - new collapsible pane content

getCollapsiblePaneListeners

public java.util.List<CollapsiblePaneListener> getCollapsiblePaneListeners()

Returns collapsible pane listeners.

Returns:

collapsible pane listeners

setCollapsiblePaneListeners

public void setCollapsiblePaneListeners(java.util.List<CollapsiblePaneListener> listeners)

Sets collapsible pane listeners.

Parameters:

listeners - new collapsible pane listeners

addCollapsiblePaneListener

public void addCollapsiblePaneListener(CollapsiblePaneListener listener)

Adds collapsible pane listener.

Parameters:

listener - collapsible pane listener to add

removeCollapsiblePaneListener

public void removeCollapsiblePaneListener(CollapsiblePaneListener listener)

Removes collapsible pane listener.

Parameters:

listener - collapsible pane listener to remove

fireExpanding

public void fireExpanding()

Notifies when collapsible pane starts to expand.

fireExpanded

public void fireExpanded()

Notifies when collapsible pane finished expanding.

fireCollapsing

public void fireCollapsing()

Notifies when collapsible pane starts to collapse.

fireCollapsed

public void fireCollapsed()

Notifies when collapsible pane finished collapsing.

getTransitionProgress

public float getTransitionProgress()

Returns current collapsible pane transition progress. Returns 1f when pane is fully expanded and 0f when pane is fully collapsed.

Returns:

current collapsible pane transition progress

getBasePreferredSize

public java.awt.Dimension getBasePreferredSize()

Returns preferred size without taking collapsible pane content into account.

Returns:

preferred size without taking collapsible pane content into account

setLanguage

public void setLanguage(java.lang.String key,
                        java.lang.Object... data)

Specified by:

setLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

public void updateLanguage(java.lang.Object... data)

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

updateLanguage

public void updateLanguage(java.lang.String key,
                           java.lang.Object... data)

Specified by:

updateLanguage in interface com.alee.managers.language.LanguageMethods

removeLanguage

public void removeLanguage()

Specified by:

removeLanguage in interface com.alee.managers.language.LanguageMethods

isLanguageSet

public boolean isLanguageSet()

Specified by:

isLanguageSet in interface com.alee.managers.language.LanguageMethods

setLanguageUpdater

public void setLanguageUpdater(com.alee.managers.language.updaters.LanguageUpdater updater)

Specified by:

setLanguageUpdater in interface com.alee.managers.language.LanguageMethods

removeLanguageUpdater

public void removeLanguageUpdater()

Specified by:

removeLanguageUpdater in interface com.alee.managers.language.LanguageMethods

registerSettings

public void registerSettings(java.lang.String key)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String group,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass,
                                                                                 boolean loadInitialSettings,
                                                                                 boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public <T extends com.alee.managers.settings.DefaultValue> void registerSettings(java.lang.String group,
                                                                                 java.lang.String key,
                                                                                 java.lang.Class<T> defaultValueClass,
                                                                                 boolean loadInitialSettings,
                                                                                 boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(java.lang.String group,
                             java.lang.String key,
                             java.lang.Object defaultValue,
                             boolean loadInitialSettings,
                             boolean applySettingsChanges)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

registerSettings

public void registerSettings(com.alee.managers.settings.SettingsProcessor settingsProcessor)

Specified by:

registerSettings in interface com.alee.managers.settings.SettingsMethods

unregisterSettings

public void unregisterSettings()

Specified by:

unregisterSettings in interface com.alee.managers.settings.SettingsMethods

loadSettings

public void loadSettings()

Specified by:

loadSettings in interface com.alee.managers.settings.SettingsMethods

saveSettings

public void saveSettings()

Specified by:

saveSettings in interface com.alee.managers.settings.SettingsMethods