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

Class BasicRibbonUI

java.lang.Object

javax.swing.plaf.ComponentUI

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

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

Direct Known Subclasses:

RadianceRibbonUI

public abstract class BasicRibbonUI
extends RibbonUI

Basic UI for ribbon JRibbon.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	BasicRibbonUI.AnchoredButtonsPanelLayout
private class	BasicRibbonUI.BandHostPanelLayout	Layout for the band host panel.
private static class	BasicRibbonUI.BandHostPopupPanel
private class	BasicRibbonUI.RibbonLayout	Layout for the ribbon.
protected class	BasicRibbonUI.TaskToggleButtonsHostPanel
private class	BasicRibbonUI.TaskToggleButtonsHostPanelLayout	Layout for the band host panel.

Field Summary

Fields

Modifier and Type	Field	Description
private java.awt.Container	anchoredButtons
protected JCommandButton	applicationMenuButton
protected JScrollablePanel<javax.swing.JPanel>	bandScrollablePanel
static java.lang.String	INTERNAL
private static java.lang.String	JUST_MINIMIZED
private java.beans.PropertyChangeListener	propertyChangeListener	Property change listener.
protected JRibbon	ribbon	The associated ribbon.
private javax.swing.event.ChangeListener	ribbonChangeListener	Change listener.
private java.awt.event.ComponentListener	ribbonComponentListener
private java.util.Map<RibbonTask,PopupPanelManager.PopupListener>	taskPopupListeners
protected java.util.Map<RibbonTask,JRibbonTaskToggleButton>	taskToggleButtons	Map of toggle buttons of all tasks.
protected JScrollablePanel<BasicRibbonUI.TaskToggleButtonsHostPanel>	taskToggleButtonsScrollablePanel
private CommandToggleGroupModel	taskToggleGroupModel	Group model for task toggle buttons.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private JCommandButton	createApplicationMenuButton()
private 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()
private java.awt.LayoutManager	createTaskToggleButtonsHostPanelLayoutManager()
java.util.List<JCommandButton>	getAnchoredCommandButtons()
JCommandButton	getApplicationMenuButton()
private 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.
private 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.
java.util.Map<RibbonTask,JCommandButton>	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)
private void	processTaskSelection(RibbonTask task, JRibbonTaskToggleButton taskToggleButton)
private void	scrollAndRevealTaskToggleButton(JCommandButton taskToggleButton)
private void	syncRibbonState()
private 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

JUST_MINIMIZED

private static final java.lang.String JUST_MINIMIZED

See Also:

Constant Field Values

INTERNAL

public static final java.lang.String INTERNAL

See Also:

Constant Field Values

ribbon

protected JRibbon ribbon

The associated ribbon.

bandScrollablePanel

protected JScrollablePanel<javax.swing.JPanel> bandScrollablePanel

taskToggleButtonsScrollablePanel

protected JScrollablePanel<BasicRibbonUI.TaskToggleButtonsHostPanel> taskToggleButtonsScrollablePanel

applicationMenuButton

protected JCommandButton applicationMenuButton

anchoredButtons

private java.awt.Container anchoredButtons

taskToggleButtons

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

Map of toggle buttons of all tasks.

taskPopupListeners

private java.util.Map<RibbonTask,PopupPanelManager.PopupListener> taskPopupListeners

taskToggleGroupModel

private CommandToggleGroupModel taskToggleGroupModel

Group model for task toggle buttons.

ribbonChangeListener

private javax.swing.event.ChangeListener ribbonChangeListener

Change listener.

propertyChangeListener

private java.beans.PropertyChangeListener propertyChangeListener

Property change listener.

ribbonComponentListener

private java.awt.event.ComponentListener ribbonComponentListener

Constructor Detail

BasicRibbonUI

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

createApplicationMenuButton

private JCommandButton createApplicationMenuButton()

getApplicationMenuButton

public JCommandButton getApplicationMenuButton()

Specified by:

getApplicationMenuButton in class RibbonUI

createTaskToggleButtonsHostPanelLayoutManager

private java.awt.LayoutManager createTaskToggleButtonsHostPanelLayoutManager()

createTaskToggleButtonsHostPanel

protected abstract BasicRibbonUI.TaskToggleButtonsHostPanel createTaskToggleButtonsHostPanel()

createBandHostPanelLayoutManager

private 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

private 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

syncSelectedTask

private void syncSelectedTask()

syncRibbonState

private void syncRibbonState()

processTaskSelection

private void processTaskSelection(RibbonTask task,
                                  JRibbonTaskToggleButton taskToggleButton)

getCurrentlyShownRibbonTasks

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

isShowingScrollsForTaskToggleButtons

public boolean isShowingScrollsForTaskToggleButtons()

Specified by:

isShowingScrollsForTaskToggleButtons in class RibbonUI

getTaskToggleButtons

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

getAnchoredCommandButtons

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

handleMouseWheelEvent

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

Specified by:

handleMouseWheelEvent in class RibbonUI

scrollAndRevealTaskToggleButton

private void scrollAndRevealTaskToggleButton(JCommandButton taskToggleButton)