|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JToolBar
public class JToolBar
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. |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary |
---|
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, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, 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()
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public JToolBar()
public JToolBar(int orientation)
orientation
- JToolBar orientation (HORIZONTAL or VERTICAL)public JToolBar(String name)
name
- Name assigned to undocked tool bar.public JToolBar(String name, int orientation)
name
- Name assigned to undocked tool bar.orientation
- JToolBar orientation (HORIZONTAL or VERTICAL)Method Detail |
---|
public JButton add(Action action)
action
- The Action to add to the JToolBar.
protected void paintBorder(Graphics graphics)
paintBorder
in class JComponent
graphics
- The graphics object to paint with.JComponent.paint(java.awt.Graphics)
,
JComponent.paintChildren(java.awt.Graphics)
,
JComponent.paintComponent(java.awt.Graphics)
public ToolBarUI getUI()
public void setUI(ToolBarUI ui)
ui
- The UI used with the JToolBar.public void updateUI()
updateUI
in class JComponent
public String getUIClassID()
getUIClassID
in class JComponent
JComponent.setUI(javax.swing.plaf.ComponentUI)
,
JComponent.updateUI()
public void setRollover(boolean b)
b
- The new rollover property.public boolean isRollover()
public int getComponentIndex(Component component)
component
- The component to find.
public Component getComponentAtIndex(int index)
index
- The index of the component.
public Insets getMargin()
public void setMargin(Insets margin)
margin
- The margin property.public boolean isBorderPainted()
public void setBorderPainted(boolean painted)
painted
- Whether the border will be painted.public boolean isFloatable()
public void setFloatable(boolean floatable)
floatable
- Whether the JToolBar can be dragged.public int getOrientation()
public void setLayout(LayoutManager mgr)
setLayout
in class Container
mgr
- The Layout Manager used with the JToolBar.public void setOrientation(int orientation)
orientation
- The new orientation for JToolBar.
IllegalArgumentException
- If the orientation is not HORIZONTAL or
VERTICAL.public void addSeparator()
public void addSeparator(Dimension size)
size
- The size of the Separator.protected JButton createActionComponent(Action action)
action
- The action to create a JButton for.
protected PropertyChangeListener createActionChangeListener(JButton button)
button
- The JButton to configure a PropertyChangeListener for.
protected void addImpl(Component component, Object constraints, int index)
addImpl
in class Container
component
- The Component to add.constraints
- The Constraints placed on the component.index
- The index to place the Component at.protected String paramString()
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.
paramString
in class JComponent
JToolBar
.public AccessibleContext getAccessibleContext()
JToolBar
component.
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JComponent
JToolBar.AccessibleJToolBar
).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |