Package Summary Overview Summary

### class:JToolBar [NONE]
- All Implemented Interfaces: ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants
      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`

### constructor:JToolBar() [NONE]
- #### JToolBar
      public JToolBar()
Creates a new tool bar; orientation defaults to `HORIZONTAL`.

### constructor:JToolBar(int) [NONE]
- #### JToolBar
      public JToolBar(int orientation)
Creates a new tool bar with the specified `orientation`. The `orientation` must be either `HORIZONTAL` or `VERTICAL`. Parameters: `orientation` - the orientation desired

### constructor:JToolBar(java.lang.String) [NONE]
- #### JToolBar
      public JToolBar(String name)
Creates a new tool bar with the specified `name`. The name is used as the title of the undocked tool bar. The default orientation is `HORIZONTAL`. Parameters: `name` - the name of the tool bar Since: 1.3

### constructor:JToolBar(java.lang.String, int) [NONE]
- #### JToolBar
      public JToolBar(String name,
                      int orientation)
Creates a new tool bar with a specified `name` and `orientation`. All other constructors call this constructor. If `orientation` is an invalid value, an exception will be thrown. Parameters: `name` - the name of the tool bar `orientation` - the initial orientation -- it must be either `HORIZONTAL` or `VERTICAL` Throws: `IllegalArgumentException` - if orientation is neither `HORIZONTAL` nor `VERTICAL` Since: 1.3

### method:getUI() [NONE]
- #### getUI
      public ToolBarUI getUI()
Returns the tool bar's current UI. Returns: the tool bar's current UI. See Also: `setUI(javax.swing.plaf.ToolBarUI)`

### method:setUI(javax.swing.plaf.ToolBarUI) [NONE]
- #### setUI
      public void setUI(ToolBarUI ui)
Sets the L&F object that renders this component. Parameters: `ui` - the `ToolBarUI` L&F object See Also: `UIDefaults.getUI(javax.swing.JComponent)`

### method:updateUI() [NONE]
- #### updateUI
      public void updateUI()
Notification from the `UIFactory` that the L&F has changed. Called to replace the UI with the latest version from the `UIFactory`. Overrides: `updateUI` in class `JComponent` See Also: `JComponent.updateUI()`

### method:getUIClassID() [NONE]
- #### getUIClassID
      public String getUIClassID()
Returns the name of the L&F class that renders this component. Overrides: `getUIClassID` in class `JComponent` Returns: the string "ToolBarUI" See Also: `JComponent.getUIClassID()`, `UIDefaults.getUI(javax.swing.JComponent)`

### method:getComponentIndex(java.awt.Component) [NONE]
- #### getComponentIndex
      public int getComponentIndex(Component c)
Returns the index of the specified component. (Note: Separators occupy index positions.) Parameters: `c` - the `Component` to find Returns: an integer indicating the component's position, where 0 is first

### method:getComponentAtIndex(int) [NONE]
- #### getComponentAtIndex
      public Component getComponentAtIndex(int i)
Returns the component at the specified index. Parameters: `i` - the component's position, where 0 is first Returns: the `Component` at that position, or `null` for an invalid index

### method:setMargin(java.awt.Insets) [NONE]
- #### setMargin
      public void setMargin(Insets m)
Sets the margin between the tool bar's border and its buttons. Setting to `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). Parameters: `m` - an `Insets` object that defines the space between the border and the buttons See Also: `Insets`

### method:getMargin() [NONE]
- #### getMargin
      public 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`

### method:isBorderPainted() [NONE]
- #### isBorderPainted
      public boolean isBorderPainted()
Gets the `borderPainted` property. Returns: the value of the `borderPainted` property See Also: `setBorderPainted(boolean)`

### method:setBorderPainted(boolean) [NONE]
- #### setBorderPainted
      public void setBorderPainted(boolean b)
Sets the `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. Parameters: `b` - if true, the border is painted See Also: `isBorderPainted()`

### method:paintBorder(java.awt.Graphics) [NONE]
- #### paintBorder
      protected void paintBorder(Graphics g)
