- java.lang.Object
- 
- javax.swing.plaf.ComponentUI
- 
- javax.swing.plaf.ToolBarUI
- 
- javax.swing.plaf.basic.BasicToolBarUI
 
 
 
- 
- All Implemented Interfaces:
- SwingConstants
 - Direct Known Subclasses:
- MetalToolBarUI,- SynthToolBarUI
 
 public class BasicToolBarUI extends ToolBarUI implements SwingConstants A Basic L&F implementation of ToolBarUI. This implementation is a "combined" view/controller.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description classBasicToolBarUI.DockingListenerThis class should be treated as a "protected" inner class.protected classBasicToolBarUI.DragWindowThe window which appears during dragging theJToolBar.protected classBasicToolBarUI.FrameListenerThe class listens for window events.protected classBasicToolBarUI.PropertyListenerThe class listens for property changed events.protected classBasicToolBarUI.ToolBarContListenerThe class listens for component events.protected classBasicToolBarUI.ToolBarFocusListenerThe class listens for focus events.
 - 
Field SummaryFields Modifier and Type Field Description protected StringconstraintBeforeFloatingThe layout before floating.protected ColordockingBorderColorThe color of the docking border.protected ColordockingColorThe background color of the docking border.protected MouseInputListenerdockingListenerThe instance of aMouseInputListener.protected KeyStrokedownKeyDeprecated.As of Java 2 platform v1.3.protected BasicToolBarUI.DragWindowdragWindowThe instance ofDragWindow.protected ColorfloatingBorderColorThe color of the not docking border.protected ColorfloatingColorThe background color of the not docking border.protected intfocusedCompIndexThe index of the focused component.protected KeyStrokeleftKeyDeprecated.As of Java 2 platform v1.3.protected PropertyChangeListenerpropertyListenerThe instance of aPropertyChangeListener.protected KeyStrokerightKeyDeprecated.As of Java 2 platform v1.3.protected JToolBartoolBarThe instance ofJToolBar.protected ContainerListenertoolBarContListenerThe instance of aContainerListener.protected FocusListenertoolBarFocusListenerThe instance of aFocusListener.protected KeyStrokeupKeyDeprecated.As of Java 2 platform v1.3.- 
Fields declared in interface javax.swing.SwingConstantsBOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
- 
 - 
Constructor SummaryConstructors Constructor Description BasicToolBarUI()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanDock(Component c, Point p)Returnstrueif theJToolBarcan dock at the given position.protected MouseInputListenercreateDockingListener()Returns an instance ofMouseInputListener.protected BasicToolBarUI.DragWindowcreateDragWindow(JToolBar toolbar)Returns an instance ofDragWindow.protected JFramecreateFloatingFrame(JToolBar toolbar)No longer used, use BasicToolBarUI.createFloatingWindow(JToolBar)protected RootPaneContainercreateFloatingWindow(JToolBar toolbar)Creates a window which contains the toolbar after it has been dragged out from its containerprotected WindowListenercreateFrameListener()Constructs a new instance ofWindowListener.protected BordercreateNonRolloverBorder()Creates the non rollover border for toolbar components.protected PropertyChangeListenercreatePropertyListener()Returns an instance ofPropertyChangeListener.protected BordercreateRolloverBorder()Creates a rollover border for toolbar components.protected ContainerListenercreateToolBarContListener()Returns an instance ofContainerListener.protected FocusListenercreateToolBarFocusListener()Returns an instance ofFocusListener.static ComponentUIcreateUI(JComponent c)Constructs a new instance ofBasicToolBarUI.protected voiddragTo(Point position, Point origin)The method is used to dragDragWindowduring theJToolBaris being dragged.protected voidfloatAt(Point position, Point origin)The method is called at end of dragging to place the frame in either its original place or in its floating frame.ColorgetDockingColor()Gets the color displayed when over a docking areaColorgetFloatingColor()Gets the color displayed when over a floating areaprotected BordergetNonRolloverBorder(AbstractButton b)Returns a non-rollover border for the button.protected BordergetRolloverBorder(AbstractButton b)Returns a rollover border for the button.protected voidinstallComponents()Registers components.protected voidinstallDefaults()Installs default properties.protected voidinstallKeyboardActions()Registers keyboard actions.protected voidinstallListeners()Registers listeners.protected voidinstallNonRolloverBorders(JComponent c)Installs non-rollover borders on all the child components of the JComponent.protected voidinstallNormalBorders(JComponent c)Installs normal borders on all the child components of the JComponent.protected voidinstallRolloverBorders(JComponent c)Installs rollover borders on all the child components of the JComponent.booleanisFloating()Returnstrueif theJToolBaris floatingbooleanisRolloverBorders()Returns a flag to determine whether rollover button borders are enabled.protected voidnavigateFocusedComp(int direction)Navigates the focused component.protected voidpaintDragWindow(Graphics g)Paints the contents of the window used for dragging.protected voidsetBorderToNonRollover(Component c)Sets the border of the component to have a non-rollover border which was created by thecreateNonRolloverBorder()method.protected voidsetBorderToNormal(Component c)Sets the border of the component to have a normal border.protected voidsetBorderToRollover(Component c)Sets the border of the component to have a rollover border which was created by thecreateRolloverBorder()method.voidsetDockingColor(Color c)Sets the color displayed when over a docking areavoidsetFloating(boolean b, Point p)Sets the floating property.voidsetFloatingColor(Color c)Sets the color displayed when over a floating areavoidsetFloatingLocation(int x, int y)Sets the floating location.voidsetOrientation(int orientation)Sets the tool bar's orientation.voidsetRolloverBorders(boolean rollover)Sets the flag for enabling rollover borders on the toolbar and it will also install the appropriate border depending on the state of the flag.protected voiduninstallComponents()Unregisters components.protected voiduninstallDefaults()Uninstalls default properties.protected voiduninstallKeyboardActions()Unregisters keyboard actions.protected voiduninstallListeners()Unregisters listeners.- 
Methods declared in class javax.swing.plaf.ComponentUIcontains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update
 
