Package org.pushingpixels.flamingo.internal.ui.ribbon

Class JRibbonGallery

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonGallery

public class JRibbonGallery
extends javax.swing.JComponent

In-ribbon gallery. This class is for internal use only and should not be directly used by the applications.

See Also:

JRibbonBand.addRibbonGallery(String, List, Map, int, int, RibbonElementPriority), JRibbonBand.addRibbonGallery(String, List, Map, int, int, CommandButtonDisplayState, RibbonElementPriority), Serialized Form

Nested Class Summary

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

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<JCommandToggleButton>	buttons	The buttons of this gallery.
protected CommandToggleButtonGroup	buttonSelectionGroup	Button group for ensuring that only one button is selected.
protected java.util.List<StringValuePair<java.util.List<FlamingoCommand>>>	commandGroups	Gallery command groups.
protected java.util.List<FlamingoCommand>	commands	The commands of this gallery.
protected RibbonElementPriority	displayPriority	The current display priority of this in-ribbon gallery.
protected boolean	isShowingPopupPanel	Indication whether the ribbon gallery is showing the popup panel.
protected JRibbonBand.RibbonGalleryPopupCallback	popupCallback
protected int	preferredPopupMaxButtonColumns	Preferred maximum number of button columns for the popup panel.
protected int	preferredPopupMaxVisibleButtonRows	Preferred maximum number of visible button rows for the popup panel.
protected java.util.Map<RibbonElementPriority,java.lang.Integer>	preferredVisibleIconCount	Preferred widths for each possible display state (set in the user code according to design preferences).
static java.lang.String	uiClassID	The UI class ID string.

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

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

Constructor Summary

Constructors

Constructor	Description
JRibbonGallery()	Creates new in-ribbon gallery.

Method Summary

Modifier and Type	Method	Description
void	addRibbonGalleryCommands(java.lang.String commandGroupName, FlamingoCommand... commands)	Adds commands to the specified command group in this ribbon gallery.
JCommandToggleButton	getButtonAt(int index)	Returns the gallery button at specified index.
CommandButtonDisplayState	getButtonDisplayState()
JCommandToggleButton	getButtonForCommand(FlamingoCommand command)
FlamingoCommand	getCommandAt(int index)	Returns the gallery command at specified index.
int	getCommandCount()	Returns the number of gallery commands in this in-ribbon gallery.
java.util.List<FlamingoCommand>	getCommandGroup(java.lang.String commandGroupName)	Returns the list of commands in the specified command group.
int	getCommandGroupCount()	Returns the number of command groups in this in-ribbon gallery.
RibbonElementPriority	getDisplayPriority()	Returns the current display priority for this in-ribbon gallery.
java.lang.String	getExpandKeyTip()
JCommandButtonPanel	getPopupButtonPanel()	Returns the associated popup gallery.
JRibbonBand.RibbonGalleryPopupCallback	getPopupCallback()
int	getPreferredPopupMaxButtonColumns()
int	getPreferredPopupMaxVisibleButtonRows()
int	getPreferredWidth(RibbonElementPriority state, int availableHeight)	Returns the preferred width of this in-ribbon gallery for the specified display state.
JCommandToggleButton	getSelectedButton()	Returns the currently selected gallery button.
FlamingoCommand	getSelectedCommand()	Returns the currently selected gallery command.
RibbonGalleryUI	getUI()	Returns the UI object which implements the L&F for this component.
java.lang.String	getUIClassID()	Returns the name of the UI class that implements the L&F for this component.
boolean	isShowingPopupPanel()	Returns indication whether the popup panel is showing.
void	removeRibbonGalleryCommands(FlamingoCommand... commands)	Removes the specified commands from this ribbon gallery.
void	setCommandDisplayState(CommandButtonDisplayState commandDisplayState)
void	setDisplayPriority(RibbonElementPriority displayPriority)	Sets new display priority for this in-ribbon gallery.
void	setExpandKeyTip(java.lang.String expandKeyTip)
void	setGroupMapping(java.util.List<StringValuePair<java.util.List<FlamingoCommand>>> commands)	Sets the command groups for this ribbon gallery.
void	setPopupCallback(JRibbonBand.RibbonGalleryPopupCallback popupCallback)
void	setPreferredPopupPanelDimension(int preferredPopupMaxButtonColumns, int preferredPopupMaxVisibleButtonRows)	Sets the preferred dimension of the popup panel.
void	setPreferredVisibleButtonCount(RibbonElementPriority state, int visibleButtonCount)	Set preferred width of this in-ribbon gallery for the specified display state.
void	setSelectedButton(JCommandToggleButton selectedButton)	Changes the selection to the specified button.
void	setSelectedCommand(FlamingoCommand selectedCommand)	Changes the selection to the specified button.
void	setShowingPopupPanel(boolean isShowingPopupPanel)	Sets indication whether the popup panel is showing.
void	setUI(RibbonGalleryUI ui)	Sets the new UI delegate.
void	updateUI()	Resets the UI property to a value from the current look and feel.

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, 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 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 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, 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 java.lang.Object

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

