# Serialized Form

## Package org.pushingpixels.flamingo.api.bcb

### Exception Class org.pushingpixels.flamingo.api.bcb.BreadcrumbBarException

class BreadcrumbBarException extends RuntimeException implements Serializable

### Class org.pushingpixels.flamingo.api.bcb.JBreadcrumbBar

class JBreadcrumbBar extends JComponent implements Serializable

serialVersionUID:
  3258407339731400502L

#### Serialized Fields

##### callback

    BreadcrumbBarCallBack<T> callback

Application callback. Used to retrieve choices for the activated selector.

##### exceptionHandlers

    List<BreadcrumbBarExceptionHandler> exceptionHandlers

List of registered exception handlers.

##### model

    BreadcrumbBarModel<T> model

The breadcrumb bar model.

## Package org.pushingpixels.flamingo.api.bcb.core

### Class org.pushingpixels.flamingo.api.bcb.core.BreadcrumbFileSelector

class BreadcrumbFileSelector extends JBreadcrumbBar<File> implements Serializable

#### Serialized Fields

##### useNativeIcons

    boolean useNativeIcons

If `true`, the path selectors will use native icons.

### Class org.pushingpixels.flamingo.api.bcb.core.BreadcrumbTreeAdapterSelector

class BreadcrumbTreeAdapterSelector extends JBreadcrumbBar<Object> implements Serializable

## Package org.pushingpixels.flamingo.api.common

### Class org.pushingpixels.flamingo.api.common.AbstractCommandButton

class AbstractCommandButton extends RichToolTipManager.JTrackableComponent implements Serializable

#### Serialized Fields

##### actionHandler

    org.pushingpixels.flamingo.api.common.AbstractCommandButton.ActionHandler actionHandler

Action handler for the button.

##### actionKeyTip

    String actionKeyTip

Key tip for the action area.

See Also:
  - `AbstractCommandButton.setActionKeyTip(String)`
  - `AbstractCommandButton.getActionKeyTip()`

##### actionModel

    ActionButtonModel actionModel

The button action model.

See Also:
  - `AbstractCommandButton.getActionModel()`
  - `AbstractCommandButton.setActionModel(ActionButtonModel)`

##### actionRichTooltip

    RichTooltip actionRichTooltip

Rich tooltip for the action area.

See Also:
  - `AbstractCommandButton.setActionRichTooltip(RichTooltip)`
  - `AbstractCommandButton.getRichTooltip(MouseEvent)`

##### customDimension

    int customDimension

The dimension of the icon of the associated command button in the `CommandButtonDisplayState.FIT_TO_ICON` state.

See Also:
  - `AbstractCommandButton.getCustomDimension()`
  - `AbstractCommandButton.updateCustomDimension(int)`

##### disabledIcon

    ResizableIcon disabledIcon

Associated disabled icon.

See Also:
  - `AbstractCommandButton.setDisabledIcon(ResizableIcon)`
  - `AbstractCommandButton.getDisabledIcon()`

##### displayState

    CommandButtonDisplayState displayState

Current display state of `this` button.

See Also:
  - `AbstractCommandButton.setDisplayState(CommandButtonDisplayState)`
  - `AbstractCommandButton.getDisplayState()`

##### extraText

    String extraText

Additional text. This is shown for `CommandButtonDisplayState.TILE` .

See Also:
  - `AbstractCommandButton.setExtraText(String)`
  - `AbstractCommandButton.getExtraText()`

##### hgapScaleFactor

    double hgapScaleFactor

Scale factor for horizontal gaps.

See Also:
  - `AbstractCommandButton.setHGapScaleFactor(double)`
  - `AbstractCommandButton.getHGapScaleFactor()`

##### horizontalAlignment

    int horizontalAlignment

Horizontal alignment of the content.

See Also:
  - `AbstractCommandButton.setHorizontalAlignment(int)`
  - `AbstractCommandButton.getHorizontalAlignment()`

##### icon

    ResizableIcon icon

Associated icon.

See Also:
  - `AbstractCommandButton.setIcon(ResizableIcon)`
  - `AbstractCommandButton.getIcon()`

##### isFlat

    boolean isFlat

Indication whether this button is flat.

See Also:
  - `AbstractCommandButton.setFlat(boolean)`
  - `AbstractCommandButton.isFlat()`

##### locationOrderKind

    AbstractCommandButton.CommandButtonLocationOrderKind locationOrderKind

Location order kind for buttons placed in command button strips or for buttons that need the visuals of segmented strips.

See Also:
  - `AbstractCommandButton.setLocationOrderKind(CommandButtonLocationOrderKind)`
  - `AbstractCommandButton.getLocationOrderKind()`

