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

Class BasicRibbonBandUI

java.lang.Object

javax.swing.plaf.ComponentUI

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

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

Direct Known Subclasses:

RadianceRibbonBandUI

public abstract class BasicRibbonBandUI
extends RibbonBandUI

Basic UI for ribbon band JRibbonBand.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	BasicRibbonBandUI.AWTRibbonEventListener	Event listener to handle global ribbon events.
private static class	BasicRibbonBandUI.BandCollapseCommand
private static class	BasicRibbonBandUI.BandCollapseCommandButtonPresentationModel
private static class	BasicRibbonBandUI.BandCollapseCommandButtonProjection
private static class	BasicRibbonBandUI.BandCollapsePopupMenuContentModel
static class	BasicRibbonBandUI.BandCollapsePopupMenuPanel
private static class	BasicRibbonBandUI.BandCollapsePopupMenuPanelProjection
private static class	BasicRibbonBandUI.BandCollapsePopupMenuPresentationModel
private class	BasicRibbonBandUI.RibbonBandLayout	Layout for the ribbon band.

Field Summary

Fields

Modifier and Type	Field	Description
private JCommandButton	collapsedButton	The button for collapsed state.
protected JCommandButton	expandButton	The band expand button.
protected Command	expandCommand
private java.awt.event.MouseListener	mouseListener	Mouse listener on the associated ribbon band.
private java.awt.Dimension	popupContentSize
private java.beans.PropertyChangeListener	propertyChangeListener	Listens to property changes on the associated ribbon band.
protected AbstractRibbonBand	ribbonBand	The associated ribbon band.

Constructor Summary

Constructors

Constructor	Description
BasicRibbonBandUI()

Method Summary

Modifier and Type	Method	Description
protected abstract JCommandButton	createExpandButton()	Creates the expand button for the associated ribbon band.
protected abstract Command	createExpandCommand(java.awt.ComponentOrientation componentOrientation)
protected java.awt.LayoutManager	createLayoutManager()	Invoked by installUI to create a layout manager object to manage the ribbon band.
int	getPreferredCollapsedWidth()
protected void	installComponents()	Installs subcomponents on the associated ribbon band.
protected void	installDefaults()	Installs default parameters on the associated ribbon band.
protected void	installListeners()	Installs listeners on the associated ribbon band.
void	installUI(javax.swing.JComponent c)
void	paint(java.awt.Graphics g, javax.swing.JComponent c)
protected abstract void	paintBandTitle(java.awt.Graphics g, java.awt.Rectangle titleRectangle, java.lang.String title)	Paints band title pane.
protected abstract void	paintBandTrailingSeparator(java.awt.Graphics graphics, java.awt.Rectangle toFill)	Paints band background.
private void	syncCollapsedButton()
private void	syncExpandButton()
protected void	uninstallComponents()	Uninstalls components from the associated ribbon band.
protected void	uninstallDefaults()	Uninstalls default parameters from the associated ribbon band.
protected void	uninstallListeners()	Uninstalls listeners from the associated ribbon band.
void	uninstallUI(javax.swing.JComponent c)

Methods inherited from class org.pushingpixels.radiance.component.internal.ui.ribbon.RibbonBandUI

getBandTitleHeight

Methods inherited from class javax.swing.plaf.ComponentUI

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

Methods inherited from class java.lang.Object

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

Field Detail

ribbonBand

protected AbstractRibbonBand ribbonBand

The associated ribbon band.

collapsedButton

private JCommandButton collapsedButton

The button for collapsed state.

expandButton

protected JCommandButton expandButton

The band expand button. Is visible when the AbstractRibbonBand.getExpandCommandListener() of the associated ribbon band is not null.

expandCommand

protected Command expandCommand

popupContentSize

private java.awt.Dimension popupContentSize

mouseListener

private java.awt.event.MouseListener mouseListener

Mouse listener on the associated ribbon band.

propertyChangeListener

private java.beans.PropertyChangeListener propertyChangeListener

Listens to property changes on the associated ribbon band.

Constructor Detail

BasicRibbonBandUI

public BasicRibbonBandUI()

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

installDefaults

protected void installDefaults()

Installs default parameters on the associated ribbon band.

installComponents

protected void installComponents()

Installs subcomponents on the associated ribbon band.

syncExpandButton

private void syncExpandButton()

syncCollapsedButton

private void syncCollapsedButton()

createExpandButton

protected abstract JCommandButton createExpandButton()

Creates the expand button for the associated ribbon band.

Returns:

Expand button for the associated ribbon band.

createExpandCommand

protected abstract Command createExpandCommand(java.awt.ComponentOrientation componentOrientation)

installListeners

protected void installListeners()

Installs listeners on the associated ribbon band.

uninstallDefaults

protected void uninstallDefaults()

Uninstalls default parameters from the associated ribbon band.

uninstallComponents

protected void uninstallComponents()

Uninstalls components from the associated ribbon band.

uninstallListeners

protected void uninstallListeners()

Uninstalls listeners from the associated ribbon band.

createLayoutManager

protected java.awt.LayoutManager createLayoutManager()

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

Returns:

a layout manager object

paint

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

Overrides:

paint in class javax.swing.plaf.ComponentUI

paintBandTitle

protected abstract void paintBandTitle(java.awt.Graphics g,
                                       java.awt.Rectangle titleRectangle,
                                       java.lang.String title)

Paints band title pane.

Parameters:

g - Graphics context.

titleRectangle - Rectangle for the title pane.

title - Title string.

paintBandTrailingSeparator

protected abstract void paintBandTrailingSeparator(java.awt.Graphics graphics,
                                                   java.awt.Rectangle toFill)

Paints band background.

Parameters:

graphics - Graphics context.

toFill - Rectangle for the background.

getPreferredCollapsedWidth

public int getPreferredCollapsedWidth()

Specified by:

getPreferredCollapsedWidth in class RibbonBandUI