javax.swing

Class JToolBar

public class JToolBar extends JComponent implements SwingConstants, Accessible

JToolBar is a component that provides a toolbar to Swing programs. Users can add buttons (or actions that will be represented by JButtons) as well as other components to the JToolBar. JToolBars can be dragged in and out of their parent components. If the JToolBar is dragged out of the parent, then it will be displayed in its own RootPaneContainer. For dragging to work properly, JToolBars need to be placed in a Container that has a BorderLayout. That parent Container cannot have components in the NORTH, EAST, SOUTH, or WEST components (that is not the JToolBar).

Nested Class Summary
protected class	JToolBar.AccessibleJToolBar Provides the accessibility features for the `JToolBar` component.
static class	JToolBar.Separator This is an extension of JSeparator used in toolbars.

Constructor Summary
	JToolBar() This method creates a new JToolBar object with horizontal orientation and no name.
	JToolBar(int orientation) This method creates a new JToolBar with the given orientation and no name.
	JToolBar(String name) This method creates a new JToolBar object with the given name and horizontal orientation.
	JToolBar(String name, int orientation) This method creates a new JToolBar object with the given name and orientation.

Method Summary
JButton	add(Action action) This method adds a new JButton that performs the given Action to the JToolBar.
protected void	addImpl(Component component, Object constraints, int index) This method overrides Container's addImpl method.
void	addSeparator() This method adds a Separator of default size to the JToolBar.
void	addSeparator(Dimension size) This method adds a Separator with the given size to the JToolBar.
protected PropertyChangeListener	createActionChangeListener(JButton button) This method creates a pre-configured PropertyChangeListener which updates the control as changes are made to the Action.
protected JButton	createActionComponent(Action action) This method is used to create JButtons which can be added to the JToolBar for the given action.
AccessibleContext	getAccessibleContext() Returns the object that provides accessibility features for this `JToolBar` component.
Component	getComponentAtIndex(int index) This method returns the component at the given index.
int	getComponentIndex(Component component) This method returns the index of the given component.
Insets	getMargin() This method returns the margin property.
int	getOrientation() This method returns the orientation of the JToolBar.
ToolBarUI	getUI() This method returns the UI class used to paint this JToolBar.
String	getUIClassID() This method returns the String identifier for the UI class to the used with the JToolBar.
boolean	isBorderPainted() This method returns the borderPainted property.
boolean	isFloatable() This method returns the floatable property.
boolean	isRollover() This method returns the rollover property.
protected void	paintBorder(Graphics graphics) This method paints the border if the borderPainted property is true.
protected String	paramString() Returns a string describing the attributes for the `JToolBar` component, for use in debugging.
void	setBorderPainted(boolean painted) This method sets the borderPainted property.
void	setFloatable(boolean floatable) This method sets the floatable property.
void	setLayout(LayoutManager mgr) This method sets the layout manager to be used with the JToolBar.
void	setMargin(Insets margin) This method sets the margin property.
void	setOrientation(int orientation) This method sets the orientation property for JToolBar.
void	setRollover(boolean b) This method sets the rollover property for the JToolBar.
void	setUI(ToolBarUI ui) This method sets the UI used with the JToolBar.
void	updateUI() This method resets the UI used to the Look and Feel defaults.

Constructor Detail

JToolBar

public JToolBar()

This method creates a new JToolBar object with horizontal orientation and no name.

JToolBar

public JToolBar(int orientation)

This method creates a new JToolBar with the given orientation and no name.

Parameters: orientation JToolBar orientation (HORIZONTAL or VERTICAL)

JToolBar

public JToolBar(String name)

This method creates a new JToolBar object with the given name and horizontal orientation.

Parameters: name Name assigned to undocked tool bar.

JToolBar

public JToolBar(String name, int orientation)

This method creates a new JToolBar object with the given name and orientation.

Parameters: name Name assigned to undocked tool bar. orientation JToolBar orientation (HORIZONTAL or VERTICAL)

Method Detail

add

public JButton add(Action action)

This method adds a new JButton that performs the given Action to the JToolBar.