##### text

    String text

The button text.

See Also:
  - `AbstractCommandButton.setText(String)`
  - `AbstractCommandButton.getText()`

##### vgapScaleFactor

    double vgapScaleFactor

Scale factor for vertical gaps.

See Also:
  - `AbstractCommandButton.setVGapScaleFactor(double)`
  - `AbstractCommandButton.getVGapScaleFactor()`

### Class org.pushingpixels.flamingo.api.common.AbstractFileViewPanel

class AbstractFileViewPanel extends JCommandButtonPanel implements Serializable

#### Serialized Fields

##### buttonMap

    Map<String,JCommandButton> buttonMap

Maps from file name to the buttons.

##### loadedSet

    Set<JCommandButton> loadedSet

Contains the buttons with completely loaded images.

##### mainWorker

    SwingWorker<Void,AbstractFileViewPanel.Leaf> mainWorker

The main worker that loads the images off EDT.

##### progressListener

    ProgressListener progressListener

Progress listener to report back on loaded images.

### Class org.pushingpixels.flamingo.api.common.CommandToggleButtonGroup

class CommandToggleButtonGroup extends Object implements Serializable

#### Serialized Fields

##### allowsClearingSelection

    boolean allowsClearingSelection

If `false`, the selection cannot be cleared. By default the button group allows clearing the selection in `CommandToggleButtonGroup.clearSelection()` or `CommandToggleButtonGroup.setSelected(JCommandToggleButton, boolean)` (passing the currently selected button and `false`).

##### buttons

    Vector<JCommandToggleButton> buttons

Contains all group buttons.

##### changeSupport

    PropertyChangeSupport changeSupport

Property change support to track the registered property change listeners.

##### modelChangeListeners

    Map<JCommandToggleButton,ChangeListener> modelChangeListeners

Map of registered model change listeners.

##### selection

    JCommandToggleButton selection

The currently selected button. Can be `null`.

### Class org.pushingpixels.flamingo.api.common.JCommandButton

class JCommandButton extends AbstractCommandButton implements Serializable

#### Serialized Fields

##### autoRepeatInitialInterval

    int autoRepeatInitialInterval

The initial interval for invoking the registered action listeners in the auto-repeat action mode.

See Also:
  - `JCommandButton.isAutoRepeatAction`
  - `JCommandButton.autoRepeatSubsequentInterval`
  - `JCommandButton.getAutoRepeatInitialInterval()`
  - `JCommandButton.setAutoRepeatActionIntervals(int, int)`

##### autoRepeatSubsequentInterval

    int autoRepeatSubsequentInterval

The subsequent interval for invoking the registered action listeners in the auto-repeat action mode.

See Also:
  - `JCommandButton.isAutoRepeatAction`
  - `JCommandButton.autoRepeatInitialInterval`
  - `JCommandButton.getAutoRepeatSubsequentInterval()`
  - `JCommandButton.setAutoRepeatActionIntervals(int, int)`

##### commandButtonKind

    JCommandButton.CommandButtonKind commandButtonKind

The command button kind of this button.

See Also:
  - `JCommandButton.setCommandButtonKind(CommandButtonKind)`
  - `JCommandButton.getCommandButtonKind()`

##### isAutoRepeatAction

    boolean isAutoRepeatAction

Indicates the auto-repeat action mode. When the button is not in the auto-repeat action mode, the registered action listeners are activated when the mouse is released (just as with the base `AbstractButton` ). When the button is in auto-repeat mode, the registered action listeners are activated when the mouse is pressed. In addition, if the mouse is still pressed after `JCommandButton.getAutoRepeatInitialInterval()`, the action listeners will be activated every `JCommandButton.getAutoRepeatSubsequentInterval()` until the button is disabled or the mouse is released.

See Also:
  - `JCommandButton.autoRepeatInitialInterval`
  - `JCommandButton.autoRepeatSubsequentInterval`
  - `JCommandButton.setAutoRepeatAction(boolean)`
  - `JCommandButton.isAutoRepeatAction()`

##### isFireActionOnRollover

    boolean isFireActionOnRollover

Indicates that rollover should result in firing the action. Used in conjunction with the `JCommandButton.isAutoRepeatAction` can model quick pan buttons such as breadcrumb bar scrollers.

See Also:
  - `JCommandButton.setFireActionOnRollover(boolean)`
  - `JCommandButton.isFireActionOnRollover()`

##### popupCallback

    PopupPanelCallback popupCallback

Associated popup callback. May be `null`.

See Also:
  - `JCommandButton.setPopupCallback(PopupPanelCallback)`
  - `JCommandButton.getPopupCallback()`

