org.jvnet.flamingo.ribbon.ui
Class JBandControlPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.jvnet.flamingo.ribbon.ui.AbstractBandControlPanel
                      extended by org.jvnet.flamingo.ribbon.ui.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.

Author:
Kirill Grouchnikov
See Also:
Serialized Form

Nested Class Summary
static class JBandControlPanel.ControlPanelGroup
           
static class JBandControlPanel.GroupStartedEvent
           
static interface JBandControlPanel.GroupStartedListener
           
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
static java.util.List<AbstractCommandButton> EMPTY_GALLERY_BUTTONS_LIST
          Empty list of buttons.
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
TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
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
JBandControlPanel()
          Creates a control panel for specified ribbon band.
 
Method Summary
 void addCommandButton(AbstractCommandButton ribbonButton, RibbonElementPriority priority)
          Adds a new ribbon button to this control panel.
 void addGroupStartedListener(JBandControlPanel.GroupStartedListener l)
           
 void addRibbonComponent(JRibbonComponent comp)
           
 void addRibbonComponent(JRibbonComponent comp, int rowSpan)
           
 void addRibbonGallery(JRibbonGallery ribbonGallery, RibbonElementPriority priority)
          Adds a new in-ribbon gallery to this control panel.
 int getControlPanelGroupCount()
           
 java.util.List<JBandControlPanel.ControlPanelGroup> getControlPanelGroups()
           
 java.lang.String getControlPanelGroupTitle(int controlPanelGroupIndex)
           
 JRibbonGallery getRibbonGallery(java.lang.String galleryName)
          Returns the ribbon gallery based on its name.
 BandControlPanelUI getUI()
           
 java.lang.String getUIClassID()
           
 void removeGroupStartedListener(JBandControlPanel.GroupStartedListener l)
           
 void setPriority(JCommandButton ribbonButton, RibbonElementPriority newPriority)
          Sets new priority of a ribbon button in this control panel.
 void setPriority(JRibbonGallery ribbonGallery, RibbonElementPriority newPriority)
          Sets new priority of an in-ribbon gallery in this control panel.
 void setUI(BandControlPanelUI ui)
          Sets the new UI delegate.
 void startGroup()
           
 void startGroup(java.lang.String groupTitle)
           
 void updateUI()
           
 
Methods inherited from class org.jvnet.flamingo.ribbon.ui.AbstractBandControlPanel
getRibbonBand, setRibbonBand
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, setUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_GALLERY_BUTTONS_LIST

public static final java.util.List<AbstractCommandButton> EMPTY_GALLERY_BUTTONS_LIST
Empty list of buttons.


EMPTY_RIBBON_GALLERIES_LIST

public 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.

Parameters:
ribbonBand - 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

getUI

public BandControlPanelUI getUI()
Overrides:
getUI in class AbstractBandControlPanel

getUIClassID

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

addCommandButton

public void addCommandButton(AbstractCommandButton ribbonButton,
                             RibbonElementPriority priority)
Adds a new ribbon button to this control panel.

Parameters:
ribbonButton - Ribbon button to add.
priority - Ribbon button priority.

addRibbonGallery

public void addRibbonGallery(JRibbonGallery ribbonGallery,
                             RibbonElementPriority priority)
Adds a new in-ribbon gallery to this control panel.

Parameters:
ribbonGallery - Ribbon gallery to add.
priority - Ribbon gallery priority.

setPriority

public void setPriority(JCommandButton ribbonButton,
                        RibbonElementPriority newPriority)
Sets new priority of a ribbon button in this control panel.

Parameters:
ribbonButton - Gallery button.
newPriority - New priority for the specified ribbon button.

setPriority

public void setPriority(JRibbonGallery ribbonGallery,
                        RibbonElementPriority newPriority)
Sets new priority of an in-ribbon gallery in this control panel.

Parameters:
ribbonGallery - In-ribbon gallery.
newPriority - New priority for the specified in-ribbon gallery.

addRibbonComponent

public void addRibbonComponent(JRibbonComponent comp)

addRibbonComponent

public void addRibbonComponent(JRibbonComponent comp,
                               int rowSpan)

getControlPanelGroups

public java.util.List<JBandControlPanel.ControlPanelGroup> getControlPanelGroups()

getControlPanelGroupCount

public int getControlPanelGroupCount()

getControlPanelGroupTitle

public java.lang.String getControlPanelGroupTitle(int controlPanelGroupIndex)

startGroup

public void startGroup()

startGroup

public void startGroup(java.lang.String groupTitle)

getRibbonGallery

public JRibbonGallery getRibbonGallery(java.lang.String galleryName)
Returns the ribbon gallery based on its name.

Parameters:
galleryName - Ribbon gallery name.
Returns:
Ribbon gallery.

addGroupStartedListener

public void addGroupStartedListener(JBandControlPanel.GroupStartedListener l)

removeGroupStartedListener

public void removeGroupStartedListener(JBandControlPanel.GroupStartedListener l)