Class JCommandButtonPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.pushingpixels.radiance.component.api.common.JCommandButtonPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Scrollable

Direct Known Subclasses:

AbstractFileViewPanel, JRibbonApplicationMenuPopupPanelSecondary

public class JCommandButtonPanel
extends JComponent
implements Scrollable

Panel that hosts command buttons. Provides support for button groups, single selection mode (for toggle command buttons), same icon state / dimension and column-fill / row-fill layout. Note that while this class is a part of public API, it is highly recommended to use the CommandPanelContentModel and CommandPanelPresentationModel instances used to project the command button panel on screen for any dynamic manipulation of the state.

Under the default PanelRowFillSpec, the buttons are laid out in rows, never exceeding the available horizontal space. A vertical scroll bar will kick in once there is not enough vertical space to show all the buttons. The schematic below shows a row-fill command button panel:

+-----------------------------+-+
|                             |o|
| +----+ +----+ +----+ +----+ |o|
| | 01 | | 02 | | 03 | | 04 | |o|
| +----+ +----+ +----+ +----+ |o|
|                             | |
| +----+ +----+ +----+ +----+ | |
| | 05 | | 06 | | 07 | | 07 | | |
| +----+ +----+ +----+ +----+ | |
|                             | |
| +----+ +----+ +----+ +----+ | |
| | 09 | | 10 | | 11 | | 12 | | |
| +----+ +----+ +----+ +----+ | |
|                             | |
| +----+ +----+ +----+ +----+ | |
| | 13 | | 14 | | 15 | | 16 | | |
+-----------------------------+-+

Each row hosts four buttons, and the vertical scroll bar allows scrolling the content up and down.

Under the PanelColumnFillSpec, the buttons are laid out in columns, never exceeding the available vertical space. A horizontal scroll bar will kick in once there is not enough horizontal space to show all the buttons. The schematic below shows a column-fill command button panel:

+---------------------------------+
|                                 |
| +----+ +----+ +----+ +----+ +---|
| | 01 | | 04 | | 07 | | 10 | | 13|
| +----+ +----+ +----+ +----+ +---|
|                                 |
| +----+ +----+ +----+ +----+ +---|
| | 02 | | 05 | | 08 | | 11 | | 14|
| +----+ +----+ +----+ +----+ +---|
|                                 |
| +----+ +----+ +----+ +----+ +---|
| | 03 | | 06 | | 09 | | 12 | | 15|
| +----+ +----+ +----+ +----+ +---|
|                                 |
+---------------------------------+
|oooo                             |
+---------------------------------+

Each column hosts three buttons, and the horizontal scroll bar allows scrolling the content left and right.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private CommandPanelContentModel	panelContentModel
private CommandPanelPresentationModel	panelPresentationModel
private Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel>	projection
static final String	uiClassID

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
JCommandButtonPanel(Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel> projection)

Method Summary

Modifier and Type	Method	Description
Dimension	getPreferredScrollableViewportSize()
Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel>	getProjection()
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
boolean	getScrollableTracksViewportHeight()
boolean	getScrollableTracksViewportWidth()
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
CommandButtonPanelUI	getUI()	Returns the UI delegate for this component.
String	getUIClassID()
void	scrollToSelectedCommand()
void	updateUI()

Methods inherited from class 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, getPreferredSize, 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, paramString, 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 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 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, getAccessibleContext, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class Object

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

Field Details

uiClassID

public static final String uiClassID

See Also:

• getUIClassID()
• Constant Field Values

projection

private Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel> projection

panelContentModel

private CommandPanelContentModel panelContentModel

panelPresentationModel

private CommandPanelPresentationModel panelPresentationModel

Constructor Details

JCommandButtonPanel

public JCommandButtonPanel(Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel> projection)

Method Details

getProjection

public Projection<JCommandButtonPanel, CommandPanelContentModel, CommandPanelPresentationModel> getProjection()

getUI

public CommandButtonPanelUI getUI()

Returns the UI delegate for this component.

Overrides:

getUI in class JComponent

Returns:

a CommandButtonPanelUI object

See Also:

• JComponent.setUI(ComponentUI)

updateUI

public void updateUI()

Overrides:

updateUI in class JComponent

getUIClassID

public String getUIClassID()

Overrides:

getUIClassID in class JComponent

scrollToSelectedCommand

public void scrollToSelectedCommand()

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
 int orientation,
 int direction)

Specified by:

getScrollableBlockIncrement in interface Scrollable

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
 int orientation,
 int direction)

Specified by:

getScrollableUnitIncrement in interface Scrollable