##### popupHandler

    org.pushingpixels.flamingo.api.common.JCommandButton.PopupHandler popupHandler

Default popup handler for this button.

##### popupKeyTip

    String popupKeyTip

Key tip for the popup area of this button.

See Also:
  - `JCommandButton.setPopupKeyTip(String)`
  - `JCommandButton.getPopupKeyTip()`

##### popupModel

    PopupButtonModel popupModel

Popup model of this button.

See Also:
  - `JCommandButton.setPopupModel(PopupButtonModel)`
  - `JCommandButton.getPopupModel()`

##### popupOrientationKind

    JCommandButton.CommandButtonPopupOrientationKind popupOrientationKind

The popup orientation kind of this button.

See Also:
  - `JCommandButton.setPopupOrientationKind(CommandButtonPopupOrientationKind)`
  - `JCommandButton.getPopupOrientationKind()`

##### popupRichTooltip

    RichTooltip popupRichTooltip

Rich tooltip for the popup area of this button.

See Also:
  - `JCommandButton.setPopupRichTooltip(RichTooltip)`
  - `JCommandButton.getRichTooltip(MouseEvent)`

### Class org.pushingpixels.flamingo.api.common.JCommandButtonPanel

class JCommandButtonPanel extends JPanel implements Serializable

#### Serialized Fields

##### buttonGroup

    CommandToggleButtonGroup buttonGroup

The button group for the single selection mode.

##### buttons

    List<List<AbstractCommandButton>> buttons

List of all button groups.

See Also:
  - `JCommandButtonPanel.getGroupCount()`
  - `JCommandButtonPanel.getGroupButtons(int)`

##### currDimension

    int currDimension

Current icon dimension.

##### currState

    CommandButtonDisplayState currState

Current icon state.

##### groupTitles

    List<String> groupTitles

List of titles for all button groups.

See Also:
  - `JCommandButtonPanel.getGroupCount()`
  - `JCommandButtonPanel.getGroupTitleAt(int)`

##### isSingleSelectionMode

    boolean isSingleSelectionMode

Indicates the selection mode for the `JCommandToggleButton` in this panel.

See Also:
  - `JCommandButtonPanel.setSingleSelectionMode(boolean)`

##### layoutKind

    JCommandButtonPanel.LayoutKind layoutKind

Layout kind of this button panel.

See Also:
  - `JCommandButtonPanel.getLayoutKind()`
  - `JCommandButtonPanel.setLayoutKind(LayoutKind)`

##### maxButtonColumns

    int maxButtonColumns

Maximum number of columns for this panel. Relevant only when the layout kind is `JCommandButtonPanel.LayoutKind.ROW_FILL`.

See Also:
  - `JCommandButtonPanel.getMaxButtonColumns()`
  - `JCommandButtonPanel.setMaxButtonColumns(int)`

##### maxButtonRows

    int maxButtonRows

Maximum number of rows for this panel. Relevant only when the layout kind is `JCommandButtonPanel.LayoutKind.COLUMN_FILL`.

See Also:
  - `JCommandButtonPanel.getMaxButtonRows()`
  - `JCommandButtonPanel.setMaxButtonRows(int)`

##### toShowGroupLabels

    boolean toShowGroupLabels

If `true`, the panel will show group labels.

See Also:
  - `JCommandButtonPanel.setToShowGroupLabels(boolean)`
  - `JCommandButtonPanel.isToShowGroupLabels()`

### Class org.pushingpixels.flamingo.api.common.JCommandButtonStrip

class JCommandButtonStrip extends JComponent implements Serializable

#### Serialized Fields

##### displayState

    CommandButtonDisplayState displayState

Element state for the buttons in this button strip. Default state is `CommandButtonDisplayState.SMALL`.

##### hgapScaleFactor

    double hgapScaleFactor

Scale factor for horizontal gaps.

See Also:
  - `JCommandButtonStrip.setVGapScaleFactor(double)`

##### orientation

    JCommandButtonStrip.StripOrientation orientation

Orientation of `this` strip.

See Also:
  - `JCommandButtonStrip.getOrientation()`

##### vgapScaleFactor

    double vgapScaleFactor

Scale factor for vertical gaps.

See Also:
  - `JCommandButtonStrip.setVGapScaleFactor(double)`

### Class org.pushingpixels.flamingo.api.common.JCommandMenuButton

class JCommandMenuButton extends JCommandButton implements Serializable

### Class org.pushingpixels.flamingo.api.common.JCommandToggleButton

class JCommandToggleButton extends AbstractCommandButton implements Serializable

### Class org.pushingpixels.flamingo.api.common.JCommandToggleMenuButton

class JCommandToggleMenuButton extends JCommandToggleButton implements Serializable