- 
 
- 
- 
- 
Field Detail- 
toolBarprotected JToolBar toolBar The instance ofJToolBar.
 - 
dragWindowprotected BasicToolBarUI.DragWindow dragWindow The instance ofDragWindow.
 - 
focusedCompIndexprotected int focusedCompIndex The index of the focused component.
 - 
dockingColorprotected Color dockingColor The background color of the docking border.
 - 
floatingColorprotected Color floatingColor The background color of the not docking border.
 - 
dockingBorderColorprotected Color dockingBorderColor The color of the docking border.
 - 
floatingBorderColorprotected Color floatingBorderColor The color of the not docking border.
 - 
dockingListenerprotected MouseInputListener dockingListener The instance of aMouseInputListener.
 - 
propertyListenerprotected PropertyChangeListener propertyListener The instance of aPropertyChangeListener.
 - 
toolBarContListenerprotected ContainerListener toolBarContListener The instance of aContainerListener.
 - 
toolBarFocusListenerprotected FocusListener toolBarFocusListener The instance of aFocusListener.
 - 
constraintBeforeFloatingprotected String constraintBeforeFloating The layout before floating.
 - 
upKey@Deprecated protected KeyStroke upKey Deprecated.As of Java 2 platform v1.3.As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
 - 
downKey@Deprecated protected KeyStroke downKey Deprecated.As of Java 2 platform v1.3.As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
 - 
leftKey@Deprecated protected KeyStroke leftKey Deprecated.As of Java 2 platform v1.3.As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
 - 
rightKey@Deprecated protected KeyStroke rightKey Deprecated.As of Java 2 platform v1.3.As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
 
- 
 - 
Method Detail- 
createUIpublic static ComponentUI createUI(JComponent c) Constructs a new instance ofBasicToolBarUI.- Parameters:
- c- a component
- Returns:
- a new instance of BasicToolBarUI
 
 - 
installDefaultsprotected void installDefaults() Installs default properties.
 - 
uninstallDefaultsprotected void uninstallDefaults() Uninstalls default properties.
 - 
installComponentsprotected void installComponents() Registers components.
 - 
uninstallComponentsprotected void uninstallComponents() Unregisters components.
 - 
installListenersprotected void installListeners() Registers listeners.
 - 
uninstallListenersprotected void uninstallListeners() Unregisters listeners.
 - 