Field Detail

buttons

protected java.util.List<JCommandToggleButton> buttons

The buttons of this gallery.

commands

protected java.util.List<FlamingoCommand> commands

The commands of this gallery.

buttonSelectionGroup

protected CommandToggleButtonGroup buttonSelectionGroup

Button group for ensuring that only one button is selected.

displayPriority

protected RibbonElementPriority displayPriority

The current display priority of this in-ribbon gallery.

preferredVisibleIconCount

protected java.util.Map<RibbonElementPriority,java.lang.Integer> preferredVisibleIconCount

Preferred widths for each possible display state (set in the user code according to design preferences).

commandGroups

protected java.util.List<StringValuePair<java.util.List<FlamingoCommand>>> commandGroups

Gallery command groups.

preferredPopupMaxButtonColumns

protected int preferredPopupMaxButtonColumns

Preferred maximum number of button columns for the popup panel.

preferredPopupMaxVisibleButtonRows

protected int preferredPopupMaxVisibleButtonRows

Preferred maximum number of visible button rows for the popup panel.

isShowingPopupPanel

protected boolean isShowingPopupPanel

Indication whether the ribbon gallery is showing the popup panel.

popupCallback

protected JRibbonBand.RibbonGalleryPopupCallback popupCallback

uiClassID

public static final java.lang.String uiClassID

The UI class ID string.

See Also:

Constant Field Values

Constructor Detail

JRibbonGallery

public JRibbonGallery()

Creates new in-ribbon gallery.

Method Detail

setUI

public void setUI(RibbonGalleryUI ui)

Sets the new UI delegate.

Parameters:

ui - New UI delegate.

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel.

Overrides:

updateUI in class javax.swing.JComponent

See Also:

JComponent.updateUI()

getUI

public RibbonGalleryUI getUI()

Returns the UI object which implements the L&F for this component.

Overrides:

getUI in class javax.swing.JComponent

Returns:

a RibbonGalleryUI object

See Also:

setUI(org.pushingpixels.flamingo.internal.ui.ribbon.RibbonGalleryUI)

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the UI class that implements the L&F for this component.

Overrides:

getUIClassID in class javax.swing.JComponent

Returns:

the string "RibbonGalleryUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setPreferredVisibleButtonCount

public void setPreferredVisibleButtonCount(RibbonElementPriority state,
                                           int visibleButtonCount)

Set preferred width of this in-ribbon gallery for the specified display state.

Parameters:

state - Display state.

visibleButtonCount - Preferred width for the specified state.

getPreferredWidth

public int getPreferredWidth(RibbonElementPriority state,
                             int availableHeight)

Returns the preferred width of this in-ribbon gallery for the specified display state.

Parameters:

state - Display state.

availableHeight - Available height in pixels.

Returns:

The preferred width of this in-ribbon gallery for the specified display state.

setDisplayPriority

public void setDisplayPriority(RibbonElementPriority displayPriority)

Sets new display priority for this in-ribbon gallery.

Parameters:

displayPriority - New display priority for this in-ribbon gallery.

getDisplayPriority

public RibbonElementPriority getDisplayPriority()

Returns the current display priority for this in-ribbon gallery.

Returns:

The current display priority for this in-ribbon gallery.

getCommandGroupCount

