com.alee.laf.grouping

Class AbstractGroupingLayout

java.lang.Object

com.alee.extended.layout.AbstractLayoutManager

com.alee.laf.grouping.AbstractGroupingLayout

All Implemented Interfaces:

GroupingLayout, java.awt.LayoutManager, java.awt.LayoutManager2

Direct Known Subclasses:

AccordionLayout, GroupPaneLayout

public abstract class AbstractGroupingLayout
extends AbstractLayoutManager
implements GroupingLayout

Field Summary

Fields

Modifier and Type	Field and Description
protected UnselectableButtonGroup	buttonGroup Button group used to group toggle state elements placed within container.
protected java.util.Map<java.awt.Component,com.alee.utils.general.Pair<java.lang.String,java.lang.String>>	children Container children components.
protected java.lang.Boolean	group Whether or not should visually group provided children components.
protected java.lang.Boolean	groupButtons Whether or not should group toggle state elements like togglebuttons, radiobuttons or checkboxes.
protected java.lang.String	sides Displayed children decoration sides.

Constructor Summary

Constructors

Constructor and Description
AbstractGroupingLayout()

Method Summary

Modifier and Type	Method and Description
void	addComponent(java.awt.Component component, java.lang.Object constraints) Called when component added into container with this layout.
protected void	clearGrouping() Ungroups all buttons.
protected UnselectableButtonGroup	createButtonGroup() Returns newly created button group.
UnselectableButtonGroup	getButtonGroup() Returns button group used to group toggle state elements placed within container using this layout.
protected abstract com.alee.utils.general.Pair<java.lang.String,java.lang.String>	getDescriptors(java.awt.Container parent, java.awt.Component component, int index) Returns descriptors for painted component sides and lines.
java.lang.String	getLines(java.awt.Component component) Returns descriptor for painted component lines.
java.lang.String	getSides(java.awt.Component component) Returns descriptor for painted component sides.
protected boolean	isGroupable(java.awt.Component component) Returns whether or not specified component is a groupable button.
boolean	isGroupButtons() Returns whether or not should group toggle state elements.
boolean	isGrouping() Returns whether or not components should be visually grouped.
boolean	isPaintBottom() Returns whether or not bottom side should be decorated.
boolean	isPaintLeft() Returns whether or not left side should be decorated.
boolean	isPaintRight() Returns whether or not right side should be decorated.
boolean	isPaintTop() Returns whether or not top side should be decorated.
void	removeComponent(java.awt.Component component) Called when component removed from container with this layout.
protected void	resetDescriptors() Resets cached sides and lines descriptors.
void	setGroup(boolean group) Sets whether or not components should be visually grouped.
void	setGroupButtons(boolean group) Sets whether or not should group toggle state elements.
void	setPaintBottom(boolean paint) Sets whether or not bottom side should be decorated.
void	setPaintLeft(boolean paint) Sets whether or not left side should be decorated.
void	setPaintRight(boolean paint) Sets whether or not right side should be decorated.
void	setPaintSides(boolean top, boolean left, boolean bottom, boolean right) Sets whether or not right side should be decorated.
void	setPaintTop(boolean paint) Sets whether or not top side should be decorated.
protected java.lang.String	sides() Returns non-null sides decriptor.
protected void	updateButtonGrouping() Updates button grouping.

Methods inherited from class com.alee.extended.layout.AbstractLayoutManager

addLayoutComponent, addLayoutComponent, getLayoutAlignmentX, getLayoutAlignmentY, invalidateLayout, maximumLayoutSize, minimumLayoutSize, removeLayoutComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.LayoutManager2

addLayoutComponent, getLayoutAlignmentX, getLayoutAlignmentY, invalidateLayout, maximumLayoutSize

Methods inherited from interface java.awt.LayoutManager

addLayoutComponent, layoutContainer, minimumLayoutSize, preferredLayoutSize, removeLayoutComponent

Field Detail

group

@XStreamAsAttribute
protected java.lang.Boolean group

Whether or not should visually group provided children components. It is always enabled by default but can be disabled if required. Disabling this option will automatically ungroup all components.

groupButtons

@XStreamAsAttribute
protected java.lang.Boolean groupButtons

Whether or not should group toggle state elements like togglebuttons, radiobuttons or checkboxes. Only elements placed straight within this GroupPane are grouped.

sides

@XStreamAsAttribute
protected java.lang.String sides

Displayed children decoration sides. It might be useful to disable sides decoration while keeping it between the child components.

children

protected transient java.util.Map<java.awt.Component,com.alee.utils.general.Pair<java.lang.String,java.lang.String>> children

Container children components.

buttonGroup

protected transient UnselectableButtonGroup buttonGroup

Button group used to group toggle state elements placed within container.

