com.alee.extended.accordion

Class WebAccordionModel

java.lang.Object

com.alee.extended.accordion.WebAccordionModel

All Implemented Interfaces:

AccordionModel, ContainerListener, PropertyChangeListener, Serializable, EventListener

public class WebAccordionModel
extends Object
implements AccordionModel, PropertyChangeListener, ContainerListener

Default AccordionModel implementation.

Author:

Mikle Garin

See Also:

How to use WebAccordion, WebAccordion, AccordionPane, AccordionModel, WebAccordionModel, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected WebAccordion	accordion WebAccordion into which this WebAccordionModel is currently installed.
protected Comparator<AccordionPane>	newToOldPaneComparator Comparator for AccordionPanes for descending sorting by state change times.
protected Map<String,AccordionPaneState>	states Map of all AccordionPaneStates available in this WebAccordionModel.

Constructor Summary

Constructors

Constructor and Description
WebAccordionModel() Constructs new WebAccordionModel.

Method Summary

Modifier and Type	Method and Description
boolean	collapsePane(String id) Asks model to collapse AccordionPane with the specified identifier.
protected void	collapseUnconditionally(String id) Collapses AccordionPane with the specified identifier without any additional checks.
void	componentAdded(ContainerEvent e)
void	componentRemoved(ContainerEvent e)
boolean	expandPane(String id) Asks model to expand AccordionPane with the specified identifier.
protected void	expandUnconditionally(String id) Expands AccordionPane with the specified identifier without any additional checks.
protected WebAccordion	getAccordion() Returns non-null WebAccordion.
AccordionState	getAccordionState() Returns AccordionState.
List<String>	getCollapsedPaneIds() Returns List of identifiers of collapsed AccordionPanes.
int[]	getCollapsedPaneIndices() Returns array of indices of collapsed AccordionPanes.
List<AccordionPane>	getCollapsedPanes() Returns List of collapsed AccordionPanes.
List<String>	getExpandedPaneIds() Returns List of identifiers of expanded AccordionPanes.
int[]	getExpandedPaneIndices() Returns array of indices of expanded AccordionPanes.
List<AccordionPane>	getExpandedPanes() Returns List of expanded AccordionPanes.
AccordionPane	getFirstExpandedPane() Returns first expanded AccordionPane.
AccordionPane	getLastExpandedPane() Returns last expanded AccordionPane.
protected AccordionPaneState	getPaneState(String id) Returns AccordionPaneState for the AccordionPane with the specified identifier.
void	install(WebAccordion accordion) Installs this AccordionModel into specified WebAccordion.
boolean	isPaneCollapsed(String id) Returns whether or not AccordionPane with the specified identifier is collapsed.
boolean	isPaneExpanded(String id) Returns whether or not AccordionPane with the specified identifier is expanded.
void	propertyChange(PropertyChangeEvent e)
void	setAccordionState(AccordionState accordionState) Sets AccordionState.
void	setExpandedPaneIds(List<String> ids) Changes state of the AccordionPanes with identifiers from the specified List to expanded.
void	setExpandedPaneIndices(int[] indices) Changes state of the AccordionPanes at the specified indices to expanded.
void	uninstall(WebAccordion multiSplitPane) Uninstalls this AccordionModel from the specified WebAccordion.
protected void	validateStates() Validating that our states comply with WebAccordion conditions.

Methods inherited from class java.lang.Object

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

Field Detail

accordion

@Nullable
protected WebAccordion accordion

WebAccordion into which this WebAccordionModel is currently installed.

states

@NotNull
protected Map<String,AccordionPaneState> states

Map of all AccordionPaneStates available in this WebAccordionModel. It can also contain AccordionPaneState for panes that do not yet exist in WebAccordion.

newToOldPaneComparator

@NotNull
protected Comparator<AccordionPane> newToOldPaneComparator

Comparator for AccordionPanes for descending sorting by state change times.

Constructor Detail

WebAccordionModel

public WebAccordionModel()

Constructs new WebAccordionModel.

Method Detail

install

public void install(@NotNull
                    WebAccordion accordion)

Description copied from interface: AccordionModel

Installs this AccordionModel into specified WebAccordion.

Specified by:

install in interface AccordionModel

Parameters:

accordion - WebAccordion this model should be installed into

uninstall

public void uninstall(@NotNull
                      WebAccordion multiSplitPane)

Description copied from interface: AccordionModel

Uninstalls this AccordionModel from the specified WebAccordion.

Specified by:

uninstall in interface AccordionModel

Parameters:

multiSplitPane - WebAccordion this model should be uninstalled from

getAccordion

@NotNull
protected WebAccordion getAccordion()

Returns non-null WebAccordion.

Returns:

non-null WebAccordion

Throws:

RuntimeException - if this model is not yet installed and WebAccordion is unavailable

getAccordionState

@NotNull
public AccordionState getAccordionState()

Description copied from interface: AccordionModel

Returns AccordionState. Note that returned states will only contain states for panes that are actually available in WebAccordion at the time. All other states will be trimmed to avoid piling up unnecessary junk in the saved state. The only exception is when model is not yet installed anywhere, in that case all available states will be returned.

Specified by:

getAccordionState in interface AccordionModel

Returns:

AccordionState

setAccordionState

public void setAccordionState(@NotNull
                              AccordionState accordionState)

Description copied from interface: AccordionModel

Sets AccordionState. Note that provided states will be set "as is" to avoid trimming state for any lazy-loaded panes.

Specified by:

setAccordionState in interface AccordionModel

Parameters:

accordionState - AccordionState

propertyChange

public void propertyChange(PropertyChangeEvent e)

Specified by:

propertyChange in interface PropertyChangeListener

componentAdded

public void componentAdded(ContainerEvent e)

Specified by:

componentAdded in interface ContainerListener

componentRemoved

public void componentRemoved(ContainerEvent e)

Specified by:

componentRemoved in interface ContainerListener

validateStates

protected void validateStates()

Validating that our states comply with WebAccordion conditions. If they don't - we will automatically adjust states to fix issues.

getPaneState

@NotNull
protected AccordionPaneState getPaneState(@NotNull
                                                   String id)

Returns AccordionPaneState for the AccordionPane with the specified identifier.

Parameters:

id - AccordionPane identifier

Returns:

AccordionPaneState for the AccordionPane with the specified identifier

getFirstExpandedPane

@Nullable
public AccordionPane getFirstExpandedPane()

Description copied from interface: AccordionModel

Returns first expanded AccordionPane.

Specified by:

getFirstExpandedPane in interface AccordionModel

Returns:

first expanded AccordionPane

getLastExpandedPane

@Nullable
public AccordionPane getLastExpandedPane()

Description copied from interface: AccordionModel

Returns last expanded AccordionPane.

Specified by:

getLastExpandedPane in interface AccordionModel

Returns:

last expanded AccordionPane

getExpandedPanes

@NotNull
public List<AccordionPane> getExpandedPanes()

Description copied from interface: AccordionModel

Returns List of expanded AccordionPanes.

Specified by:

getExpandedPanes in interface AccordionModel

Returns:

List of expanded AccordionPanes

getExpandedPaneIds

@NotNull
public List<String> getExpandedPaneIds()

Description copied from interface: AccordionModel

Returns List of identifiers of expanded AccordionPanes.

Specified by:

getExpandedPaneIds in interface AccordionModel

Returns:

List of identifiers of expanded AccordionPanes

setExpandedPaneIds

public void setExpandedPaneIds(@NotNull
                               List<String> ids)

Description copied from interface: AccordionModel

Changes state of the AccordionPanes with identifiers from the specified List to expanded.

Specified by:

setExpandedPaneIds in interface AccordionModel

Parameters:

ids - List of identifiers of AccordionPanes to set expanded

getExpandedPaneIndices

@NotNull
public int[] getExpandedPaneIndices()

Description copied from interface: AccordionModel

Returns array of indices of expanded AccordionPanes.

Specified by:

getExpandedPaneIndices in interface AccordionModel

Returns:

array of indices of expanded AccordionPanes

setExpandedPaneIndices

public void setExpandedPaneIndices(@NotNull
                                   int[] indices)

Description copied from interface: AccordionModel

Changes state of the AccordionPanes at the specified indices to expanded.

Specified by:

setExpandedPaneIndices in interface AccordionModel

Parameters:

indices - indices of AccordionPanes to set expanded

isPaneExpanded

public boolean isPaneExpanded(@NotNull
                              String id)

Description copied from interface: AccordionModel

Returns whether or not AccordionPane with the specified identifier is expanded.

Specified by:

isPaneExpanded in interface AccordionModel

Parameters:

id - AccordionPane identifier

Returns:

true if AccordionPane with the specified identifier is expanded, false otherwise

expandPane

public boolean expandPane(@NotNull
                          String id)

Description copied from interface: AccordionModel

Asks model to expand AccordionPane with the specified identifier.

Specified by:

expandPane in interface AccordionModel

Parameters:

id - AccordionPane identifier

Returns:

true if AccordionPane was successfully expanded, false otherwise

expandUnconditionally

protected void expandUnconditionally(@NotNull
                                     String id)

Expands AccordionPane with the specified identifier without any additional checks. This method is intended for internal use only to avoid issues with overlapping minimum/maximum conditions.

Parameters:

id - AccordionPane identifier

getCollapsedPanes

@NotNull
public List<AccordionPane> getCollapsedPanes()

Description copied from interface: AccordionModel

Returns List of collapsed AccordionPanes.

Specified by:

getCollapsedPanes in interface AccordionModel

Returns:

List of collapsed AccordionPanes

getCollapsedPaneIds

@NotNull
public List<String> getCollapsedPaneIds()

Description copied from interface: AccordionModel

Returns List of identifiers of collapsed AccordionPanes.

Specified by:

getCollapsedPaneIds in interface AccordionModel

Returns:

List of identifiers of collapsed AccordionPanes

getCollapsedPaneIndices

@NotNull
public int[] getCollapsedPaneIndices()

Description copied from interface: AccordionModel

Returns array of indices of collapsed AccordionPanes.

Specified by:

getCollapsedPaneIndices in interface AccordionModel

Returns:

array of indices of collapsed AccordionPanes

isPaneCollapsed

public boolean isPaneCollapsed(@NotNull
                               String id)

Description copied from interface: AccordionModel

Returns whether or not AccordionPane with the specified identifier is collapsed.

Specified by:

isPaneCollapsed in interface AccordionModel

Parameters:

id - AccordionPane identifier

Returns:

true if AccordionPane with the specified identifier is collapsed, false otherwise

collapsePane

public boolean collapsePane(@NotNull
                            String id)

Description copied from interface: AccordionModel

Asks model to collapse AccordionPane with the specified identifier.

Specified by:

collapsePane in interface AccordionModel

Parameters:

id - AccordionPane identifier

Returns:

true if AccordionPane was successfully collapsed, false otherwise

collapseUnconditionally

protected void collapseUnconditionally(@NotNull
                                       String id)

Collapses AccordionPane with the specified identifier without any additional checks. This method is intended for internal use only to avoid issues with overlapping minimum/maximum conditions.

Parameters:

id - AccordionPane identifier