### Class org.pushingpixels.flamingo.api.common.JScrollablePanel

class JScrollablePanel extends JPanel implements Serializable

#### Serialized Fields

##### isScrollOnRollover

    boolean isScrollOnRollover

##### scrollType

    JScrollablePanel.ScrollType scrollType

##### view

    T extends JComponent view

### Class org.pushingpixels.flamingo.api.common.ProgressEvent

class ProgressEvent extends EventObject implements Serializable

#### Serialized Fields

##### maximum

    int maximum

Maximum value of the available progress range.

##### minimum

    int minimum

Minimum value of the available progress range.

##### progress

    int progress

Current value of the progress.

### Class org.pushingpixels.flamingo.api.common.RichToolTipManager.JTrackableComponent

class JTrackableComponent extends JComponent implements Serializable

## Package org.pushingpixels.flamingo.api.common.model

### Class org.pushingpixels.flamingo.api.common.model.ActionRepeatableButtonModel

class ActionRepeatableButtonModel extends DefaultButtonModel implements Serializable

#### Serialized Fields

##### autoRepeatTimer

    Timer autoRepeatTimer

Timer for the auto-repeat action mode.

##### commandButton

    JCommandButton commandButton

The button behind the model.

##### toFireActionOnPress

    boolean toFireActionOnPress

Indication whether the action is fired on mouse press (as opposed to mouse release).

### Class org.pushingpixels.flamingo.api.common.model.ActionToggleButtonModel

class ActionToggleButtonModel extends JToggleButton.ToggleButtonModel implements Serializable

#### Serialized Fields

##### toFireActionOnPress

    boolean toFireActionOnPress

Indication whether the action is fired on mouse press (as opposed to mouse release).

## Package org.pushingpixels.flamingo.api.common.popup

### Class org.pushingpixels.flamingo.api.common.popup.JColorSelectorPopupMenu

class JColorSelectorPopupMenu extends JCommandPopupMenu implements Serializable

#### Serialized Fields

##### colorSelectorCallback

    JColorSelectorPopupMenu.ColorSelectorCallback colorSelectorCallback

##### lastColorSelectorPanel

    JColorSelectorPanel lastColorSelectorPanel

### Class org.pushingpixels.flamingo.api.common.popup.JCommandPopupMenu

class JCommandPopupMenu extends JPopupPanel implements Serializable

#### Serialized Fields

##### mainButtonPanel

    JCommandButtonPanel mainButtonPanel

The main button panel. Can be `null` if this command popup menu was created with the `JCommandPopupMenu()` constructor.

See Also:
  - `JCommandPopupMenu(JCommandButtonPanel, int, int)`
  - `JCommandPopupMenu.hasCommandButtonPanel()`
  - `JCommandPopupMenu.getMainButtonPanel()`

##### maxButtonColumns

    int maxButtonColumns

Maximum number of button columns visible in the `JCommandPopupMenu.mainButtonPanel`.

See Also:
  - `JCommandPopupMenu(JCommandButtonPanel, int, int)`
  - `JCommandPopupMenu.getMaxButtonColumns()`

##### maxVisibleButtonRows

    int maxVisibleButtonRows

Maximum number of button rows visible in the `JCommandPopupMenu.mainButtonPanel`.

See Also:
  - `JCommandPopupMenu(JCommandButtonPanel, int, int)`
  - `JCommandPopupMenu.getMaxVisibleButtonRows()`

##### maxVisibleMenuButtons

    int maxVisibleMenuButtons

Maximum number of menu items visible in this menu. If more buttons are added with the `JCommandPopupMenu.addMenuButton(JCommandMenuButton)` and `JCommandPopupMenu.addMenuButton(JCommandToggleMenuButton)` APIs, the menu part will show scroller buttons above the first and below the last menu button. If the value is negative, there is no limitation on how many menu buttons are shown, and the entire popup menu can overflow the monitor edges.

##### menuComponents

    List<Component> menuComponents

Menu components. This list holds:

- `JCommandMenuButton`s added with `JCommandPopupMenu.addMenuButton(JCommandMenuButton)`
- `JCommandToggleMenuButton`s added with `JCommandPopupMenu.addMenuButton(JCommandToggleMenuButton)`
- `JPopupMenu.Separator`s added with `JCommandPopupMenu.addMenuSeparator()`
- `JPanel`s added by the subclasses with `JCommandPopupMenu.addMenuPanel(JPanel)`

See Also:
  - `JCommandPopupMenu.addMenuButton(JCommandMenuButton)`
  - `JCommandPopupMenu.addMenuButton(JCommandToggleMenuButton)`
  - `JCommandPopupMenu.addMenuSeparator()`
  - `JCommandPopupMenu.addMenuPanel(JPanel)`
  - `JCommandPopupMenu.getMenuComponents()`