Constructor Detail

AbstractGroupingLayout

public AbstractGroupingLayout()

Method Detail

isGrouping

public boolean isGrouping()

Description copied from interface: GroupingLayout

Returns whether or not components should be visually grouped.

Specified by:

isGrouping in interface GroupingLayout

Returns:

true if components should be visually grouped, false otherwise

setGroup

public void setGroup(boolean group)

Sets whether or not components should be visually grouped.

Parameters:

group - whether or not components should be visually grouped

isGroupButtons

public boolean isGroupButtons()

Returns whether or not should group toggle state elements.

Returns:

true if should group toggle state elements, false otherwise

setGroupButtons

public void setGroupButtons(boolean group)

Sets whether or not should group toggle state elements. Changing this flag will automatically group or ungroup toggle state elements in this pane.

Parameters:

group - whether or not should group toggle state elements

createButtonGroup

protected UnselectableButtonGroup createButtonGroup()

Returns newly created button group.

Returns:

newly created button group

clearGrouping

protected void clearGrouping()

Ungroups all buttons.

updateButtonGrouping

protected void updateButtonGrouping()

Updates button grouping.

isGroupable

protected boolean isGroupable(java.awt.Component component)

Returns whether or not specified component is a groupable button.

Parameters:

component - component to process

Returns:

true if specified component is a groupable button, false otherwise

getButtonGroup

public UnselectableButtonGroup getButtonGroup()

Returns button group used to group toggle state elements placed within container using this layout.

Returns:

button group used to group toggle state elements placed within container using this layout

sides

protected java.lang.String sides()

Returns non-null sides decriptor.

Returns:

non-null sides decriptor

isPaintTop

public boolean isPaintTop()

Returns whether or not top side should be decorated.

Returns:

true if top side should be decorated, false otherwise

setPaintTop

public void setPaintTop(boolean paint)

Sets whether or not top side should be decorated.

Parameters:

paint - whether or not top side should be decorated

isPaintLeft

public boolean isPaintLeft()

Returns whether or not left side should be decorated.

Returns:

true if left side should be decorated, false otherwise

setPaintLeft

public void setPaintLeft(boolean paint)

Sets whether or not left side should be decorated.

Parameters:

paint - whether or not left side should be decorated

isPaintBottom

public boolean isPaintBottom()

Returns whether or not bottom side should be decorated.

Returns:

true if bottom side should be decorated, false otherwise

setPaintBottom

public void setPaintBottom(boolean paint)

Sets whether or not bottom side should be decorated.

Parameters:

paint - whether or not bottom side should be decorated

isPaintRight

public boolean isPaintRight()

Returns whether or not right side should be decorated.

Returns:

true if right side should be decorated, false otherwise

setPaintRight

public void setPaintRight(boolean paint)

Sets whether or not right side should be decorated.

Parameters:

paint - whether or not right side should be decorated

setPaintSides

public void setPaintSides(boolean top,
                          boolean left,
                          boolean bottom,
                          boolean right)

Sets whether or not right side should be decorated.

Parameters:

top - whether or not top side should be decorated

left - whether or not bottom side should be decorated

bottom - whether or not bottom side should be decorated

right - whether or not right side should be decorated

addComponent

public void addComponent(java.awt.Component component,
                         java.lang.Object constraints)

Description copied from class: AbstractLayoutManager

Called when component added into container with this layout.

Overrides:

addComponent in class AbstractLayoutManager

Parameters:

component - added component

constraints - component constraints

removeComponent

public void removeComponent(java.awt.Component component)

Description copied from class: AbstractLayoutManager

Called when component removed from container with this layout.

Overrides:

removeComponent in class AbstractLayoutManager

Parameters:

component - removed component

getSides

public final java.lang.String getSides(java.awt.Component component)

Description copied from interface: GroupingLayout

Returns descriptor for painted component sides.

Specified by:

getSides in interface GroupingLayout

Parameters:

component - painted component

Returns:

descriptor for painted component sides

getLines

public final java.lang.String getLines(java.awt.Component component)

Description copied from interface: GroupingLayout

Returns descriptor for painted component lines.

Specified by:

getLines in interface GroupingLayout

Parameters:

component - painted component

Returns:

descriptor for painted component lines

getDescriptors

protected abstract com.alee.utils.general.Pair<java.lang.String,java.lang.String> getDescriptors(java.awt.Container parent,
                                                                                                 java.awt.Component component,
                                                                                                 int index)

Returns descriptors for painted component sides and lines. It is requested only if grouping is actually enabled.

Parameters:

parent - component container

component - painted component

index - component z-index in container

Returns:

descriptors for painted component sides and lines

resetDescriptors

protected void resetDescriptors()

Resets cached sides and lines descriptors.