public int getCommandGroupCount()

Returns the number of command groups in this in-ribbon gallery.

Returns:

The number of command groups in this in-ribbon gallery.

getCommandGroup

public java.util.List<FlamingoCommand> getCommandGroup(java.lang.String commandGroupName)

Returns the list of commands in the specified command group.

Parameters:

commandGroupName - Command group name.

Returns:

The list of commands in the specified command group.

getCommandCount

public int getCommandCount()

Returns the number of gallery commands in this in-ribbon gallery.

Returns:

The number of gallery commands in this in-ribbon gallery.

getCommandAt

public FlamingoCommand getCommandAt(int index)

Returns the gallery command at specified index.

Parameters:

index - Gallery command index.

Returns:

Gallery command at specified index.

getButtonAt

public JCommandToggleButton getButtonAt(int index)

Returns the gallery button at specified index.

Parameters:

index - Gallery button index.

Returns:

Gallery button at specified index.

getButtonForCommand

public JCommandToggleButton getButtonForCommand(FlamingoCommand command)

getSelectedButton

public JCommandToggleButton getSelectedButton()

Returns the currently selected gallery button.

Returns:

The currently selected gallery button.

getSelectedCommand

public FlamingoCommand getSelectedCommand()

Returns the currently selected gallery command.

Returns:

The currently selected gallery command.

setSelectedButton

public void setSelectedButton(JCommandToggleButton selectedButton)

Changes the selection to the specified button.

Parameters:

selectedButton - New value for the currently selected gallery button.

setSelectedCommand

public void setSelectedCommand(FlamingoCommand selectedCommand)

Changes the selection to the specified button.

Parameters:

selectedCommand - New value for the currently selected gallery command.

getPopupButtonPanel

public JCommandButtonPanel getPopupButtonPanel()

Returns the associated popup gallery.

Returns:

The associated popup gallery.

setShowingPopupPanel

public void setShowingPopupPanel(boolean isShowingPopupPanel)

Sets indication whether the popup panel is showing.

Parameters:

isShowingPopupPanel - Indication whether the popup panel is showing.

isShowingPopupPanel

public boolean isShowingPopupPanel()

Returns indication whether the popup panel is showing.

Returns:

true if the popup panel is showing, false otherwise.

setGroupMapping

public void setGroupMapping(java.util.List<StringValuePair<java.util.List<FlamingoCommand>>> commands)

Sets the command groups for this ribbon gallery.

Parameters:

commands - Command groups.

addRibbonGalleryCommands

public void addRibbonGalleryCommands(java.lang.String commandGroupName,
                                     FlamingoCommand... commands)

Adds commands to the specified command group in this ribbon gallery.

Parameters:

commandGroupName - Command group name.

commands - Commands to add to the specified command group.

removeRibbonGalleryCommands

public void removeRibbonGalleryCommands(FlamingoCommand... commands)

Removes the specified commands from this ribbon gallery.

Parameters:

commands - Commands to remove from this gallery.

setPreferredPopupPanelDimension

public void setPreferredPopupPanelDimension(int preferredPopupMaxButtonColumns,
                                            int preferredPopupMaxVisibleButtonRows)

Sets the preferred dimension of the popup panel.

Parameters:

preferredPopupMaxButtonColumns - Preferred maximum number of button columns for the popup panel.

preferredPopupMaxVisibleButtonRows - Preferred maximum number of visible button rows for the popup panel.

setPopupCallback

public void setPopupCallback(JRibbonBand.RibbonGalleryPopupCallback popupCallback)

getPopupCallback

public JRibbonBand.RibbonGalleryPopupCallback getPopupCallback()

getPreferredPopupMaxButtonColumns

public int getPreferredPopupMaxButtonColumns()

getPreferredPopupMaxVisibleButtonRows

public int getPreferredPopupMaxVisibleButtonRows()

setExpandKeyTip

public void setExpandKeyTip(java.lang.String expandKeyTip)

getExpandKeyTip

public java.lang.String getExpandKeyTip()

getButtonDisplayState

public CommandButtonDisplayState getButtonDisplayState()

setCommandDisplayState

public void setCommandDisplayState(CommandButtonDisplayState commandDisplayState)