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

Class BasicRibbonUI

java.lang.Object

javax.swing.plaf.ComponentUI

org.pushingpixels.flamingo.internal.ui.ribbon.RibbonUI

org.pushingpixels.flamingo.internal.ui.ribbon.BasicRibbonUI

Direct Known Subclasses:

SubstanceRibbonUI

public abstract class BasicRibbonUI
extends RibbonUI

Basic UI for ribbon JRibbon.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BasicRibbonUI.BandHostPopupPanel
protected class	BasicRibbonUI.TaskToggleButtonsHostPanel

Field Summary

Fields

Modifier and Type	Field	Description
protected java.awt.Container	anchoredButtons
protected JRibbonApplicationMenuButton	applicationMenuButton
protected JScrollablePanel<javax.swing.JPanel>	bandScrollablePanel
protected java.beans.PropertyChangeListener	propertyChangeListener	Property change listener.
protected JRibbon	ribbon	The associated ribbon.
protected javax.swing.event.ChangeListener	ribbonChangeListener	Change listener.
protected java.awt.event.ComponentListener	ribbonComponentListener
protected CommandToggleButtonGroup	taskToggleButtonGroup	Button group for task toggle buttons.
protected java.util.Map<RibbonTask,JRibbonTaskToggleButton>	taskToggleButtons	Map of toggle buttons of all tasks.
protected JScrollablePanel<BasicRibbonUI.TaskToggleButtonsHostPanel>	taskToggleButtonsScrollablePanel

Constructor Summary

Constructors

Constructor	Description
BasicRibbonUI()	Creates a new basic ribbon UI delegate.

Method Summary

Modifier and Type	Method	Description
protected java.awt.LayoutManager	createBandHostPanelLayoutManager()
protected java.awt.LayoutManager	createLayoutManager()	Invoked by installUI to create a layout manager object to manage the JRibbon.
protected abstract BasicRibbonUI.TaskToggleButtonsHostPanel	createTaskToggleButtonsHostPanel()
protected java.awt.LayoutManager	createTaskToggleButtonsHostPanelLayoutManager()
java.util.List<JCommandButton>	getAnchoredCommandButtons()
JRibbonApplicationMenuButton	getApplicationMenuButton()
protected int	getBandGap()	Returns the layout gap for the bands in the associated ribbon.
java.awt.Rectangle	getContextualTaskGroupBounds(RibbonContextualTaskGroup group)	Returns the bounds of the specified contextual task group.
protected java.util.List<RibbonTask>	getCurrentlyShownRibbonTasks()	Returns the list of currently shown ribbon tasks.
protected int	getTabButtonGap()	Returns the layout gap for the tab buttons in the associated ribbon.
abstract int	getTaskbarHeight()	Returns the height of the taskbar area.
abstract int	getTaskToggleButtonHeight()	Returns the height of the task toggle button area.
java.util.Map<RibbonTask,JRibbonTaskToggleButton>	getTaskToggleButtons()
void	handleMouseWheelEvent(java.awt.event.MouseWheelEvent e)
protected void	installComponents()	Installs subcomponents on the associated ribbon.
protected void	installDefaults()	Installs defaults on the associated ribbon.
protected void	installListeners()	Installs listeners on the associated ribbon.
void	installUI(javax.swing.JComponent c)
boolean	isShowingScrollsForTaskToggleButtons()
void	paint(java.awt.Graphics g, javax.swing.JComponent c)
protected abstract void	paintBackground(java.awt.Graphics g)	Paints the ribbon background.
protected abstract void	paintMinimizedRibbonSeparator(java.awt.Graphics g)
protected void	scrollAndRevealTaskToggleButton(JRibbonTaskToggleButton taskToggleButton)
protected abstract void	syncApplicationMenuTips()
protected void	syncRibbonState()
protected void	syncSelectedTask()
protected void	uninstallComponents()	Uninstalls subcomponents from the associated ribbon.
protected void	uninstallDefaults()	Uninstalls defaults from the associated ribbon.
protected void	uninstallListeners()	Uninstalls listeners from the associated ribbon.
void	uninstallUI(javax.swing.JComponent c)
void	update(java.awt.Graphics g, javax.swing.JComponent c)

Methods inherited from class javax.swing.plaf.ComponentUI

contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ribbon

protected JRibbon ribbon

The associated ribbon.

bandScrollablePanel

protected JScrollablePanel<javax.swing.JPanel> bandScrollablePanel

taskToggleButtonsScrollablePanel

protected JScrollablePanel<BasicRibbonUI.TaskToggleButtonsHostPanel> taskToggleButtonsScrollablePanel

applicationMenuButton

protected JRibbonApplicationMenuButton applicationMenuButton

anchoredButtons

protected java.awt.Container anchoredButtons

taskToggleButtons

protected java.util.Map<RibbonTask,JRibbonTaskToggleButton> taskToggleButtons