installKeyboardActionsprotected void installKeyboardActions() Registers keyboard actions.
 - 
uninstallKeyboardActionsprotected void uninstallKeyboardActions() Unregisters keyboard actions.
 - 
navigateFocusedCompprotected void navigateFocusedComp(int direction) Navigates the focused component.- Parameters:
- direction- a direction
 
 - 
createRolloverBorderprotected Border createRolloverBorder() Creates a rollover border for toolbar components. The rollover border will be installed if rollover borders are enabled.Override this method to provide an alternate rollover border. - Returns:
- a rollover border for toolbar components
- Since:
- 1.4
 
 - 
createNonRolloverBorderprotected Border createNonRolloverBorder() Creates the non rollover border for toolbar components. This border will be installed as the border for components added to the toolbar if rollover borders are not enabled.Override this method to provide an alternate rollover border. - Returns:
- the non rollover border for toolbar components
- Since:
- 1.4
 
 - 
createFloatingFrameprotected JFrame createFloatingFrame(JToolBar toolbar) No longer used, use BasicToolBarUI.createFloatingWindow(JToolBar)- Parameters:
- toolbar- an instance of- JToolBar
- Returns:
- an instance of JFrame
- See Also:
- createFloatingWindow(javax.swing.JToolBar)
 
 - 
createFloatingWindowprotected RootPaneContainer createFloatingWindow(JToolBar toolbar) Creates a window which contains the toolbar after it has been dragged out from its container- Parameters:
- toolbar- an instance of- JToolBar
- Returns:
- a RootPaneContainerobject, containing the toolbar
- Since:
- 1.4
 
 - 
createDragWindowprotected BasicToolBarUI.DragWindow createDragWindow(JToolBar toolbar) Returns an instance ofDragWindow.- Parameters:
- toolbar- an instance of- JToolBar
- Returns:
- an instance of DragWindow
 
 - 
isRolloverBorderspublic boolean isRolloverBorders() Returns a flag to determine whether rollover button borders are enabled.- Returns:
- true if rollover borders are enabled; false otherwise
- Since:
- 1.4
- See Also:
- setRolloverBorders(boolean)
 
 - 
setRolloverBorderspublic void setRolloverBorders(boolean rollover) Sets the flag for enabling rollover borders on the toolbar and it will also install the appropriate border depending on the state of the flag.- Parameters:
- rollover- if true, rollover borders are installed. Otherwise non-rollover borders are installed
- Since:
- 1.4
- See Also:
- isRolloverBorders()
 
 - 
installRolloverBordersprotected void installRolloverBorders(JComponent c) Installs rollover borders on all the child components of the JComponent.This is a convenience method to call setBorderToRolloverfor each child component.- Parameters:
- c- container which holds the child components (usually a JToolBar)
- Since:
- 1.4
- See Also:
- setBorderToRollover(java.awt.Component)
 
 - 
installNonRolloverBordersprotected void installNonRolloverBorders(JComponent c) Installs non-rollover borders on all the child components of the JComponent. A non-rollover border is the border that is installed on the child component while it is in the toolbar.This is a convenience method to call setBorderToNonRolloverfor each child component.- Parameters:
- c- container which holds the child components (usually a JToolBar)
- Since:
- 1.4
- See Also:
- setBorderToNonRollover(java.awt.Component)
 
 - 
installNormalBordersprotected void installNormalBorders(JComponent c) Installs normal borders on all the child components of the JComponent. A normal border is the original border that was installed on the child component before it was added to the toolbar.This is a convenience method to call setBorderNormalfor each child component.- Parameters:
- c- container which holds the child components (usually a JToolBar)
- Since:
- 1.4
- See Also:
- setBorderToNonRollover(java.awt.Component)
 
 - 
setBorderToRolloverprotected void setBorderToRollover(Component c) Sets the border of the component to have a rollover border which was created by thecreateRolloverBorder()method.- Parameters:
- c- component which will have a rollover border installed
- Since:
- 1.4
- See Also:
- createRolloverBorder()
 
 - 