##### toDismissOnChildClick

    boolean toDismissOnChildClick

### Class org.pushingpixels.flamingo.api.common.popup.JPopupPanel

class JPopupPanel extends JPanel implements Serializable

#### Serialized Fields

##### customizer

    JPopupPanel.PopupPanelCustomizer customizer

The customizer for this popup panel. Can be `null`.

See Also:
  - `JPopupPanel.getCustomizer()`
  - `JPopupPanel.setCustomizer(PopupPanelCustomizer)`

### Class org.pushingpixels.flamingo.api.common.popup.PopupPanelManager.PopupEvent

class PopupEvent extends ComponentEvent implements Serializable

#### Serialized Fields

##### popupOriginator

    JComponent popupOriginator

The popup originator component.

## Package org.pushingpixels.flamingo.api.ribbon

### Class org.pushingpixels.flamingo.api.ribbon.AbstractRibbonBand

class AbstractRibbonBand extends JComponent implements Serializable

#### Serialized Fields

##### collapsedStateKeyTip

    String collapsedStateKeyTip

The key tip for the collapsed button which is shown when there is not enough horizontal space to show the ribbon band content under the most restrictive resize policy. The collapsed button itself is implemented as a part of the UI delegate in `BasicRibbonBandUI`.

See Also:
  - `AbstractRibbonBand.setCollapsedStateKeyTip(String)`
  - `AbstractRibbonBand.getCollapsedStateKeyTip()`

##### controlPanel

    T extends AbstractBandControlPanel controlPanel

Band control panel. When there is not enough horizontal space to show this panel under the smallest resize setting, the control panel is hidden and a collapsed button is shown. When this collapsed button is activated, it shows the `AbstractRibbonBand.popupRibbonBand` in a popup panel. The collapsed button itself is implemented as a part of the UI delegate in `BasicRibbonBandUI`.

See Also:
  - `AbstractRibbonBand.popupRibbonBand`
  - `AbstractRibbonBand.icon`

##### currResizePolicy

    RibbonBandResizePolicy currResizePolicy

The current resize policy for this band. Must be one of the policies in the `AbstractRibbonBand.resizePolicies` list.

See Also:
  - `AbstractRibbonBand.resizePolicies`
  - `AbstractRibbonBand.setCurrentResizePolicy(RibbonBandResizePolicy)`
  - `AbstractRibbonBand.getCurrentResizePolicy()`

##### expandActionListener

    ActionListener expandActionListener

Optional `expand` action listener. If present, the title pane shows button with plus sign. The action listener on the button will be `this` listener.

See Also:
  - `AbstractRibbonBand.getExpandActionListener()`
  - `AbstractRibbonBand(String, ResizableIcon, ActionListener, AbstractBandControlPanel)`

##### expandButtonKeyTip

    String expandButtonKeyTip

The key tip for the ribbon band expand button. Is relevant only when `AbstractRibbonBand.expandActionListener` is not `null`.

See Also:
  - `AbstractRibbonBand.setExpandButtonKeyTip(String)`
  - `AbstractRibbonBand.getExpandButtonKeyTip()`

##### expandButtonRichTooltip

    RichTooltip expandButtonRichTooltip

The rich tooltip for the ribbon band expand button. Is relevant only when `AbstractRibbonBand.expandActionListener` is not `null`.

See Also:
  - `AbstractRibbonBand.setExpandButtonRichTooltip(RichTooltip)`
  - `AbstractRibbonBand.getExpandButtonRichTooltip()`

##### icon

    ResizableIcon icon

Icon for the collapsed state. Is set on the button that represents the collapsed state of this band. The collapsed button itself is implemented as a part of the UI delegate in `BasicRibbonBandUI`.

See Also:
  - `AbstractRibbonBand.getIcon()`
  - `AbstractRibbonBand.setIcon(ResizableIcon)`

##### popupRibbonBand

    AbstractRibbonBand popupRibbonBand

Ribbon band shown in a popup panel when this ribbon band is in a collapsed state.

See Also:
  - `AbstractRibbonBand.controlPanel`
  - `AbstractRibbonBand.getPopupRibbonBand()`
  - `AbstractRibbonBand.setPopupRibbonBand(AbstractRibbonBand)`

##### resizePolicies

    List<RibbonBandResizePolicy> resizePolicies

The list of available resize policies.

See Also:
  - `AbstractRibbonBand.currResizePolicy`
  - `AbstractRibbonBand.setResizePolicies(List)`
  - `AbstractRibbonBand.getResizePolicies()`
  - `AbstractRibbonBand.getCurrentResizePolicy()`

