javax.swing.plaf.metal

Class MetalToolBarUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ToolBarUI

javax.swing.plaf.basic.BasicToolBarUI

javax.swing.plaf.metal.MetalToolBarUI

All Implemented Interfaces:

javax.swing.SwingConstants

public class MetalToolBarUI
extends javax.swing.plaf.basic.BasicToolBarUI

A UI delegate for the JToolBar component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MetalToolBarUI.MetalContainerListener A listener (no longer used) that responds when components are added to or removed from the JToolBar.
protected class	MetalToolBarUI.MetalDockingListener This is the MouseHandler class that allows the user to drag the JToolBar in and out of the parent and dock it if it can.
protected class	MetalToolBarUI.MetalRolloverListener A listener (no longer used) that responds to property change events in a JToolBar component.

Nested classes/interfaces inherited from class javax.swing.plaf.basic.BasicToolBarUI

javax.swing.plaf.basic.BasicToolBarUI.DockingListener, javax.swing.plaf.basic.BasicToolBarUI.DragWindow, javax.swing.plaf.basic.BasicToolBarUI.FrameListener, javax.swing.plaf.basic.BasicToolBarUI.PropertyListener, javax.swing.plaf.basic.BasicToolBarUI.ToolBarContListener, javax.swing.plaf.basic.BasicToolBarUI.ToolBarFocusListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.event.ContainerListener	contListener The container listener (an implementation specific field, according to the spec, and not used in GNU Classpath).
protected java.beans.PropertyChangeListener	rolloverListener The rollover listener (an implementation specific field, according to the spec, and not used in GNU Classpath).

Fields inherited from class javax.swing.plaf.basic.BasicToolBarUI

constraintBeforeFloating, dockingBorderColor, dockingColor, dockingListener, downKey, dragWindow, floatingBorderColor, floatingColor, focusedCompIndex, leftKey, propertyListener, rightKey, toolBar, toolBarContListener, toolBarFocusListener, upKey

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
MetalToolBarUI() Creates a new instance of this UI delegate.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.awt.event.ContainerListener	createContainerListener() Returns null as permitted by recent versions of the API specification.
protected javax.swing.event.MouseInputListener	createDockingListener() Creates and returns an instance of MetalDockingListener.
protected javax.swing.border.Border	createNonRolloverBorder() Returns a border with no rollover effect for buttons in the tool bar.
protected java.beans.PropertyChangeListener	createRolloverListener() Returns null as permitted by recent versions of the API specification.
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent component) Returns a new instance of MetalToolBarUI.
void	installUI(javax.swing.JComponent c) Installs the UI on the toolbar.
protected void	setDragOffset(java.awt.Point p) Sets the offset for the window used for dragging the toolbar.
void	uninstallUI(javax.swing.JComponent c) Uninstalls the UI from the toolbar.
void	update(java.awt.Graphics g, javax.swing.JComponent c) Paints the background of the component if necessary and then calls paint(g, c).

Methods inherited from class javax.swing.plaf.basic.BasicToolBarUI

canDock, createDragWindow, createFloatingFrame, createFloatingWindow, createFrameListener, createPropertyListener, createRolloverBorder, createToolBarContListener, createToolBarFocusListener, dragTo, floatAt, getDockingColor, getFloatingColor, getMaximumSize, getMinimumSize, installComponents, installDefaults, installKeyboardActions, installListeners, installNonRolloverBorders, installNormalBorders, installRolloverBorders, isFloating, isRolloverBorders, navigateFocusedComp, setBorderToNonRollover, setBorderToNormal, setBorderToRollover, setDockingColor, setFloating, setFloatingColor, setFloatingLocation, setOrientation, setRolloverBorders, uninstallComponents, uninstallDefaults, uninstallKeyboardActions, uninstallListeners

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getPreferredSize, paint

Methods inherited from class java.lang.Object

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

Field Detail

contListener

protected java.awt.event.ContainerListener contListener

The container listener (an implementation specific field, according to the spec, and not used in GNU Classpath).

rolloverListener

protected java.beans.PropertyChangeListener rolloverListener

The rollover listener (an implementation specific field, according to the spec, and not used in GNU Classpath).

Constructor Detail

MetalToolBarUI

public MetalToolBarUI()

Creates a new instance of this UI delegate.

Method Detail

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent component)

Returns a new instance of MetalToolBarUI.

Parameters:

component - the component for which we return an UI instance

Returns:

A new instance of MetalToolBarUI.

createRolloverListener

protected java.beans.PropertyChangeListener createRolloverListener()

Returns null as permitted by recent versions of the API specification. Originally it seems this method returned a new instance of MetalToolBarUI.MetalRolloverListener, but this is now redundant.

Returns:

null.

createContainerListener

protected java.awt.event.ContainerListener createContainerListener()

Returns null as permitted by recent versions of the API specification. Originally it seems this method returned a new instance of MetalToolBarUI.MetalContainerListener, but this is now redundant.

Returns:

null.

createNonRolloverBorder

protected javax.swing.border.Border createNonRolloverBorder()

Returns a border with no rollover effect for buttons in the tool bar.

Overrides:

createNonRolloverBorder in class javax.swing.plaf.basic.BasicToolBarUI

Returns:

A border.

See Also:

MetalBorders.getToolbarButtonBorder()

setDragOffset

protected void setDragOffset(java.awt.Point p)

Sets the offset for the window used for dragging the toolbar. It is set as long as the window is not null (it has been installed).

createDockingListener

protected javax.swing.event.MouseInputListener createDockingListener()

Creates and returns an instance of MetalDockingListener.

Overrides:

createDockingListener in class javax.swing.plaf.basic.BasicToolBarUI

Returns:

an instance of MetalDockingListener.

installUI

public void installUI(javax.swing.JComponent c)

Installs the UI on the toolbar. This calls super and sets the rollover property according to the UIManager property "ToolBar.isRollover".

Overrides:

installUI in class javax.swing.plaf.basic.BasicToolBarUI

Parameters:

c - the component to install the UI on

See Also:

ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Uninstalls the UI from the toolbar. This calls super and resets the rollover property.

Overrides:

uninstallUI in class javax.swing.plaf.basic.BasicToolBarUI

Parameters:

c - the component to uninstall the UI from

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

update

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

Paints the background of the component if necessary and then calls paint(g, c). This is overridden to implement the OceanTheme gradient when an OceanTheme is installed.

Overrides:

update in class javax.swing.plaf.ComponentUI

Parameters:

g - the graphics to use

c - the component to paint.

Since:

1.5

See Also:

ComponentUI.paint(java.awt.Graphics, javax.swing.JComponent), JComponent.paintComponent(java.awt.Graphics)