Class JRibbonGallery

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.pushingpixels.radiance.component.internal.ui.ribbon.JRibbonGallery

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class JRibbonGallery
extends JComponent

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

See Also:

• JRibbonBand.addRibbonGallery(RibbonGalleryProjection, JRibbonBand.PresentationPriority)
• JRibbon.addTaskbarGalleryDropdown(RibbonGalleryProjection)
• 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
protected List<JCommandButton>	buttons	The buttons of this gallery.
protected List<BaseCommand>	commands	The commands of this gallery.
private CommandToggleGroupModel	commandToggleGroupModel	Button group for ensuring that only one button is selected.
private Map<Command, BaseCommandButtonPresentationModel.Overlay>	galleryCommandOverlays
private ChangeListener	galleryContentChangeListener
private RibbonGalleryContentModel	galleryContentModel
private RibbonGalleryPresentationModel	galleryPresentationModel
private RibbonGalleryProjection	galleryProjection
private JRibbonBand.PresentationPriority	presentationPriority	The current presentation priority of this in-ribbon gallery.
static final String	uiClassID	The UI class ID string.

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
JRibbonGallery(RibbonGalleryProjection galleryProjection)

Method Summary

Modifier and Type	Method	Description
private void	addGalleryCommand(Command command)	Adds new gallery command to this in-ribbon gallery.
JCommandButton	getButtonAt(int index)	Returns the gallery button at specified index.
int	getCommandCount()	Returns the number of gallery commands in this in-ribbon gallery.
static CommandMenuContentModel	getExpandPopupMenuContentModel(RibbonGalleryProjection galleryProjection)
static CommandPopupMenuPanelProjection	getExpandPopupMenuPanelProjection(RibbonGalleryProjection galleryProjection)
static CommandPopupMenuPresentationModel	getExpandPopupMenuPresentationModel(RibbonGalleryProjection galleryProjection)
int	getPreferredWidth(JRibbonBand.PresentationPriority state, int availableHeight)	Returns the preferred width of this in-ribbon gallery for the specified presentation state.
JRibbonBand.PresentationPriority	getPresentationPriority()	Returns the current presentation priority for this in-ribbon gallery.
RibbonGalleryProjection	getProjection()
JCommandButton	getSelectedButton()	Returns the currently selected gallery button.
RibbonGalleryUI	getUI()	Returns the UI delegate for this component.
String	getUIClassID()	Returns the name of the UI delegate for this component.
private void	populateContent()
private void	setGroupMapping(List<CommandGroup> commandGroups)	Sets the command groups for this ribbon gallery.
void	setPresentationPriority(JRibbonBand.PresentationPriority presentationPriority)	Sets new presentation priority for this in-ribbon gallery.
void	setUI(RibbonGalleryUI ui)	Sets the new UI delegate.
void	updateUI()	Resets the UI property to a value from the current look and feel.
private void	validateCommandPresentationState(CommandButtonPresentationState commandPresentationState)

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

galleryProjection

private RibbonGalleryProjection galleryProjection

galleryContentModel

private RibbonGalleryContentModel galleryContentModel

galleryPresentationModel

private RibbonGalleryPresentationModel galleryPresentationModel

galleryCommandOverlays

private Map<Command, BaseCommandButtonPresentationModel.Overlay> galleryCommandOverlays

galleryContentChangeListener

private ChangeListener galleryContentChangeListener

buttons

protected List<JCommandButton> buttons

The buttons of this gallery.

commands

protected List<BaseCommand> commands

The commands of this gallery.

commandToggleGroupModel

private CommandToggleGroupModel commandToggleGroupModel

Button group for ensuring that only one button is selected.

presentationPriority

private JRibbonBand.PresentationPriority presentationPriority

The current presentation priority of this in-ribbon gallery.

uiClassID

public static final String uiClassID

The UI class ID string.

See Also:

• Constant Field Values

Constructor Details

JRibbonGallery

public JRibbonGallery(RibbonGalleryProjection galleryProjection)

Method Details

populateContent

private void populateContent()

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 JComponent

See Also:

• JComponent.updateUI()

getUI

public RibbonGalleryUI getUI()

Returns the UI delegate for this component.

Overrides:

getUI in class JComponent

Returns:

a RibbonGalleryUI object

See Also:

• setUI(RibbonGalleryUI)

getUIClassID

public String getUIClassID()

Returns the name of the UI delegate for this component.

Overrides:

getUIClassID in class JComponent

Returns:

the string "RibbonGalleryUI"

See Also:

• JComponent.getUIClassID()
• UIDefaults.getUI(JComponent)

addGalleryCommand

private void addGalleryCommand(Command command)

Adds new gallery command to this in-ribbon gallery.

Parameters:

command - Command to add.

getPreferredWidth

public int getPreferredWidth(JRibbonBand.PresentationPriority state,
 int availableHeight)

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

Parameters:

state - Presentation state.

availableHeight - Available height in pixels.

Returns:

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

setPresentationPriority

public void setPresentationPriority(JRibbonBand.PresentationPriority presentationPriority)

Sets new presentation priority for this in-ribbon gallery.

Parameters:

presentationPriority - New presentation priority for this in-ribbon gallery.

getPresentationPriority

public JRibbonBand.PresentationPriority getPresentationPriority()

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

Returns:

The current presentation priority for this in-ribbon gallery.

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.

getButtonAt

public JCommandButton getButtonAt(int index)

Returns the gallery button at specified index.

Parameters:

index - Gallery button index.

Returns:

Gallery button at specified index.

getSelectedButton

public JCommandButton getSelectedButton()

Returns the currently selected gallery button.

Returns:

The currently selected gallery button.

getProjection

public RibbonGalleryProjection getProjection()

setGroupMapping

private void setGroupMapping(List<CommandGroup> commandGroups)

Sets the command groups for this ribbon gallery.

Parameters:

commandGroups - Command groups.

validateCommandPresentationState

private void validateCommandPresentationState(CommandButtonPresentationState commandPresentationState)

getExpandPopupMenuPanelProjection

public static CommandPopupMenuPanelProjection getExpandPopupMenuPanelProjection(RibbonGalleryProjection galleryProjection)

getExpandPopupMenuContentModel

public static CommandMenuContentModel getExpandPopupMenuContentModel(RibbonGalleryProjection galleryProjection)

getExpandPopupMenuPresentationModel

public static CommandPopupMenuPresentationModel getExpandPopupMenuPresentationModel(RibbonGalleryProjection galleryProjection)