Paints the tool bar's border if the `borderPainted` property is `true`. Overrides: `paintBorder` in class `JComponent` Parameters: `g` - the `Graphics` context in which the painting is done See Also: `JComponent.paint(java.awt.Graphics)`, `JComponent.setBorder(javax.swing.border.Border)`

### method:isFloatable() [NONE]
- #### isFloatable
      public boolean isFloatable()
Gets the `floatable` property. Returns: the value of the `floatable` property See Also: `setFloatable(boolean)`

### method:setFloatable(boolean) [NONE]
- #### setFloatable
      public void setFloatable(boolean b)
Sets the `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. Parameters: `b` - if `true`, the tool bar can be moved; `false` otherwise See Also: `isFloatable()`

### method:getOrientation() [NONE]
- #### getOrientation
      public int getOrientation()
Returns the current orientation of the tool bar. The value is either `HORIZONTAL` or `VERTICAL`. Returns: an integer representing the current orientation -- either `HORIZONTAL` or `VERTICAL` See Also: `setOrientation(int)`

### method:setOrientation(int) [NONE]
- #### setOrientation
      public void setOrientation(int o)
Sets the orientation of the tool bar. The orientation must have either the value `HORIZONTAL` or `VERTICAL`. If `orientation` is an invalid value, an exception will be thrown. Parameters: `o` - the new orientation -- either `HORIZONTAL` or `VERTICAL` Throws: `IllegalArgumentException` - if orientation is neither `HORIZONTAL` nor `VERTICAL` See Also: `getOrientation()`

### method:setRollover(boolean) [NONE]
- #### setRollover
      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

### method:isRollover() [NONE]
- #### 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)`

### method:addSeparator() [NONE]
- #### 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.

### method:addSeparator(java.awt.Dimension) [NONE]
- #### addSeparator
      public void addSeparator(Dimension size)
Appends a separator of a specified size to the end of the tool bar. Parameters: `size` - the `Dimension` of the separator

### method:add(javax.swing.Action) [NONE]
- #### add
      public JButton add(Action a)
Adds a new `JButton` which dispatches the action. Parameters: `a` - the `Action` object to add as a new menu item Returns: the new button which dispatches the action

### method:createActionComponent(javax.swing.Action) [NONE]
- #### createActionComponent
      protected JButton createActionComponent(Action a)
Factory method which creates the `JButton` for `Action`s added to the `JToolBar`. The default name is empty if a `null` action is passed. Parameters: `a` - the `Action` for the button to be added Returns: the newly created button Since: 1.3 See Also: `Action`

### method:createActionChangeListener(javax.swing.JButton) [NONE]
- #### createActionChangeListener
      protected PropertyChangeListener createActionChangeListener(JButton b)
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. Parameters: `b` - a `JButton` Returns: `null`

### method:addImpl(java.awt.Component, java.lang.Object, int) [NONE]
- #### addImpl
      protected void addImpl(Component comp,
                             Object constraints,
                             int index)
If a `JButton` is being added, it is initially set to be disabled. Overrides: `addImpl` in class `Container` Parameters: `comp` - the component to be enhanced `constraints` - the constraints to be enforced on the component `index` - the index of the component See Also: `Container.add(Component)`, `Container.add(Component, int)` , `Container.add(Component, java.lang.Object)` , `Container.invalidate()`, `LayoutManager`, `LayoutManager2`

### method:paramString() [NONE]
- #### paramString
      protected String paramString()
Returns a string representation of this `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`. Overrides: `paramString` in class `JComponent` Returns: a string representation of this `JToolBar`.

### method:setLayout(java.awt.LayoutManager) [NONE]
- #### setLayout
      public void setLayout(LayoutManager mgr)
Description copied from class: `Container` Sets the layout manager for this container. This method changes layout-related information, and therefore, invalidates the component hierarchy. Overrides: `setLayout` in class `Container` Parameters: `mgr` - the specified layout manager See Also: `Container.doLayout()`, `Container.getLayout()`, `Container.invalidate()`

### method:getAccessibleContext() [NONE]
- #### getAccessibleContext
      public AccessibleContext 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 interface `Accessible` Overrides: `getAccessibleContext` in class `Component` Returns: an AccessibleJToolBar that serves as the AccessibleContext of this JToolBar