##### ribbonTask

    RibbonTask ribbonTask

The ribbon task of this ribbon band.

##### title

    String title

Band title.

See Also:
  - `AbstractRibbonBand.getTitle()`
  - `AbstractRibbonBand.setTitle(String)`

### Class org.pushingpixels.flamingo.api.ribbon.JFlowRibbonBand

class JFlowRibbonBand extends AbstractRibbonBand<JFlowBandControlPanel> implements Serializable

### Class org.pushingpixels.flamingo.api.ribbon.JRibbon

class JRibbon extends JComponent implements Serializable

#### Serialized Fields

##### applicationIcon

    ResizableIcon applicationIcon

The application icon. This is displayed in the application menu button.

##### applicationMenu

    RibbonApplicationMenu applicationMenu

The application menu.

See Also:
  - `JRibbon.setApplicationMenu(RibbonApplicationMenu)`
  - `JRibbon.getApplicationMenu()`

##### applicationMenuKeyTip

    String applicationMenuKeyTip

The key tip of `JRibbon.applicationMenu` button.

See Also:
  - `JRibbon.applicationMenu`
  - `JRibbon.setApplicationMenuKeyTip(String)`
  - `JRibbon.getApplicationMenuKeyTip()`

##### applicationMenuRichTooltip

    RichTooltip applicationMenuRichTooltip

The rich tooltip of `JRibbon.applicationMenu` button.

See Also:
  - `JRibbon.applicationMenu`
  - `JRibbon.setApplicationMenuRichTooltip(RichTooltip)`
  - `JRibbon.getApplicationMenuRichTooltip()`

##### contextualTaskGroups

    List<RibbonContextualTaskGroup> contextualTaskGroups

The contextual task groups.

See Also:
  - `JRibbon.addContextualTaskGroup(RibbonContextualTaskGroup)`
  - `JRibbon.setVisible(RibbonContextualTaskGroup, boolean)`
  - `JRibbon.isVisible(RibbonContextualTaskGroup)`
  - `JRibbon.getContextualTaskGroupCount()`
  - `JRibbon.getContextualTaskGroup(int)`

##### currentlySelectedTask

    RibbonTask currentlySelectedTask

Currently selected (shown) task.

##### groupVisibilityMap

    Map<RibbonContextualTaskGroup,Boolean> groupVisibilityMap

Visibility status of the contextual task group. Must contain a value for each group in `JRibbon.contextualTaskGroups`.

See Also:
  - `JRibbon.setVisible(RibbonContextualTaskGroup, boolean)`
  - `JRibbon.isVisible(RibbonContextualTaskGroup)`

##### helpActionListener

    ActionListener helpActionListener

When the `JRibbon.helpIcon` is not `null`, this listener will be invoked when the user activates the help button.

See Also:
  - `JRibbon.configureHelp(ResizableIcon, ActionListener)`
  - `JRibbon.getHelpActionListener()`

##### helpIcon

    ResizableIcon helpIcon

Help icon. When not `null`, the ribbon will display a help button at the far right of the tab area.

See Also:
  - `JRibbon.helpActionListener`
  - `JRibbon.configureHelp(ResizableIcon, ActionListener)`
  - `JRibbon.getHelpIcon()`

##### helpRichTooltip

    RichTooltip helpRichTooltip

When the `JRibbon.helpIcon` is not `null`, this rich tooltip will be shown when the user mouses over the icon.

See Also:
  - `JRibbon.setHelpRichTooltip(org.pushingpixels.flamingo.api.common.RichTooltip)`
  - `JRibbon.getHelpRichTooltip()`

##### isMinimized

    boolean isMinimized

Indicates whether the ribbon is currently minimized.

See Also:
  - `JRibbon.setMinimized(boolean)`
  - `JRibbon.isMinimized()`

##### ribbonFrame

    JRibbonFrame ribbonFrame

Deprecated.
Dropped support in order to decouple the `JRibbon` from the `JRibbonFrame`
The host ribbon frame. Is `null` when the ribbon is not hosted in a `JRibbonFrame`.

##### taskbarComponents

    List<Component> taskbarComponents

The taskbar components (to the right of the application menu button).

See Also:
  - `JRibbon.addTaskbarComponent(Component)`
  - `JRibbon.getTaskbarComponents()`
  - `JRibbon.removeTaskbarComponent(Component)`

##### tasks

    List<RibbonTask> tasks

The general tasks for this ribbon.

Tasks that get displayed based on a specific context are contextual tasks. See `JRibbon.contextualTaskGroups` for more information about contextual tasks.

See Also:
  - `JRibbon.addTask(RibbonTask)`
  - `JRibbon.getTaskCount()`
  - `JRibbon.getTask(int)`

### Class org.pushingpixels.flamingo.api.ribbon.JRibbonBand

class JRibbonBand extends AbstractRibbonBand<JBandControlPanel> implements Serializable

### Class org.pushingpixels.flamingo.api.ribbon.JRibbonComponent

class JRibbonComponent extends RichToolTipManager.JTrackableComponent implements Serializable

#### Serialized Fields

##### caption

    String caption

Wrapper caption. Can be `null`.

See Also:
  - `JRibbonComponent(ResizableIcon, String, JComponent)`

##### displayPriority

    RibbonElementPriority displayPriority

##### horizontalAlignment

    HorizontalAlignment horizontalAlignment

The horizontal alignment for this wrapper component.

See Also:
  - `JRibbonComponent.getHorizontalAlignment()`
  - `JRibbonComponent.setHorizontalAlignment(HorizontalAlignment)`

##### icon

    ResizableIcon icon

Wrapper icon. Can be `null`.

See Also:
  - `JRibbonComponent(ResizableIcon, String, JComponent)`

##### isResizingAware

    boolean isResizingAware

##### isSimpleWrapper

    boolean isSimpleWrapper

Indication whether this wrapper is simple. A simple wrapper has `null` `JRibbonComponent.icon` and `null` `JRibbonComponent.caption`.

##### keyTip

    String keyTip

The key tip for this wrapper component.

See Also:
  - `JRibbonComponent.setKeyTip(String)`
  - `JRibbonComponent.getKeyTip()`

##### mainComponent

    JComponent mainComponent

The wrapped component. Is guaranteed to be non `null`.

##### richTooltip

    RichTooltip richTooltip

The rich tooltip for this wrapper component.

See Also:
  - `JRibbonComponent.setRichTooltip(RichTooltip)`
  - `JRibbonComponent.getRichTooltip(MouseEvent)`

### Class org.pushingpixels.flamingo.api.ribbon.JRibbonFrame

class JRibbonFrame extends JFrame implements Serializable

#### Serialized Fields

##### appIcon

    ResizableIcon appIcon

##### ribbon

    JRibbon ribbon

The ribbon component.

##### setAppIconExecutor

    ExecutorService setAppIconExecutor

##### wasSetIconImagesCalled

    boolean wasSetIconImagesCalled

## Package org.pushingpixels.flamingo.internal.ui.common

### Class org.pushingpixels.flamingo.internal.ui.common.JRichTooltipPanel

class JRichTooltipPanel extends JPanel implements Serializable

#### Serialized Fields

##### tooltipInfo

    RichTooltip tooltipInfo

## Package org.pushingpixels.flamingo.internal.ui.common.popup

### Class org.pushingpixels.flamingo.internal.ui.common.popup.BasicCommandPopupMenuUI.MenuPanel

class MenuPanel extends JPanel implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.common.popup.BasicCommandPopupMenuUI.ScrollableCommandButtonPanel

class ScrollableCommandButtonPanel extends JComponent implements Serializable

#### Serialized Fields

##### buttonPanel

    JCommandButtonPanel buttonPanel

The internal panel that hosts the icon command buttons. Is hosted in the `BasicCommandPopupMenuUI.ScrollableCommandButtonPanel.scroll`.

##### maxDimension

    Dimension maxDimension

Maximum dimension of `this` popup gallery.

##### maxVisibleButtonRows

    int maxVisibleButtonRows

The maximum number of visible button rows.

##### scroll

    JScrollPane scroll

Scroll panel that hosts `BasicCommandPopupMenuUI.ScrollableCommandButtonPanel.buttonPanel`.

### Class org.pushingpixels.flamingo.internal.ui.common.popup.JColorSelectorComponent

class JColorSelectorComponent extends JComponent implements Serializable

#### Serialized Fields

##### color

    Color color

##### colorChooserCallbacks

    List<JColorSelectorPopupMenu.ColorSelectorCallback> colorChooserCallbacks

##### isBottomOpen

    boolean isBottomOpen

##### isTopOpen

    boolean isTopOpen

### Class org.pushingpixels.flamingo.internal.ui.common.popup.JColorSelectorPanel

class JColorSelectorPanel extends JPanel implements Serializable

#### Serialized Fields

##### caption

    String caption

##### colorSelectionContainer

    JPanel colorSelectionContainer

##### isLastPanel

    boolean isLastPanel

## Package org.pushingpixels.flamingo.internal.ui.ribbon

### Class org.pushingpixels.flamingo.internal.ui.ribbon.AbstractBandControlPanel

class AbstractBandControlPanel extends JPanel implements Serializable

