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:
java.awt.image.ImageObserver,java.awt.MenuContainer,java.io.Serializable
public class JRibbonGallery extends javax.swing.JComponentIn-ribbon gallery. This class is for internal use only and should not be directly used by the applications.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<JCommandButton>buttonsThe buttons ofthisgallery.protected java.util.List<BaseCommand>commandsThe commands ofthisgallery.private CommandToggleGroupModelcommandToggleGroupModelButton group for ensuring that only one button is selected.private java.util.Map<Command,BaseCommandButtonPresentationModel.Overlay>galleryCommandOverlaysprivate javax.swing.event.ChangeListenergalleryContentChangeListenerprivate RibbonGalleryContentModelgalleryContentModelprivate RibbonGalleryPresentationModelgalleryPresentationModelprivate RibbonGalleryProjectiongalleryProjectionprivate JRibbonBand.PresentationPrioritypresentationPriorityThe current presentation priority ofthisin-ribbon gallery.static java.lang.StringuiClassIDThe UI class ID string.-
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(RibbonGalleryProjection galleryProjection)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private voidaddGalleryCommand(Command command)Adds new gallery command tothisin-ribbon gallery.JCommandButtongetButtonAt(int index)Returns the gallery button at specified index.intgetCommandCount()Returns the number of gallery commands inthisin-ribbon gallery.static CommandMenuContentModelgetExpandPopupMenuContentModel(RibbonGalleryProjection galleryProjection)static CommandPopupMenuPanelProjectiongetExpandPopupMenuPanelProjection(RibbonGalleryProjection galleryProjection)static CommandPopupMenuPresentationModelgetExpandPopupMenuPresentationModel(RibbonGalleryProjection galleryProjection)intgetPreferredWidth(JRibbonBand.PresentationPriority state, int availableHeight)Returns the preferred width ofthisin-ribbon gallery for the specified presentation state.JRibbonBand.PresentationPrioritygetPresentationPriority()Returns the current presentation priority forthisin-ribbon gallery.RibbonGalleryProjectiongetProjection()JCommandButtongetSelectedButton()Returns the currently selected gallery button.RibbonGalleryUIgetUI()Returns the UI delegate for this component.java.lang.StringgetUIClassID()Returns the name of the UI delegate for this component.private voidpopulateContent()private voidsetGroupMapping(java.util.List<CommandGroup> commandGroups)Sets the command groups for this ribbon gallery.voidsetPresentationPriority(JRibbonBand.PresentationPriority presentationPriority)Sets new presentation priority forthisin-ribbon gallery.voidsetUI(RibbonGalleryUI ui)Sets the new UI delegate.voidupdateUI()Resets the UI property to a value from the current look and feel.private voidvalidateCommandPresentationState(CommandButtonPresentationState commandPresentationState)-
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.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 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
-
-
-
-
Field Detail
-
galleryProjection
private RibbonGalleryProjection galleryProjection
-
galleryContentModel
private RibbonGalleryContentModel galleryContentModel
-
galleryPresentationModel
private RibbonGalleryPresentationModel galleryPresentationModel
-
galleryCommandOverlays
private java.util.Map<Command,BaseCommandButtonPresentationModel.Overlay> galleryCommandOverlays
-
galleryContentChangeListener
private javax.swing.event.ChangeListener galleryContentChangeListener
-
buttons
protected java.util.List<JCommandButton> buttons
The buttons ofthisgallery.
-
commands
protected java.util.List<BaseCommand> commands
The commands ofthisgallery.
-
commandToggleGroupModel
private CommandToggleGroupModel commandToggleGroupModel
Button group for ensuring that only one button is selected.
-
presentationPriority
private JRibbonBand.PresentationPriority presentationPriority
The current presentation priority ofthisin-ribbon gallery.
-
uiClassID
public static final java.lang.String uiClassID
The UI class ID string.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JRibbonGallery
public JRibbonGallery(RibbonGalleryProjection galleryProjection)
-
-
Method Detail
-
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:
updateUIin classjavax.swing.JComponent- See Also:
JComponent.updateUI()
-
getUI
public RibbonGalleryUI getUI()
Returns the UI delegate for this component.- Overrides:
getUIin classjavax.swing.JComponent- Returns:
- a
RibbonGalleryUIobject - See Also:
setUI(org.pushingpixels.radiance.component.internal.ui.ribbon.RibbonGalleryUI)
-
getUIClassID
public java.lang.String getUIClassID()
Returns the name of the UI delegate for this component.- Overrides:
getUIClassIDin classjavax.swing.JComponent- Returns:
- the string "RibbonGalleryUI"
- See Also:
JComponent.getUIClassID(),UIDefaults.getUI(javax.swing.JComponent)
-
addGalleryCommand
private void addGalleryCommand(Command command)
Adds new gallery command tothisin-ribbon gallery.- Parameters:
command- Command to add.
-
getPreferredWidth
public int getPreferredWidth(JRibbonBand.PresentationPriority state, int availableHeight)
Returns the preferred width ofthisin-ribbon gallery for the specified presentation state.- Parameters:
state- Presentation state.availableHeight- Available height in pixels.- Returns:
- The preferred width of
thisin-ribbon gallery for the specified presentation state.
-
setPresentationPriority
public void setPresentationPriority(JRibbonBand.PresentationPriority presentationPriority)
Sets new presentation priority forthisin-ribbon gallery.- Parameters:
presentationPriority- New presentation priority forthisin-ribbon gallery.
-
getPresentationPriority
public JRibbonBand.PresentationPriority getPresentationPriority()
Returns the current presentation priority forthisin-ribbon gallery.- Returns:
- The current presentation priority for
thisin-ribbon gallery.
-
getCommandCount
public int getCommandCount()
Returns the number of gallery commands inthisin-ribbon gallery.- Returns:
- The number of gallery commands in
thisin-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(java.util.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)
-
-