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

Class JBandControlPanel

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.plaf.UIResource
    public class JBandControlPanel
extends AbstractBandControlPanel
implements javax.swing.plaf.UIResource
    Control panel of a single JRibbonBand. This class is for internal use only and should not be directly used by the applications.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JBandControlPanel.ControlPanelGroup  

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.LinkedList<JBandControlPanel.ControlPanelGroup> controlPanelGroups  
      private static java.util.List<JCommandButton> EMPTY_GALLERY_BUTTONS_LIST
      Empty list of buttons.
      private static java.util.List<JRibbonGallery> EMPTY_RIBBON_GALLERIES_LIST
      Empty list of galleries.
      static java.lang.String uiClassID
      The 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

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      JBandControlPanel()
      Creates a control panel for specified ribbon band.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addChangeListener​(javax.swing.event.ChangeListener l)  
      void addCommandButton​(BaseCommandButtonProjection<? extends BaseCommand<?>,​? extends BaseCommandMenuContentModel,​? extends BaseCommandButtonPresentationModel<?,​?>,​? extends BaseCommandPopupMenuPresentationModel> projection, JRibbonBand.PresentationPriority priority)
      Adds a new ribbon button to this control panel.
      void addRibbonComponent​(JRibbonComponent comp)  
      void addRibbonGallery​(JRibbonGallery ribbonGallery, JRibbonBand.PresentationPriority priority)
      Adds a new in-ribbon gallery to this control panel.
      private void fireChanged()  
      int getControlPanelGroupCount()  
      java.util.List<JBandControlPanel.ControlPanelGroup> getControlPanelGroups()  
      java.lang.String getControlPanelGroupTitle​(int controlPanelGroupIndex)  
      BandControlPanelUI getUI()  
      java.lang.String getUIClassID()  
      void removeChangeListener​(javax.swing.event.ChangeListener l)  
      void setGroupTitle​(int groupIndex, java.lang.String groupTitle)  
      void setUI​(BandControlPanelUI ui)
      Sets the new UI delegate.
      int startGroup()  
      int startGroup​(java.lang.String groupTitle)  
      void updateUI()  

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, paramString, setUI

      • 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, 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, 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

    • Field Detail

      • EMPTY_GALLERY_BUTTONS_LIST

        private static final java.util.List<JCommandButton> EMPTY_GALLERY_BUTTONS_LIST
        Empty list of buttons.

      • EMPTY_RIBBON_GALLERIES_LIST

        private static final java.util.List<JRibbonGallery> EMPTY_RIBBON_GALLERIES_LIST
        Empty list of galleries.

      • uiClassID

        public static final java.lang.String uiClassID
        The UI class ID string.
        See Also:
        Constant Field Values

    • Constructor Detail

      • JBandControlPanel

        public JBandControlPanel()
        Creates a control panel for specified ribbon band.

    • Method Detail

      • setUI

        public void setUI​(BandControlPanelUI ui)
        Sets the new UI delegate.
        Parameters:
        ui - New UI delegate.

      • updateUI

        public void updateUI()
        Overrides:
        updateUI in class javax.swing.JPanel

      • getUIClassID

        public java.lang.String getUIClassID()
        Overrides:
        getUIClassID in class javax.swing.JPanel

      • addRibbonGallery

        public void addRibbonGallery​(JRibbonGallery ribbonGallery,
                             JRibbonBand.PresentationPriority priority)
        Adds a new in-ribbon gallery to this control panel.
        Parameters:
        ribbonGallery - Ribbon gallery to add.
        priority - Ribbon gallery priority.

      • addRibbonComponent

        public void addRibbonComponent​(JRibbonComponent comp)

      • getControlPanelGroupCount

        public int getControlPanelGroupCount()

      • getControlPanelGroupTitle

        public java.lang.String getControlPanelGroupTitle​(int controlPanelGroupIndex)

      • startGroup

        public int startGroup()

      • startGroup

        public int startGroup​(java.lang.String groupTitle)

      • setGroupTitle

        public void setGroupTitle​(int groupIndex,
                          java.lang.String groupTitle)

      • addChangeListener

        public void addChangeListener​(javax.swing.event.ChangeListener l)

      • removeChangeListener

        public void removeChangeListener​(javax.swing.event.ChangeListener l)

      • fireChanged

        private void fireChanged()