- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,SwingConstants
@JavaBean(defaultProperty="UI", description="A component which displays commonly used controls or Actions.") public class JToolBar extends JComponent implements SwingConstants, Accessible
JToolBar
provides a component that is useful for
displaying commonly used Action
s or controls.
For examples and information on using tool bars see
How to Use Tool Bars,
a section in The Java Tutorial.
With most look and feels,
the user can drag out a tool bar into a separate window
(unless the floatable
property is set to false
).
For drag-out to work correctly, it is recommended that you add
JToolBar
instances to one of the four "sides" of a
container whose layout manager is a BorderLayout
,
and do not add children to any of the other four "sides".
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans™
has been added to the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
Action
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
JToolBar.AccessibleJToolBar
This class implements accessibility support for theJToolBar
class.static class
JToolBar.Separator
A toolbar-specific separator.Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
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 Constructor Description JToolBar()
Creates a new tool bar; orientation defaults toHORIZONTAL
.JToolBar(int orientation)
Creates a new tool bar with the specifiedorientation
.JToolBar(String name)
Creates a new tool bar with the specifiedname
.JToolBar(String name, int orientation)
Creates a new tool bar with a specifiedname
andorientation
. -
Method Summary
Modifier and Type Method Description JButton
add(Action a)
Adds a newJButton
which dispatches the action.protected void
addImpl(Component comp, Object constraints, int index)
If aJButton
is being added, it is initially set to be disabled.void
addSeparator()
Appends a separator of default size to the end of the tool bar.void
addSeparator(Dimension size)
Appends a separator of a specified size to the end of the tool bar.protected PropertyChangeListener
createActionChangeListener(JButton b)
Returns a properly configuredPropertyChangeListener
which updates the control as changes to theAction
occur, ornull
if the default property change listener for the control is desired.protected JButton
createActionComponent(Action a)
Factory method which creates theJButton
forAction
s added to theJToolBar
.AccessibleContext
getAccessibleContext()
Gets the AccessibleContext associated with this JToolBar.Component
getComponentAtIndex(int i)
Returns the component at the specified index.int
getComponentIndex(Component c)
Returns the index of the specified component.Insets
getMargin()
Returns the margin between the tool bar's border and its buttons.int
getOrientation()
Returns the current orientation of the tool bar.ToolBarUI
getUI()
Returns the tool bar's current UI.String
getUIClassID()
Returns the name of the L&F class that renders this component.boolean
isBorderPainted()
Gets theborderPainted
property.boolean
isFloatable()
Gets thefloatable
property.boolean
isRollover()
Returns the rollover state.protected void
paintBorder(Graphics g)
Paints the tool bar's border if theborderPainted
property istrue
.protected String
paramString()
Returns a string representation of thisJToolBar
.void
setBorderPainted(boolean b)
Sets theborderPainted
property, which istrue
if the border should be painted.void
setFloatable(boolean b)
Sets thefloatable
property, which must betrue
for the user to move the tool bar.void
setMargin(Insets m)
Sets the margin between the tool bar's border and its buttons.void
setOrientation(int o)
Sets the orientation of the tool bar.void
setRollover(boolean rollover)
Sets the rollover state of this toolbar.void
setUI(ToolBarUI ui)
Sets the L&F object that renders this component.void
updateUI()
Notification from theUIFactory
that the L&F has changed.Methods declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Methods declared in class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
Methods declared in class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
JToolBar
public JToolBar()Creates a new tool bar; orientation defaults toHORIZONTAL
. -
JToolBar
public JToolBar(int orientation)Creates a new tool bar with the specifiedorientation
. Theorientation
must be eitherHORIZONTAL
orVERTICAL
.- Parameters:
orientation
- the orientation desired
-
JToolBar
Creates a new tool bar with the specifiedname
. The name is used as the title of the undocked tool bar. The default orientation isHORIZONTAL
.- Parameters:
name
- the name of the tool bar- Since:
- 1.3
-
JToolBar
Creates a new tool bar with a specifiedname
andorientation
. All other constructors call this constructor. Iforientation
is an invalid value, an exception will be thrown.- Parameters:
name
- the name of the tool barorientation
- the initial orientation -- it must be eitherHORIZONTAL
orVERTICAL
- Throws:
IllegalArgumentException
- if orientation is neitherHORIZONTAL
norVERTICAL
- Since:
- 1.3
-
-
Method Details
-
getUI
Returns the tool bar's current UI.- Overrides:
getUI
in classJComponent
- Returns:
- the tool bar's current UI.
- See Also:
setUI(javax.swing.plaf.ToolBarUI)
-
setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(ToolBarUI ui)Sets the L&F object that renders this component.- Parameters:
ui
- theToolBarUI
L&F object- See Also:
UIDefaults.getUI(javax.swing.JComponent)
-
updateUI
public void updateUI()Notification from theUIFactory
that the L&F has changed. Called to replace the UI with the latest version from theUIFactory
.- Overrides:
updateUI
in classJComponent
- See Also:
JComponent.updateUI()
-
getUIClassID
Returns the name of the L&F class that renders this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "ToolBarUI"
- See Also:
JComponent.getUIClassID()
,UIDefaults.getUI(javax.swing.JComponent)
-
getComponentIndex
Returns the index of the specified component. (Note: Separators occupy index positions.)- Parameters:
c
- theComponent
to find- Returns:
- an integer indicating the component's position, where 0 is first
-
getComponentAtIndex
Returns the component at the specified index.- Parameters:
i
- the component's position, where 0 is first- Returns:
- the
Component
at that position, ornull
for an invalid index
-
setMargin
@BeanProperty(expert=true, description="The margin between the tool bar\'s border and contents") public void setMargin(Insets m)Sets the margin between the tool bar's border and its buttons. Setting tonull
causes the tool bar to use the default margins. The tool bar's defaultBorder
object uses this value to create the proper margin. However, if a non-default border is set on the tool bar, it is thatBorder
object's responsibility to create the appropriate margin space (otherwise this property will effectively be ignored).- Parameters:
m
- anInsets
object that defines the space between the border and the buttons- See Also:
Insets
-
getMargin
Returns the margin between the tool bar's border and its buttons.- Returns:
- an
Insets
object containing the margin values - See Also:
Insets
-
isBorderPainted
public boolean isBorderPainted()Gets theborderPainted
property.- Returns:
- the value of the
borderPainted
property - See Also:
setBorderPainted(boolean)
-
setBorderPainted
@BeanProperty(expert=true, description="Does the tool bar paint its borders?") public void setBorderPainted(boolean b)Sets theborderPainted
property, which istrue
if the border should be painted. The default value for this property istrue
. Some look and feels might not implement painted borders; they will ignore this property.- Parameters:
b
- if true, the border is painted- See Also:
isBorderPainted()
-
paintBorder
Paints the tool bar's border if theborderPainted
property istrue
.- Overrides:
paintBorder
in classJComponent
- Parameters:
g
- theGraphics
context in which the painting is done- See Also:
JComponent.paint(java.awt.Graphics)
,JComponent.setBorder(javax.swing.border.Border)
-
isFloatable
public boolean isFloatable()Gets thefloatable
property.- Returns:
- the value of the
floatable
property - See Also:
setFloatable(boolean)
-
setFloatable
@BeanProperty(preferred=true, description="Can the tool bar be made to float by the user?") public void setFloatable(boolean b)Sets thefloatable
property, which must betrue
for the user to move the tool bar. Typically, a floatable tool bar can be dragged into a different position within the same container or out into its own window. The default value of this property istrue
. Some look and feels might not implement floatable tool bars; they will ignore this property.- Parameters:
b
- iftrue
, the tool bar can be moved;false
otherwise- See Also:
isFloatable()
-
getOrientation
public int getOrientation()Returns the current orientation of the tool bar. The value is eitherHORIZONTAL
orVERTICAL
.- Returns:
- an integer representing the current orientation -- either
HORIZONTAL
orVERTICAL
- See Also:
setOrientation(int)
-
setOrientation
@BeanProperty(preferred=true, enumerationValues={"SwingConstants.HORIZONTAL","SwingConstants.VERTICAL"}, description="The current orientation of the tool bar") public void setOrientation(int o)Sets the orientation of the tool bar. The orientation must have either the valueHORIZONTAL
orVERTICAL
. Iforientation
is an invalid value, an exception will be thrown.- Parameters:
o
- the new orientation -- eitherHORIZONTAL
orVERTICAL
- Throws:
IllegalArgumentException
- if orientation is neitherHORIZONTAL
norVERTICAL
- See Also:
getOrientation()
-
setRollover
@BeanProperty(preferred=true, visualUpdate=true, description="Will draw rollover button borders in the toolbar.") public void setRollover(boolean rollover)Sets the rollover state of this toolbar. If the rollover state is true then the border of the toolbar buttons will be drawn only when the mouse pointer hovers over them. The default value of this property is false.The implementation of a look and feel may choose to ignore this property.
- Parameters:
rollover
- true for rollover toolbar buttons; otherwise false- Since:
- 1.4
-
isRollover
public boolean isRollover()Returns the rollover state.- Returns:
- true if rollover toolbar buttons are to be drawn; otherwise false
- Since:
- 1.4
- See Also:
setRollover(boolean)
-
addSeparator
public void addSeparator()Appends a separator of default size to the end of the tool bar. The default size is determined by the current look and feel. -
addSeparator
Appends a separator of a specified size to the end of the tool bar.- Parameters:
size
- theDimension
of the separator
-
add
Adds a newJButton
which dispatches the action.- Parameters:
a
- theAction
object to add as a new menu item- Returns:
- the new button which dispatches the action
-
createActionComponent
Factory method which creates theJButton
forAction
s added to theJToolBar
. The default name is empty if anull
action is passed.- Parameters:
a
- theAction
for the button to be added- Returns:
- the newly created button
- Since:
- 1.3
- See Also:
Action
-
createActionChangeListener
Returns a properly configuredPropertyChangeListener
which updates the control as changes to theAction
occur, ornull
if the default property change listener for the control is desired.- Parameters:
b
- aJButton
- Returns:
null
-
addImpl
If aJButton
is being added, it is initially set to be disabled.- Overrides:
addImpl
in classContainer
- Parameters:
comp
- the component to be enhancedconstraints
- the constraints to be enforced on the componentindex
- the index of the component- See Also:
Container.add(Component)
,Container.add(Component, int)
,Container.add(Component, java.lang.Object)
,Container.invalidate()
,LayoutManager
,LayoutManager2
-
paramString
Returns a string representation of thisJToolBar
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull
.- Overrides:
paramString
in classJComponent
- Returns:
- a string representation of this
JToolBar
.
-
getAccessibleContext
Gets the AccessibleContext associated with this JToolBar. For tool bars, the AccessibleContext takes the form of an AccessibleJToolBar. A new AccessibleJToolBar instance is created if necessary.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- an AccessibleJToolBar that serves as the AccessibleContext of this JToolBar
-