com.alee.laf.grouping

Class GroupPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.alee.laf.panel.WebPanel

com.alee.laf.grouping.GroupPane

All Implemented Interfaces:

com.alee.managers.language.LanguageContainerMethods, 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 GroupPane
extends WebPanel
implements javax.swing.SwingConstants

Special container that can be used to visually group up various components. It will force component to paint decoration according to its position in this container. Note that this container will control some of the styling settings provided by skin to make components look better.

See Also:

Serialized Form

Nested Class Summary

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 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
GroupPane(java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(int orientation, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(int columns, int rows, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(int orientation, int columns, int rows, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(StyleId id, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(StyleId id, int orientation, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(StyleId id, int columns, int rows, java.awt.Component... components) Constructs new group pane with specified components inside.
GroupPane(StyleId id, int orientation, int columns, int rows, java.awt.Component... components) Constructs new group pane with specified components inside.

Method Summary

Modifier and Type	Method and Description
javax.swing.ButtonGroup	getButtonGroup() Returns button group used to group toggle state elements placed within this group pane.
int	getColumns() Returns amount of columns used to place components.
GroupPaneLayout	getLayout() Returns GroupPaneLayout.
int	getOrientation() Returns components placement order orientation.
int	getRows() Returns amount of rows used to place components.
boolean	isGroupButtons() Returns whether or not should group toggle state elements.
boolean	isGrouping() Returns whether or not should visually group provided children components.
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	setColumns(int columns) Sets amount of columns used to place components.
void	setGroup(boolean group) Sets whether or not should visually group provided children components.
void	setGroupButtons(boolean group) Sets whether or not should group toggle state elements.
void	setLayout(java.awt.LayoutManager mgr) Overridden to inform when incorrect layout manager is provided.
void	setOrientation(int orientation) Sets components placement order orientation.
void	setPaintSides(boolean top, boolean left, boolean bottom, boolean right) Sets whether or not right side should be decorated.
void	setRows(int rows) Sets amount of rows used to place components.

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

Constructor Detail

GroupPane

public GroupPane(java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

components - components to group

GroupPane

public GroupPane(int orientation,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

orientation - components flow orientation

components - components to group

GroupPane

public GroupPane(int columns,
                 int rows,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

columns - amount of columns used to place components

rows - amount of rows used to place components

components - components to group

GroupPane

public GroupPane(int orientation,
                 int columns,
                 int rows,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

orientation - components flow orientation

columns - amount of columns used to place components

rows - amount of rows used to place components

components - components to group

GroupPane

public GroupPane(StyleId id,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

id - style ID

components - components to group

GroupPane

public GroupPane(StyleId id,
                 int orientation,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

id - style ID

orientation - components flow orientation

components - components to group

GroupPane

public GroupPane(StyleId id,
                 int columns,
                 int rows,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

id - style ID

columns - amount of columns used to place components

rows - amount of rows used to place components

components - components to group

GroupPane

public GroupPane(StyleId id,
                 int orientation,
                 int columns,
                 int rows,
                 java.awt.Component... components)

Constructs new group pane with specified components inside.

Parameters:

id - style ID

orientation - components flow orientation

columns - amount of columns used to place components

rows - amount of rows used to place components

components - components to group

Method Detail

setLayout

public void setLayout(java.awt.LayoutManager mgr)

Overridden to inform when incorrect layout manager is provided. Only GroupPaneLayout instances can be used.

Overrides:

setLayout in class java.awt.Container

Parameters:

mgr - layout manager

getLayout

public GroupPaneLayout getLayout()

Returns GroupPaneLayout.

Overrides:

getLayout in class java.awt.Container

Returns:

GroupPaneLayout

isGrouping

public boolean isGrouping()

Returns whether or not should visually group provided children components.

Returns:

true if should visually group provided children components, false otherwise

setGroup

public void setGroup(boolean group)

Sets whether or not should visually group provided children components.

Parameters:

group - whether or not should visually group provided children components

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

getButtonGroup

public javax.swing.ButtonGroup getButtonGroup()

Returns button group used to group toggle state elements placed within this group pane.

Returns:

button group used to group toggle state elements placed within this group pane

getOrientation

public int getOrientation()

Returns components placement order orientation.

Returns:

components placement order orientation

setOrientation

public void setOrientation(int orientation)

Sets components placement order orientation.

Parameters:

orientation - components placement order orientation

getColumns

public int getColumns()

Returns amount of columns used to place components.

Returns:

amount of columns used to place components

setColumns

public void setColumns(int columns)

Sets amount of columns used to place components.

Parameters:

columns - amount of columns to place components

getRows

public int getRows()

Returns amount of rows used to place components.

Returns:

amount of rows used to place components

setRows

public void setRows(int rows)

Sets amount of rows used to place components.

Parameters:

rows - amount of rows to place components

isPaintTop

public boolean isPaintTop()

Returns whether or not top side should be decorated.

Returns:

true if top side should be decorated, false otherwise

isPaintLeft

public boolean isPaintLeft()

Returns whether or not left side should be decorated.

Returns:

true if left side should be decorated, false otherwise

isPaintBottom

public boolean isPaintBottom()

Returns whether or not bottom side should be decorated.

Returns:

true if bottom side should be decorated, false otherwise

isPaintRight

public boolean isPaintRight()

Returns whether or not right side should be decorated.

Returns:

true if right side should be decorated, false otherwise

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