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 Actions 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.
| Modifier and Type | Class | Description |
|---|---|---|
protected class |
JToolBar.AccessibleJToolBar |
This class implements accessibility support for the JToolBar class. |
static class |
JToolBar.Separator |
A toolbar-specific separator. |
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
| Constructor | Description |
|---|---|
JToolBar() |
Creates a new tool bar; orientation defaults to HORIZONTAL. |
JToolBar |
Creates a new tool bar with the specified orientation. |
JToolBar |
Creates a new tool bar with the specified name. |
JToolBar |
Creates a new tool bar with a specified name and orientation. |
| Modifier and Type | Method | Description |
|---|---|---|
JButton |
add |
Adds a new JButton which dispatches the action. |
protected void |
addImpl |
If a JButton 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 |
Appends a separator of a specified size to the end of the tool bar. |
protected PropertyChangeListener |
createActionChangeListener |
Returns a properly configured PropertyChangeListener which updates the control as changes to the Action occur, or null if the default property change listener for the control is desired. |
protected JButton |
createActionComponent |
Factory method which creates the JButton for Actions added to the JToolBar. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JToolBar. |
Component |
getComponentAtIndex |
Returns the component at the specified index. |
int |
getComponentIndex |
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 the borderPainted property. |
boolean |
isFloatable() |
Gets the floatable property. |
boolean |
isRollover() |
Returns the rollover state. |
protected void |
paintBorder |
Paints the tool bar's border if the borderPainted property is true. |
protected String |
paramString() |
Returns a string representation of this JToolBar. |
void |
setBorderPainted |
Sets the borderPainted property, which is true if the border should be painted. |
void |
setFloatable |
Sets the floatable property, which must be true for the user to move the tool bar. |
void |
setMargin |
Sets the margin between the tool bar's border and its buttons. |
void |
setOrientation |
Sets the orientation of the tool bar. |
void |
setRollover |
Sets the rollover state of this toolbar. |
void |
setUI |
Sets the L&F object that renders this component. |
void |
updateUI() |
Notification from the UIFactory that the L&F has changed. |
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
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
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
public JToolBar()
HORIZONTAL.public JToolBar(int orientation)
orientation. The orientation must be either HORIZONTAL or VERTICAL.orientation - the orientation desiredpublic JToolBar(String name)
name. The name is used as the title of the undocked tool bar. The default orientation is HORIZONTAL.name - the name of the tool barpublic JToolBar(String name, int orientation)
name and orientation. All other constructors call this constructor. If orientation is an invalid value, an exception will be thrown.name - the name of the tool barorientation - the initial orientation -- it must be either HORIZONTAL or VERTICAL
IllegalArgumentException - if orientation is neither HORIZONTAL nor VERTICAL
public ToolBarUI getUI()
getUI in class JComponent
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(ToolBarUI ui)
ui - the ToolBarUI L&F objectpublic void updateUI()
UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.updateUI in class JComponent
@BeanProperty(bound=false) public String getUIClassID()
getUIClassID in class JComponent
public int getComponentIndex(Component c)
c - the Component to findpublic Component getComponentAtIndex(int i)
i - the component's position, where 0 is firstComponent at that position, or null for an invalid index@BeanProperty(expert=true, description="The margin between the tool bar\'s border and contents") public void setMargin(Insets m)
null causes the tool bar to use the default margins. The tool bar's default Border object uses this value to create the proper margin. However, if a non-default border is set on the tool bar, it is that Border object's responsibility to create the appropriate margin space (otherwise this property will effectively be ignored).m - an Insets object that defines the space between the border and the buttonspublic Insets getMargin()
Insets object containing the margin valuespublic boolean isBorderPainted()
borderPainted property.borderPainted property@BeanProperty(expert=true, description="Does the tool bar paint its borders?") public void setBorderPainted(boolean b)
borderPainted property, which is true if the border should be painted. The default value for this property is true. Some look and feels might not implement painted borders; they will ignore this property.b - if true, the border is paintedprotected void paintBorder(Graphics g)
borderPainted property is true.paintBorder in class JComponent
g - the Graphics context in which the painting is donepublic boolean isFloatable()
floatable property.floatable property@BeanProperty(preferred=true, description="Can the tool bar be made to float by the user?") public void setFloatable(boolean b)
floatable property, which must be true 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 is true. Some look and feels might not implement floatable tool bars; they will ignore this property.b - if true, the tool bar can be moved; false otherwisepublic int getOrientation()
HORIZONTAL or VERTICAL.HORIZONTAL or VERTICAL
@BeanProperty(preferred=true, enumerationValues={"SwingConstants.HORIZONTAL","SwingConstants.VERTICAL"}, description="The current orientation of the tool bar") public void setOrientation(int o) HORIZONTAL or VERTICAL. If orientation is an invalid value, an exception will be thrown.o - the new orientation -- either HORIZONTAL or VERTICAL
IllegalArgumentException - if orientation is neither HORIZONTAL nor VERTICAL
@BeanProperty(preferred=true, visualUpdate=true, description="Will draw rollover button borders in the toolbar.") public void setRollover(boolean rollover)
The implementation of a look and feel may choose to ignore this property.
rollover - true for rollover toolbar buttons; otherwise falsepublic boolean isRollover()
public void addSeparator()
public void addSeparator(Dimension size)
size - the Dimension of the separatorpublic JButton add(Action a)
JButton which dispatches the action.a - the Action object to add as a new menu itemprotected JButton createActionComponent(Action a)
JButton for Actions added to the JToolBar. The default name is empty if a null action is passed.a - the Action for the button to be addedprotected PropertyChangeListener createActionChangeListener(JButton b)
PropertyChangeListener which updates the control as changes to the Action occur, or null if the default property change listener for the control is desired.b - a JButton
nullprotected void addImpl(Component comp, Object constraints, int index)
JButton is being added, it is initially set to be disabled.protected String paramString()
JToolBar. 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 be null.paramString in class JComponent
JToolBar.@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
getAccessibleContext in interface Accessible
getAccessibleContext in class Component
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JToolBar.html