Class JRibbonGallery
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonGallery
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
In-ribbon gallery. This class is for internal use only and should not be
directly used by the applications.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List
<StringValuePair<List<JCommandToggleButton>>> Gallery button groups.protected List
<JCommandToggleButton> The buttons ofthis
gallery.protected CommandToggleButtonGroup
Button group for ensuring that only one button is selected.protected RibbonElementPriority
The current display priority ofthis
in-ribbon gallery.protected boolean
Indication whether the ribbon gallery is showing the popup panel.protected JRibbonBand.RibbonGalleryPopupCallback
protected int
Preferred maximum number of button columns for the popup panel.protected int
Preferred maximum number of visible button rows for the popup panel.protected Map
<RibbonElementPriority, Integer> Preferred widths for each possible display state (set in the user code according to design preferences).static final String
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRibbonGalleryButtons
(String buttonGroupName, JCommandToggleButton... buttons) Adds toggle command buttons to the specified button group in this ribbon gallery.getButtonAt
(int index) Returns the gallery button at specified index.int
Returns the number of gallery buttons inthis
in-ribbon gallery.getButtonGroup
(String buttonGroupName) Returns the list of buttons in the specifed button group.int
Returns the number of button groups inthis
in-ribbon gallery.Returns the current display priority forthis
in-ribbon gallery.Returns the associated popup gallery.int
int
int
getPreferredWidth
(RibbonElementPriority state, int availableHeight) Returns the preferred width ofthis
in-ribbon gallery for the specified display state.Returns the currently selected gallery button.getUI()
Returns the UI object which implements the Linvalid input: '&F' for this component.Returns the name of the UI class that implements the Linvalid input: '&F' for this component.boolean
Returns indication whether the popup panel is showing.void
removeRibbonGalleryButtons
(JCommandToggleButton... buttons) Removes the specified toggle command buttons from this ribbon gallery.void
setButtonDisplayState
(CommandButtonDisplayState buttonDisplayState) void
setDisplayPriority
(RibbonElementPriority displayPriority) Sets new display priority forthis
in-ribbon gallery.void
setExpandKeyTip
(String expandKeyTip) void
setGroupMapping
(List<StringValuePair<List<JCommandToggleButton>>> buttons) Sets the button groups for this ribbon gallery.void
setPopupCallback
(JRibbonBand.RibbonGalleryPopupCallback popupCallback) void
setPreferredPopupPanelDimension
(int preferredPopupMaxButtonColumns, int preferredPopupMaxVisibleButtonRows) Sets the preferred dimension of the popup panel.void
setPreferredVisibleButtonCount
(RibbonElementPriority state, int visibleButtonCount) Set preferred width ofthis
in-ribbon gallery for the specified display state.void
setSelectedButton
(JCommandToggleButton selectedButton) Sets new value for the currently selected gallery button.void
setShowingPopupPanel
(boolean isShowingPopupPanel) Sets indication whether the popup panel is showing.void
setUI
(RibbonGalleryUI ui) Sets the new UI delegate.void
updateUI()
Resets the UI property to a value from the current look and feel.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 Details
-
buttons
The buttons ofthis
gallery. -
buttonSelectionGroup
Button group for ensuring that only one button is selected. -
displayPriority
The current display priority ofthis
in-ribbon gallery. -
preferredVisibleIconCount
Preferred widths for each possible display state (set in the user code according to design preferences). -
buttonGroups
Gallery button groups. -
preferredPopupMaxButtonColumns
protected int preferredPopupMaxButtonColumnsPreferred maximum number of button columns for the popup panel. -
preferredPopupMaxVisibleButtonRows
protected int preferredPopupMaxVisibleButtonRowsPreferred maximum number of visible button rows for the popup panel. -
isShowingPopupPanel
protected boolean isShowingPopupPanelIndication whether the ribbon gallery is showing the popup panel. -
popupCallback
-
uiClassID
The UI class ID string.- See Also:
-
-
Constructor Details
-
JRibbonGallery
public JRibbonGallery()Creates new in-ribbon gallery.
-
-
Method Details
-
setUI
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 classJComponent
- See Also:
-
getUI
Returns the UI object which implements the Linvalid input: '&F' for this component.- Overrides:
getUI
in classJComponent
- Returns:
- a
RibbonGalleryUI
object - See Also:
-
getUIClassID
Returns the name of the UI class that implements the Linvalid input: '&F' for this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "RibbonGalleryUI"
- See Also:
-
setPreferredVisibleButtonCount
Set preferred width ofthis
in-ribbon gallery for the specified display state.- Parameters:
state
- Display state.visibleButtonCount
- Preferred width for the specified state.
-
getPreferredWidth
Returns the preferred width ofthis
in-ribbon gallery for the specified display state.- Parameters:
state
- Display state.availableHeight
- Available height in pixels.- Returns:
- The preferred width of
this
in-ribbon gallery for the specified display state.
-
setDisplayPriority
Sets new display priority forthis
in-ribbon gallery.- Parameters:
displayPriority
- New display priority forthis
in-ribbon gallery.
-
getDisplayPriority
Returns the current display priority forthis
in-ribbon gallery.- Returns:
- The current display priority for
this
in-ribbon gallery.
-
getButtonGroupCount
public int getButtonGroupCount()Returns the number of button groups inthis
in-ribbon gallery.- Returns:
- The number of button groups in
this
in-ribbon gallery.
-
getButtonGroup
Returns the list of buttons in the specifed button group.- Parameters:
buttonGroupName
- Button group name.- Returns:
- The list of buttons in the specifed button group.
-
getButtonCount
public int getButtonCount()Returns the number of gallery buttons inthis
in-ribbon gallery.- Returns:
- The number of gallery buttons in
this
in-ribbon gallery.
-
getButtonAt
Returns the gallery button at specified index.- Parameters:
index
- Gallery button index.- Returns:
- Gallery button at specified index.
-
getSelectedButton
Returns the currently selected gallery button.- Returns:
- The currently selected gallery button.
-
setSelectedButton
Sets new value for the currently selected gallery button.- Parameters:
selectedButton
- New value for the currently selected gallery button.
-
getPopupButtonPanel
Returns the associated popup gallery.- Returns:
- The associated popup gallery.
-
setShowingPopupPanel
public void setShowingPopupPanel(boolean isShowingPopupPanel) Sets indication whether the popup panel is showing.- Parameters:
isShowingPopupPanel
- Indication whether the popup panel is showing.
-
isShowingPopupPanel
public boolean isShowingPopupPanel()Returns indication whether the popup panel is showing.- Returns:
true
if the popup panel is showing,false
otherwise.
-
setGroupMapping
Sets the button groups for this ribbon gallery.- Parameters:
buttons
- Button groups.
-
addRibbonGalleryButtons
Adds toggle command buttons to the specified button group in this ribbon gallery.- Parameters:
buttonGroupName
- Button group name.buttons
- Toggle command buttons to add to the specified button group.
-
removeRibbonGalleryButtons
Removes the specified toggle command buttons from this ribbon gallery.- Parameters:
buttons
- Toggle command buttons to remove from this gallery.
-
setPreferredPopupPanelDimension
public void setPreferredPopupPanelDimension(int preferredPopupMaxButtonColumns, int preferredPopupMaxVisibleButtonRows) Sets the preferred dimension of the popup panel.- Parameters:
preferredPopupMaxButtonColumns
- Preferred maximum number of button columns for the popup panel.preferredPopupMaxVisibleButtonRows
- Preferred maximum number of visible button rows for the popup panel.
-
setPopupCallback
-
getPopupCallback
-
getPreferredPopupMaxButtonColumns
public int getPreferredPopupMaxButtonColumns() -
getPreferredPopupMaxVisibleButtonRows
public int getPreferredPopupMaxVisibleButtonRows() -
setExpandKeyTip
-
getExpandKeyTip
-
getButtonDisplayState
-
setButtonDisplayState
-