#### Serialized Fields

##### ribbonBand

    AbstractRibbonBand ribbonBand

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonBandUI.CollapsedButtonPopupPanel

class CollapsedButtonPopupPanel extends JPopupPanel implements Serializable

#### Serialized Fields

##### component

    Component component

The main component of `this` popup panel. Can be `null`.

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonGalleryUI.ExpandCommandButton

class ExpandCommandButton extends JCommandButton implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonGalleryUI.JButtonStripUIResource

class JButtonStripUIResource extends JCommandButtonStrip implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonUI.BandHostPanel

class BandHostPanel extends JPanel implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonUI.BandHostPopupPanel

class BandHostPopupPanel extends JPopupPanel implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonUI.TaskToggleButtonsHostPanel

class TaskToggleButtonsHostPanel extends JPanel implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.JBandControlPanel

class JBandControlPanel extends AbstractBandControlPanel implements Serializable

#### Serialized Fields

##### controlPanelGroups

    LinkedList<JBandControlPanel.ControlPanelGroup> controlPanelGroups

##### galleryNameMap

    Map<String,JRibbonGallery> galleryNameMap

Maps from gallery name to gallery.

### Class org.pushingpixels.flamingo.internal.ui.ribbon.JFlowBandControlPanel

class JFlowBandControlPanel extends AbstractBandControlPanel implements Serializable

#### Serialized Fields

##### comps

    List<JComponent> comps

List of all components of `this` control panel.

### Class org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonGallery

class JRibbonGallery extends JComponent implements Serializable

#### Serialized Fields

##### buttonDisplayState

    CommandButtonDisplayState buttonDisplayState

##### buttonGroups

    List<StringValuePair<List<JCommandToggleButton>>> buttonGroups

Gallery button groups.

##### buttons

    List<JCommandToggleButton> buttons

The buttons of `this` gallery.

##### buttonSelectionGroup

    CommandToggleButtonGroup buttonSelectionGroup

Button group for ensuring that only one button is selected.

##### displayPriority

    RibbonElementPriority displayPriority

The current display priority of `this` in-ribbon gallery.

##### expandKeyTip

    String expandKeyTip

##### isShowingPopupPanel

    boolean isShowingPopupPanel

Indication whether the ribbon gallery is showing the popup panel.

##### popupCallback

    JRibbonBand.RibbonGalleryPopupCallback popupCallback

##### preferredPopupMaxButtonColumns

    int preferredPopupMaxButtonColumns

Preferred maximum number of button columns for the popup panel.

##### preferredPopupMaxVisibleButtonRows

    int preferredPopupMaxVisibleButtonRows

Preferred maximum number of visible button rows for the popup panel.

##### preferredVisibleIconCount

    Map<RibbonElementPriority,Integer> preferredVisibleIconCount

Preferred widths for each possible display state (set in the user code according to design preferences).

### Class org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonRootPane

class JRibbonRootPane extends JRootPane implements Serializable

### Class org.pushingpixels.flamingo.internal.ui.ribbon.JRibbonTaskToggleButton

class JRibbonTaskToggleButton extends JCommandToggleButton implements Serializable

#### Serialized Fields

##### contextualGroupHueColor

    Color contextualGroupHueColor

Color of the matching contextual task group. Can be `null` if the associated task is not contextual.

##### keyTip

    String keyTip

##### ribbonTask

    RibbonTask ribbonTask

## Package org.pushingpixels.flamingo.internal.ui.ribbon.appmenu

### Class org.pushingpixels.flamingo.internal.ui.ribbon.appmenu.JRibbonApplicationMenuButton

class JRibbonApplicationMenuButton extends JCommandButton implements Serializable

#### Serialized Fields

##### ribbon

    JRibbon ribbon

The application ribbon this menu button is for

### Class org.pushingpixels.flamingo.internal.ui.ribbon.appmenu.JRibbonApplicationMenuPopupPanel

class JRibbonApplicationMenuPopupPanel extends JPopupPanel implements Serializable

#### Serialized Fields

##### appMenuButton

    JRibbonApplicationMenuButton appMenuButton

##### ribbonAppMenu

    RibbonApplicationMenu ribbonAppMenu

### Class org.pushingpixels.flamingo.internal.ui.ribbon.appmenu.JRibbonApplicationMenuPopupPanelSecondary

class JRibbonApplicationMenuPopupPanelSecondary extends JCommandButtonPanel implements Serializable

## Package org.pushingpixels.flamingo.internal.utils

### Class org.pushingpixels.flamingo.internal.utils.KeyTipManager.KeyTipEvent

class KeyTipEvent extends AWTEvent implements Serializable