Map of toggle buttons of all tasks.

taskToggleButtonGroup

protected CommandToggleButtonGroup taskToggleButtonGroup

Button group for task toggle buttons.

ribbonChangeListener

protected javax.swing.event.ChangeListener ribbonChangeListener

Change listener.

propertyChangeListener

protected java.beans.PropertyChangeListener propertyChangeListener

Property change listener.

ribbonComponentListener

protected java.awt.event.ComponentListener ribbonComponentListener

Constructor Detail

BasicRibbonUI

public BasicRibbonUI()

Creates a new basic ribbon UI delegate.

Method Detail

installUI

public void installUI(javax.swing.JComponent c)

Overrides:

installUI in class javax.swing.plaf.ComponentUI

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Overrides:

uninstallUI in class javax.swing.plaf.ComponentUI

installListeners

protected void installListeners()

Installs listeners on the associated ribbon.

uninstallListeners

protected void uninstallListeners()

Uninstalls listeners from the associated ribbon.

installDefaults

protected void installDefaults()

Installs defaults on the associated ribbon.

uninstallDefaults

protected void uninstallDefaults()

Uninstalls defaults from the associated ribbon.

installComponents

protected void installComponents()

Installs subcomponents on the associated ribbon.

getApplicationMenuButton

public JRibbonApplicationMenuButton getApplicationMenuButton()

Specified by:

getApplicationMenuButton in class RibbonUI

createTaskToggleButtonsHostPanelLayoutManager

protected java.awt.LayoutManager createTaskToggleButtonsHostPanelLayoutManager()

createTaskToggleButtonsHostPanel

protected abstract BasicRibbonUI.TaskToggleButtonsHostPanel createTaskToggleButtonsHostPanel()

createBandHostPanelLayoutManager

protected java.awt.LayoutManager createBandHostPanelLayoutManager()

uninstallComponents

protected void uninstallComponents()

Uninstalls subcomponents from the associated ribbon.

update

public void update(java.awt.Graphics g,
                   javax.swing.JComponent c)

Overrides:

update in class javax.swing.plaf.ComponentUI

paint

public void paint(java.awt.Graphics g,
                  javax.swing.JComponent c)

Overrides:

paint in class javax.swing.plaf.ComponentUI

paintMinimizedRibbonSeparator

protected abstract void paintMinimizedRibbonSeparator(java.awt.Graphics g)

paintBackground

protected abstract void paintBackground(java.awt.Graphics g)

Paints the ribbon background.

Parameters:

g - Graphics context.

getContextualTaskGroupBounds

public java.awt.Rectangle getContextualTaskGroupBounds(RibbonContextualTaskGroup group)

Description copied from class: RibbonUI

Returns the bounds of the specified contextual task group.

Specified by:

getContextualTaskGroupBounds in class RibbonUI

Parameters:

group - Contextual task group.

Returns:

The bounds of the specified contextual task group.

getBandGap

protected int getBandGap()

Returns the layout gap for the bands in the associated ribbon.

Returns:

The layout gap for the bands in the associated ribbon.

getTabButtonGap

protected int getTabButtonGap()

Returns the layout gap for the tab buttons in the associated ribbon.

Returns:

The layout gap for the tab buttons in the associated ribbon.

createLayoutManager

protected java.awt.LayoutManager createLayoutManager()

Invoked by installUI to create a layout manager object to manage the JRibbon.

Returns:

a layout manager object

getTaskbarHeight

public abstract int getTaskbarHeight()

Returns the height of the taskbar area.

Returns:

The height of the taskbar area.

getTaskToggleButtonHeight

public abstract int getTaskToggleButtonHeight()

Returns the height of the task toggle button area.

Returns:

The height of the task toggle button area.

syncSelectedTask

protected void syncSelectedTask()

syncRibbonState

protected void syncRibbonState()

getCurrentlyShownRibbonTasks

protected java.util.List<RibbonTask> getCurrentlyShownRibbonTasks()

Returns the list of currently shown ribbon tasks. This method is for internal use only.

Returns:

The list of currently shown ribbon tasks.

syncApplicationMenuTips

protected abstract void syncApplicationMenuTips()

isShowingScrollsForTaskToggleButtons

public boolean isShowingScrollsForTaskToggleButtons()

Specified by:

isShowingScrollsForTaskToggleButtons in class RibbonUI

getTaskToggleButtons

public java.util.Map<RibbonTask,JRibbonTaskToggleButton> getTaskToggleButtons()

getAnchoredCommandButtons

public java.util.List<JCommandButton> getAnchoredCommandButtons()

handleMouseWheelEvent

public void handleMouseWheelEvent(java.awt.event.MouseWheelEvent e)

Specified by:

handleMouseWheelEvent in class RibbonUI

scrollAndRevealTaskToggleButton

protected void scrollAndRevealTaskToggleButton(JRibbonTaskToggleButton taskToggleButton)