getRolloverBorderprotected Border getRolloverBorder(AbstractButton b) Returns a rollover border for the button.- Parameters:
- b- the button to calculate the rollover border for
- Returns:
- the rollover border
- Since:
- 1.6
- See Also:
- setBorderToRollover(java.awt.Component)
 
 - 
setBorderToNonRolloverprotected void setBorderToNonRollover(Component c) Sets the border of the component to have a non-rollover border which was created by thecreateNonRolloverBorder()method.- Parameters:
- c- component which will have a non-rollover border installed
- Since:
- 1.4
- See Also:
- createNonRolloverBorder()
 
 - 
getNonRolloverBorderprotected Border getNonRolloverBorder(AbstractButton b) Returns a non-rollover border for the button.- Parameters:
- b- the button to calculate the non-rollover border for
- Returns:
- the non-rollover border
- Since:
- 1.6
- See Also:
- setBorderToNonRollover(java.awt.Component)
 
 - 
setBorderToNormalprotected void setBorderToNormal(Component c) Sets the border of the component to have a normal border. A normal border is the original border that was installed on the child component before it was added to the toolbar.- Parameters:
- c- component which will have a normal border re-installed
- Since:
- 1.4
- See Also:
- createNonRolloverBorder()
 
 - 
setFloatingLocationpublic void setFloatingLocation(int x, int y)Sets the floating location.- Parameters:
- x- an X coordinate
- y- an Y coordinate
 
 - 
isFloatingpublic boolean isFloating() Returnstrueif theJToolBaris floating- Returns:
- trueif the- JToolBaris floating
 
 - 
setFloatingpublic void setFloating(boolean b, Point p)Sets the floating property.- Parameters:
- b-- trueif the- JToolBaris floating
- p- the position
 
 - 
setOrientationpublic void setOrientation(int orientation) Sets the tool bar's orientation.- Parameters:
- orientation- the new orientation
 
 - 
getDockingColorpublic Color getDockingColor() Gets the color displayed when over a docking area- Returns:
- the color displayed when over a docking area
 
 - 
setDockingColorpublic void setDockingColor(Color c) Sets the color displayed when over a docking area- Parameters:
- c- the new color
 
 - 
getFloatingColorpublic Color getFloatingColor() Gets the color displayed when over a floating area- Returns:
- the color displayed when over a floating area
 
 - 
setFloatingColorpublic void setFloatingColor(Color c) Sets the color displayed when over a floating area- Parameters:
- c- the new color
 
 - 
canDockpublic boolean canDock(Component c, Point p) Returnstrueif theJToolBarcan dock at the given position.- Parameters:
- c- a component
- p- a position
- Returns:
- trueif the- JToolBarcan dock at the given position
 
 - 
dragToprotected void dragTo(Point position, Point origin) The method is used to dragDragWindowduring theJToolBaris being dragged.- Parameters:
- position- the relative to the- JTollBarposition
- origin- the screen position of- JToolBarbefore dragging
 
 - 
floatAtprotected void floatAt(Point position, Point origin) The method is called at end of dragging to place the frame in either its original place or in its floating frame.- Parameters:
- position- the relative to the- JTollBarposition
- origin- the screen position of- JToolBarbefore dragging
 
 - 
createToolBarContListenerprotected ContainerListener createToolBarContListener() Returns an instance ofContainerListener.- Returns:
- an instance of ContainerListener
 
 - 
createToolBarFocusListenerprotected FocusListener createToolBarFocusListener() Returns an instance ofFocusListener.- Returns:
- an instance of FocusListener
 
 - 
createPropertyListenerprotected PropertyChangeListener createPropertyListener() Returns an instance ofPropertyChangeListener.- Returns:
- an instance of PropertyChangeListener
 
 - 
createDockingListenerprotected MouseInputListener createDockingListener() Returns an instance ofMouseInputListener.- Returns:
- an instance of MouseInputListener
 
 - 
createFrameListenerprotected WindowListener createFrameListener() Constructs a new instance ofWindowListener.- Returns:
- a new instance of WindowListener
 
 - 
paintDragWindowprotected void paintDragWindow(Graphics g) Paints the contents of the window used for dragging.- Parameters:
- g- Graphics to paint to.
- Throws:
- NullPointerException- is- gis null
- Since:
- 1.5
 
 
- 
 
-