|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JToolBar
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.
A tool bar can be dragged out into a separate 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'.
For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JToolBar key assignments.
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. A future release of Swing will provide support for long term persistence.
Action
, Serialized FormInner Class Summary | |
protected class |
JToolBar.AccessibleJToolBar
This class implements accessibility support for the JToolBar class. |
static class |
JToolBar.Separator
A toolbar-specific separator. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent |
Fields inherited from class javax.swing.JComponent |
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
JToolBar()
Creates a new toolbar; orientation defaults to HORIZONTAL . |
|
JToolBar(int orientation)
Creates a new toolbar with the specified orientation. |
|
JToolBar(String name)
Creates a new toolbar with the specified name . |
|
JToolBar(String name,
int orientation)
Creates a new toolbar with a specified name and
orientation . |
Method Summary | |
JButton |
add(Action a)
Adds a new JButton which dispatches the action. |
protected void |
addImpl(Component comp,
Object constraints,
int index)
If a JButton is being added, it is initially
set to be disabled. |
void |
addSeparator()
Appends a toolbar separator of default size to the end of the toolbar. |
void |
addSeparator(Dimension size)
Appends a toolbar separator of a specified size to the end of the toolbar. |
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. |
protected JButton |
createActionComponent(Action a)
Factory method which creates the JButton for
Action s added to the JToolBar . |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JToolBar. |
Component |
getComponentAtIndex(int i)
Returns the component at the specified index. |
int |
getComponentIndex(Component c)
Returns the index of the specified component. |
Insets |
getMargin()
Returns the margin between the toolbar's border and its buttons. |
int |
getOrientation()
Returns the current orientation of the toolbar. |
ToolBarUI |
getUI()
Returns the toolbar's current UI. |
String |
getUIClassID()
Returns the name of the L&F class that renders this component. |
boolean |
isBorderPainted()
Checks whether the border should be painted. |
boolean |
isFloatable()
Returns true if the JToolbar can be dragged out by the user. |
protected void |
paintBorder(Graphics g)
Paint the toolbar's border if BorderPainted property
is true. |
protected String |
paramString()
Returns a string representation of this JToolBar . |
void |
setBorderPainted(boolean b)
Sets whether the border should be painted. |
void |
setFloatable(boolean b)
Sets whether the toolbar can be made to float. |
void |
setMargin(Insets m)
Sets the margin between the toolbar's border and its buttons. |
void |
setOrientation(int o)
Sets the orientation of the toolbar. |
void |
setUI(ToolBarUI ui)
Sets the L&F object that renders this component. |
void |
updateUI()
Notification from the UIFactory that the L&F has changed. |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public JToolBar()
HORIZONTAL
.public JToolBar(int orientation)
orientation.
The orientation
must be either HORIZONTAL
or VERTICAL
.
- Parameters:
orientation
- the orientation desired
public JToolBar(String name)
name
. The
name is used as the title of the undocked toolbar. The default
orientation is HORIZONTAL
.name
- the name of the toolbarpublic 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 toolbarorientation
- the initial orientation -- it must be
either HORIZONTAL
or VERTICAL
IllegalArgumentException
- if orientation is neither
HORIZONTAL
nor VERTICAL
Method Detail |
public ToolBarUI getUI()
setUI(javax.swing.plaf.ToolBarUI)
public void setUI(ToolBarUI ui)
ui
- the ToolBarUI
L&F objectUIDefaults.getUI(javax.swing.JComponent)
public 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
JComponent.updateUI()
public String getUIClassID()
getUIClassID
in class JComponent
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.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 indexpublic void setMargin(Insets m)
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).m
- an Insets
object that defines the space
between the border and the buttonsInsets
public Insets getMargin()
Insets
object containing the margin valuesInsets
public boolean isBorderPainted()
setBorderPainted(boolean)
public void setBorderPainted(boolean b)
b
- if true, the border is paintedisBorderPainted()
protected void paintBorder(Graphics g)
BorderPainted
property
is true.paintBorder
in class JComponent
g
- the Graphics
context in which the painting
is doneJComponent.paint(java.awt.Graphics)
,
JComponent.setBorder(javax.swing.border.Border)
public boolean isFloatable()
JToolbar
can be dragged out by the user.JToolbar
can be dragged
out by the user, false otherwisepublic void setFloatable(boolean b)
b
- if true, the toolbar can be dragged out; false otherwiseisFloatable()
public int getOrientation()
HORIZONTAL
or VERTICAL
.HORIZONTAL
or VERTICAL
setOrientation(int)
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
VERTICALIllegalArgumentException
- if orientation is neither
HORIZONTAL
nor VERTICAL
getOrientation()
public void addSeparator()
public void addSeparator(Dimension size)
size
- the Dimension
of the separatorpublic JButton add(Action a)
JButton
which dispatches the action.
As of 1.3, this is no longer the preferred method for adding
Action
s to a container. Instead it is recommended
to configure a control with an action using
using setAction
, and then add that control directly
to the Container
.
a
- the Action
object to add as a new menu itemprotected JButton createActionComponent(Action a)
JButton
for
Action
s added to the JToolBar
.
The default name is empty if a null
action is passed.
As of 1.3, this is no longer the preferred method for adding
Action
s to a Container
.
Instead it is recommended to configure a control with an action
using setAction
, and then add that control directly
to the Container
.
a
- the Action
for the button to be addedAction
protected 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.
As of 1.3, this is no longer the preferred method for adding
Action
s to a Container
.
Instead it is recommended to configure a control with an action
using setAction
, and then add that control directly
to the Container
.
null
protected void addImpl(Component comp, Object constraints, int index)
JButton
is being added, it is initially
set to be disabled.addImpl
in class Container
comp
- the component to be enhancedconstraints
- the constraints to be enforced on the componentindex
- the index of the componentprotected 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
.public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JComponent
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.