Class JToolBar

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JToolBar
All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible,SwingConstants
@JavaBean(defaultProperty="UI",description="A component which displays commonly used controls or Actions.")public classJToolBarextendsJComponentimplementsSwingConstants,Accessible
JToolBar provides a component that is useful for displaying commonly usedActions or controls. For examples and information on using tool bars seeHow to Use Tool Bars, a section inThe Java Tutorial.

With most look and feels, the user can drag out a tool bar into a separate window (unless thefloatable property is set tofalse). For drag-out to work correctly, it is recommended that you addJToolBar instances to one of the four "sides" of a container whose layout manager is aBorderLayout, and do not add children to any of the other four "sides".

Warning: Swing is not thread safe. For more information seeSwing'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 thejava.beans package. Please seeXMLEncoder.

Since:
1.2
See Also:

  • 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

      public JToolBar(String name)
      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

      public JToolBar(String name, int orientation)
      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 bar
      orientation - the initial orientation -- it must be eitherHORIZONTAL orVERTICAL
      Throws:
      IllegalArgumentException - if orientation is neitherHORIZONTAL norVERTICAL
      Since:
      1.3

  • Method Details

    • getUI

      public ToolBarUI getUI()
      Returns the tool bar's current UI.
      Overrides:
      getUI in class JComponent
      Returns:
      the tool bar's current UI.
      See Also:

    • 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:

    • 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 class JComponent
      See Also:

    • getUIClassID

      @BeanProperty(bound=false)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:

    • getComponentIndex

      public int getComponentIndex(Component c)
      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

      public Component getComponentAtIndex(int i)
      Returns the component at the specified index.
      Parameters:
      i - the component's position, where 0 is first
      Returns:
      theComponent 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:

    • getMargin

      public Insets getMargin()
      Returns the margin between the tool bar's border and its buttons.
      Returns:
      anInsets object containing the margin values
      See Also:

    • isBorderPainted

      public boolean isBorderPainted()
      Gets theborderPainted property.
      Returns:
      the value of theborderPainted property
      See Also:

    • 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:

    • paintBorder

      protected void paintBorder(Graphics g)
      Paints the tool bar's border if theborderPainted property istrue.
      Overrides:
      paintBorder in class JComponent
      Parameters:
      g - theGraphics context in which the painting is done
      See Also:

    • isFloatable

      public boolean isFloatable()
      Gets thefloatable property.
      Returns:
      the value of thefloatable property
      See Also:

    • 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:

    • getOrientation

      public int getOrientation()
      Returns the current orientation of the tool bar. The value is eitherHORIZONTAL orVERTICAL.
      Returns:
      an integer representing the current orientation -- eitherHORIZONTAL orVERTICAL
      See Also:

    • 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:

    • 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:

    • 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

      public void addSeparator(Dimension size)
      Appends a separator of a specified size to the end of the tool bar.
      Parameters:
      size - theDimension of the separator

    • add

      public JButton add(Action a)
      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

      protected JButton createActionComponent(Action a)
      Factory method which creates theJButton forActions 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:

    • createActionChangeListener

      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.
      Parameters:
      b - aJButton
      Returns:
      null

    • addImpl

      protected void addImpl(Component comp,Object constraints, int index)
      If aJButton 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:

    • paramString

      protected String 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 class JComponent
      Returns:
      a string representation of thisJToolBar.

    • getAccessibleContext

      @BeanProperty(bound=false)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