Parameters: action The Action to add to the JToolBar.

Returns: The JButton that wraps the Action.

addImpl

protected void addImpl(Component component, Object constraints, int index)

This method overrides Container's addImpl method. If a JButton is added, it is disabled.

Parameters: component The Component to add. constraints The Constraints placed on the component. index The index to place the Component at.

addSeparator

public void addSeparator()

This method adds a Separator of default size to the JToolBar.

addSeparator

public void addSeparator(Dimension size)

This method adds a Separator with the given size to the JToolBar.

Parameters: size The size of the Separator.

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton button)

This method creates a pre-configured PropertyChangeListener which updates the control as changes are made to the Action. However, this is no longer the recommended way of adding Actions to Containers. As such, this method returns null.

Parameters: button The JButton to configure a PropertyChangeListener for.

Returns: null.

createActionComponent

protected JButton createActionComponent(Action action)

This method is used to create JButtons which can be added to the JToolBar for the given action.

Parameters: action The action to create a JButton for.

Returns: The JButton created from the action.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Returns the object that provides accessibility features for this JToolBar component.

Returns: The accessible context (an instance of {@link AccessibleJToolBar}).

getComponentAtIndex

public Component getComponentAtIndex(int index)

This method returns the component at the given index.

Parameters: index The index of the component.

Returns: The component at the given index.

getComponentIndex

public int getComponentIndex(Component component)

This method returns the index of the given component.

Parameters: component The component to find.

Returns: The index of the given component.

getMargin

public Insets getMargin()

This method returns the margin property.

Returns: The margin property.

getOrientation

public int getOrientation()

This method returns the orientation of the JToolBar.

Returns: The orientation of the JToolBar.

getUI

public ToolBarUI getUI()

This method returns the UI class used to paint this JToolBar.

Returns: The UI class for this JToolBar.

getUIClassID

public String getUIClassID()

This method returns the String identifier for the UI class to the used with the JToolBar.

Returns: The String identifier for the UI class.

isBorderPainted

public boolean isBorderPainted()

This method returns the borderPainted property.

Returns: The borderPainted property.

isFloatable

public boolean isFloatable()

This method returns the floatable property.

Returns: The floatable property.

isRollover

public boolean isRollover()

This method returns the rollover property.

Returns: The rollover property.

paintBorder

protected void paintBorder(Graphics graphics)

This method paints the border if the borderPainted property is true.

Parameters: graphics The graphics object to paint with.

paramString

protected String paramString()

Returns a string describing the attributes for the JToolBar component, for use in debugging. The return value is guaranteed to be non-null, but the format of the string may vary between implementations.

Returns: A string describing the attributes of the JToolBar.

setBorderPainted

public void setBorderPainted(boolean painted)

This method sets the borderPainted property. If set to false, the border will not be painted.

Parameters: painted Whether the border will be painted.

setFloatable

public void setFloatable(boolean floatable)

This method sets the floatable property. If set to false, the JToolBar cannot be dragged.

Parameters: floatable Whether the JToolBar can be dragged.

setLayout

public void setLayout(LayoutManager mgr)

This method sets the layout manager to be used with the JToolBar.

Parameters: mgr The Layout Manager used with the JToolBar.

setMargin

public void setMargin(Insets margin)

This method sets the margin property. The margin property determines the extra space between the children components of the JToolBar and the border.

Parameters: margin The margin property.

setOrientation

public void setOrientation(int orientation)

This method sets the orientation property for JToolBar.

Parameters: orientation The new orientation for JToolBar.

Throws: IllegalArgumentException If the orientation is not HORIZONTAL or VERTICAL.

setRollover

public void setRollover(boolean b)

This method sets the rollover property for the JToolBar. In rollover mode, JButtons inside the JToolBar will only display their borders when the mouse is moving over them.

Parameters: b The new rollover property.

setUI

public void setUI(ToolBarUI ui)

This method sets the UI used with the JToolBar.

Parameters: ui The UI used with the JToolBar.

updateUI

public void updateUI()

This method resets the UI used to the Look and Feel defaults.