Class JRibbonGallery

    • Nested Class Summary

      • 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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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.
      java.lang.String getUIClassID()
      Returns the name of the UI delegate for this component.
      private void populateContent()  
      private void setGroupMapping​(java.util.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 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
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • 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:
        updateUI in class javax.swing.JComponent
        See Also:
        JComponent.updateUI()
      • getUIClassID

        public java.lang.String getUIClassID()
        Returns the name of the UI delegate for this component.
        Overrides:
        getUIClassID in class javax.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 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.
      • setGroupMapping

        private void setGroupMapping​(java.util.List<CommandGroup> commandGroups)
        Sets the command groups for this ribbon gallery.
        Parameters:
        commandGroups - Command groups.