Where Am I? Class Hierarchy (JFC) All Classes (JFC)

Class com.sun.java.swing.JToolBar

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.swing.JToolBar

public class JToolBar
extends JComponent
implements Accessible

JToolBar provides a component which is useful for displaying commonly used Actions or controls. It can be dragged out into a seperate window by the user (unless the floatable property is set to false). In order 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: 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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
Action

Constructor Index

JToolBar()
Create a new toolbar.

Method Index

add(Action)
Add a new JButton which dispatches the action.
addSeparator()
Appends a toolbar-specific separator to the end of the toolbar (not a JSeparator).
createActionChangeListener(JButton)
getAccessibleContext()
Get the AccessibleContext associated with this JComponent
getComponentAtIndex(int)
getComponentIndex(Component)
getMargin()
Returns the margin between the toolbar's border and its buttons.
getUI()
Returns the toolbar's current UI.
getUIClassID()
Returns the name of the L&F class that renders this component.
isBorderPainted()
Checks whether the border should be painted.
isFloatable()
Return true if the Toolbar can be dragged out by the user.
paintBorder(Graphics)
Paint the toolbar's border if BorderPainted property is true.
setBorderPainted(boolean)
Sets whether the border should be painted.
setFloatable(boolean)
Sets whether the toolbar can be made to float
setMargin(Insets)
Sets the margin between the toolbar's border and its buttons.
setUI(ToolBarUI)
Sets the L&F object that renders this component.
updateUI()
Notification from the UIFactory that the L&F has changed.

Constructors

JToolBar
 public JToolBar()
Create a new toolbar.


Methods

getUI
 public ToolBarUI getUI()
Returns the toolbar's current UI.

See Also:
setUI
setUI
 public void setUI(ToolBarUI ui)
Sets the L&F object that renders this component.

Parameters:
ui - the ToolBarUI L&F object
See Also:
getUI
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:
updateUI
getUIClassID
 public String getUIClassID()
Returns the name of the L&F class that renders this component.

Returns:
"ToolBarUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI
getComponentIndex
 public int getComponentIndex(Component c)
getComponentAtIndex
 public Component getComponentAtIndex(int i)
setMargin
 public void setMargin(Insets m)
Sets the margin between the toolbar's border and its buttons. Setting to null causes the toolbar to use the default margins. The toolbar's default Border object uses this value to create the proper margin. However, if a non-default border is set on the toolbar, 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
getMargin
 public Insets getMargin()
Returns the margin between the toolbar's border and its buttons.

Returns:
an Insets object containing the margin values
See Also:
Insets
isBorderPainted
 public boolean isBorderPainted()
Checks whether the border should be painted.

Returns:
true if the border should be painted, else false
See Also:
setBorderPainted
setBorderPainted
 public void setBorderPainted(boolean b)
Sets whether the border should be painted.

Parameters:
b - if true, the border is painted.
See Also:
isBorderPainted
paintBorder
 protected void paintBorder(Graphics g)
Paint the toolbar's border if BorderPainted property is true.

Parameters:
g - the Graphics context in which the painting is done
Overrides:
paintBorder in class JComponent
See Also:
paint, setBorder
isFloatable
 public boolean isFloatable()
Return true if the Toolbar can be dragged out by the user.

Returns:
true if the Toolbar can be dragged out by the user
setFloatable
 public void setFloatable(boolean b)
Sets whether the toolbar can be made to float

Parameters:
b - if true, the toolbar can be dragged out
See Also:
isFloatable
addSeparator
 public void addSeparator()
Appends a toolbar-specific separator to the end of the toolbar (not a JSeparator).

add
 public JButton add(Action a)
Add a new JButton which dispatches the action.

Parameters:
a - the Action object to add as a new menu item
createActionChangeListener
 protected PropertyChangeListener createActionChangeListener(JButton b)
getAccessibleContext
 public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent

Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

Where Am I? Class Hierarchy (JFC) All Classes (JFC)