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
A Basic L&F implementation of ToolBarUI. This implementation
is a "combined" view/controller.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassThis class should be treated as a "protected" inner class.protected classThe window which appears during dragging theJToolBar.protected classThe class listens for window events.protected classThe class listens for property changed events.protected classThe class listens for component events.protected classThe class listens for focus events. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe layout before floating.protected ColorThe color of the docking border.protected ColorThe background color of the docking border.protected MouseInputListenerThe instance of aMouseInputListener.protected KeyStrokeDeprecated.As of Java 2 platform v1.3.protected BasicToolBarUI.DragWindowThe instance ofDragWindow.protected ColorThe color of the not docking border.protected ColorThe background color of the not docking border.protected intThe index of the focused component.protected KeyStrokeDeprecated.As of Java 2 platform v1.3.protected PropertyChangeListenerThe instance of aPropertyChangeListener.protected KeyStrokeDeprecated.As of Java 2 platform v1.3.protected JToolBarThe instance ofJToolBar.protected ContainerListenerThe instance of aContainerListener.protected FocusListenerThe instance of aFocusListener.protected KeyStrokeDeprecated.As of Java 2 platform v1.3.Fields declared in 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 -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturnstrueif theJToolBarcan dock at the given position.protected MouseInputListenerReturns an instance ofMouseInputListener.protected BasicToolBarUI.DragWindowcreateDragWindow(JToolBar toolbar) Returns an instance ofDragWindow.protected JFramecreateFloatingFrame(JToolBar toolbar) Deprecated, for removal: This API element is subject to removal in a future version.It is recommended thatcreateFloatingWindow(JToolBar)be used insteadprotected RootPaneContainercreateFloatingWindow(JToolBar toolbar) Creates a window which contains the toolbar after it has been dragged out from its containerprotected WindowListenerConstructs a new instance ofWindowListener.protected BorderCreates the non rollover border for toolbar components.protected PropertyChangeListenerReturns an instance ofPropertyChangeListener.protected BorderCreates a rollover border for toolbar components.protected ContainerListenerReturns an instance ofContainerListener.protected FocusListenerReturns an instance ofFocusListener.static ComponentUIConstructs a new instance ofBasicToolBarUI.protected voidThe method is used to dragDragWindowduring theJToolBaris being dragged.protected voidThe method is called at end of dragging to place the frame in either its original place or in its floating frame.Gets the color displayed when over a docking areaGets the color displayed when over a floating areaprotected BorderReturns a non-rollover border for the button.protected BorderReturns a rollover border for the button.protected voidRegisters components.protected voidInstalls default properties.protected voidRegisters keyboard actions.protected voidRegisters listeners.protected voidInstalls non-rollover borders on all the child components of the JComponent.protected voidInstalls normal borders on all the child components of the JComponent.protected voidInstalls rollover borders on all the child components of the JComponent.booleanReturnstrueif theJToolBaris floatingbooleanReturns a flag to determine whether rollover button borders are enabled.protected voidnavigateFocusedComp(int direction) Navigates the focused component.protected voidPaints the contents of the window used for dragging.protected voidSets the border of the component to have a non-rollover border which was created by thecreateNonRolloverBorder()method.protected voidSets the border of the component to have a normal border.protected voidSets the border of the component to have a rollover border which was created by thecreateRolloverBorder()method.voidSets the color displayed when over a docking areavoidsetFloating(boolean b, Point p) Sets the floating property.voidSets 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 voidUnregisters components.protected voidUninstalls default properties.protected voidUnregisters keyboard actions.protected voidUnregisters listeners.Methods declared in class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update
-
Field Details
-
toolBar
The instance ofJToolBar. -
dragWindow
The instance ofDragWindow. -
focusedCompIndex
protected int focusedCompIndexThe index of the focused component. -
dockingColor
The background color of the docking border. -
floatingColor
The background color of the not docking border. -
dockingBorderColor
The color of the docking border. -
floatingBorderColor
The color of the not docking border. -
dockingListener
The instance of aMouseInputListener. -
propertyListener
The instance of aPropertyChangeListener. -
toolBarContListener
The instance of aContainerListener. -
toolBarFocusListener
The instance of aFocusListener. -
constraintBeforeFloating
The layout before floating. -
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.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.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.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.
-
-
Constructor Details
-
BasicToolBarUI
public BasicToolBarUI()Constructs aBasicToolBarUI.
-
-
Method Details
-
createUI
Constructs a new instance ofBasicToolBarUI.- Parameters:
c- a component- Returns:
- a new instance of
BasicToolBarUI
-
installDefaults
protected void installDefaults()Installs default properties. -
uninstallDefaults
protected void uninstallDefaults()Uninstalls default properties. -
installComponents
protected void installComponents()Registers components. -
uninstallComponents
protected void uninstallComponents()Unregisters components. -
installListeners
protected void installListeners()Registers listeners. -
uninstallListeners
protected void uninstallListeners()Unregisters listeners. -
installKeyboardActions
protected void installKeyboardActions()Registers keyboard actions. -
uninstallKeyboardActions
protected void uninstallKeyboardActions()Unregisters keyboard actions. -
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
-
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
-
createFloatingFrame
Deprecated, for removal: This API element is subject to removal in a future version.It is recommended thatcreateFloatingWindow(JToolBar)be used insteadNo longer used, use BasicToolBarUI.createFloatingWindow(JToolBar)- Parameters:
toolbar- an instance ofJToolBar- Returns:
- an instance of
JFrame - See Also:
-
createFloatingWindow
Creates a window which contains the toolbar after it has been dragged out from its container- Parameters:
toolbar- an instance ofJToolBar- Returns:
- a
RootPaneContainerobject, containing the toolbar - Since:
- 1.4
-
createDragWindow
Returns an instance ofDragWindow.- Parameters:
toolbar- an instance ofJToolBar- Returns:
- an instance of
DragWindow
-
isRolloverBorders
public 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
public 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:
-
installRolloverBorders
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:
-
installNonRolloverBorders
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:
-
installNormalBorders
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:
-
setBorderToRollover
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:
-
getRolloverBorder
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:
-
setBorderToNonRollover
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:
-
getNonRolloverBorder
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:
-
setBorderToNormal
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:
-
setFloatingLocation
public void setFloatingLocation(int x, int y) Sets the floating location.- Parameters:
x- an X coordinatey- an Y coordinate
-
isFloating
public boolean isFloating()Returnstrueif theJToolBaris floating- Returns:
trueif theJToolBaris floating
-
setFloating
Sets the floating property.- Parameters:
b-trueif theJToolBaris floatingp- the position
-
setOrientation
public void setOrientation(int orientation) Sets the tool bar's orientation.- Parameters:
orientation- the new orientation
-
getDockingColor
Gets the color displayed when over a docking area- Returns:
- the color displayed when over a docking area
-
setDockingColor
Sets the color displayed when over a docking area- Parameters:
c- the new color
-
getFloatingColor
Gets the color displayed when over a floating area- Returns:
- the color displayed when over a floating area
-
setFloatingColor
Sets the color displayed when over a floating area- Parameters:
c- the new color
-
canDock
Returnstrueif theJToolBarcan dock at the given position.- Parameters:
c- a componentp- a position- Returns:
trueif theJToolBarcan dock at the given position
-
dragTo
The method is used to dragDragWindowduring theJToolBaris being dragged.- Parameters:
position- the relative to theJTollBarpositionorigin- the screen position ofJToolBarbefore dragging
-
floatAt
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 theJTollBarpositionorigin- the screen position ofJToolBarbefore dragging
-
createToolBarContListener
Returns an instance ofContainerListener.- Returns:
- an instance of
ContainerListener
-
createToolBarFocusListener
Returns an instance ofFocusListener.- Returns:
- an instance of
FocusListener
-
createPropertyListener
Returns an instance ofPropertyChangeListener.- Returns:
- an instance of
PropertyChangeListener
-
createDockingListener
Returns an instance ofMouseInputListener.- Returns:
- an instance of
MouseInputListener
-
createFrameListener
Constructs a new instance ofWindowListener.- Returns:
- a new instance of
WindowListener
-
paintDragWindow
Paints the contents of the window used for dragging.- Parameters:
g- Graphics to paint to.- Throws:
NullPointerException- isgis null- Since:
- 1.5
-