モジュール java.desktop

パッケージ javax.swing

クラスJToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

すべての実装されたインタフェース:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

@JavaBean(defaultProperty="UI", description="A component which displays commonly used controls or Actions.") public class JToolBar extends JComponent implements SwingConstants, Accessible

JToolBarは、一般的に使用されるActionまたはコントロールを表示するのに役立つコンポーネントを提供します。 ツールバーの使用例および詳細は、『The Java Tutorial』の「How to Use Tool Bars」を参照してください。

大部分のルック・アンド・フィールでは、floatableプロパティがfalseに設定されていないかぎり、ユーザーがツールバーをドラッグ・アウトし、別のウィンドウに入れることができます。 ドラッグ・アウトを適切に機能させるには、レイアウト・マネージャがBorderLayoutであるコンテナの4辺の1つにJToolBarのインスタンスを追加し、それ以外の辺には子を追加しないことをお勧めします。

警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4では、すべてのJavaBeansの長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:

1.2

関連項目:

• Action

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラス	説明
protected class	JToolBar.AccessibleJToolBar	このクラスはJToolBarクラスのアクセシビリティ・サポートを実装しています。
static class	JToolBar.Separator	ツールバー独自のセパレータです。

クラスjavax.swing.JComponentで宣言されたネストされたクラス/インタフェース

JComponent.AccessibleJComponent

クラスjava.awt.Containerで宣言されたネストされたクラス/インタフェース

Container.AccessibleAWTContainer

クラスjava.awt.Componentで宣言されたネストされたクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドのサマリー

クラスjavax.swing.JComponentで宣言されたフィールド

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

クラスjava.awt.Componentで宣言されたフィールド

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェースjava.awt.image.ImageObserverで宣言されているフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

インタフェース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

コンストラクタのサマリー

コンストラクタ

コンストラクタ	説明
JToolBar()	新しいツールバーを作成します。デフォルトの方向はHORIZONTALです。
JToolBar(int orientation)	orientationを指定して新規のツールバーを作成します。
JToolBar(String name)	nameを指定して新規のツールバーを作成します。
JToolBar(String name, int orientation)	指定されたnameとorientationを使用して新しいツールバーを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
JButton	add(Action a)	アクションをディスパッチする新しいJButtonを追加します。
protected void	addImpl(Component comp, Object constraints, int index)	JButtonが追加されると、初期状態では使用不可に設定されます。
void	addSeparator()	デフォルト・サイズのセパレータをツールバーの終端に追加します。
void	addSeparator(Dimension size)	指定されたサイズのセパレータをツールバーの終端に追加します。
protected PropertyChangeListener	createActionChangeListener(JButton b)	Actionへの変更が発生する場合にコントロールを更新するための、適切に設定されたPropertyChangeListenerを返します。コントロールにデフォルトのプロパティ変更リスナーが必要な場合は、nullが返されます。
protected JButton	createActionComponent(Action a)	JToolBarに追加されるActionのJButtonを作成するファクトリ・メソッドです。
AccessibleContext	getAccessibleContext()	このJToolBarに関連付けられたAccessibleContextを取得します。
Component	getComponentAtIndex(int i)	指定されたインデックスの要素を返します。
int	getComponentIndex(Component c)	指定されたコンポーネントのインデックスを返します。
Insets	getMargin()	ツールバーのボーダーとそのボタンの間のマージンを返します。
int	getOrientation()	現在のツールバーの方向を返します。
ToolBarUI	getUI()	ツールバーの現在のUIを返します。
String	getUIClassID()	このコンポーネントをレンダリングするL&Fクラスの名前を返します。
boolean	isBorderPainted()	borderPaintedプロパティを取得します。
boolean	isFloatable()	floatableプロパティを取得します。
boolean	isRollover()	ロールオーバー状態を返します。
protected void	paintBorder(Graphics g)	borderPaintedプロパティがtrueの場合に、ツールバーのボーダーをペイントします。
protected String	paramString()	このJToolBarの文字列表現を返します。
void	setBorderPainted(boolean b)	borderPaintedプロパティを設定します。ボーダーをペイントする場合は、このプロパティをtrueにします。
void	setFloatable(boolean b)	floatableプロパティを設定します。ユーザーがツールバーを移動できるようにするには、このプロパティをtrueにする必要があります。
void	setMargin(Insets m)	ツールバーのボーダーとそのボタンの間のマージンを設定します。
void	setOrientation(int o)	ツールバーの方向を設定します。
void	setRollover(boolean rollover)	このツールバーのロールオーバー状態を設定します。
void	setUI(ToolBarUI ui)	このコンポーネントをレンダリングするL&Fオブジェクトを設定します。
void	updateUI()	L&Fが変更されたことを示す、UIFactoryからの通知です。

クラスjavax.swing.JComponentで宣言されたメソッド

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラスjava.awt.Containerで宣言されたメソッド

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

クラスjava.awt.Componentで宣言されたメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

JToolBar

public JToolBar()

新しいツールバーを作成します。デフォルトの方向はHORIZONTALです。

JToolBar

public JToolBar(int orientation)

orientationを指定して新規のツールバーを作成します。 orientationは、HORIZONTALまたはVERTICALのどちらかになる必要があります。

パラメータ:

orientation - 指定される方向

JToolBar

public JToolBar(String name)

nameを指定して新規のツールバーを作成します。 名前は切り離されたツールバーのタイトルとして使用します。 デフォルトの方向はHORIZONTALです。

パラメータ:

name - ツールバーの名前

導入されたバージョン:

1.3

JToolBar

public JToolBar(String name, int orientation)

指定されたnameとorientationを使用して新しいツールバーを作成します。 ほかのコンストラクタはすべて、このコンストラクタを呼び出します。 orientationが無効な値の場合、例外がスローされます。

パラメータ:

name - ツールバーの名前

orientation - 初期状態の方向。HORIZONTALまたはVERTICAL

例外:

IllegalArgumentException - 方向がHORIZONTALまたはVERTICALのどちらでもない場合

導入されたバージョン:

1.3

メソッドの詳細

getUI

public ToolBarUI getUI()

ツールバーの現在のUIを返します。

オーバーライド:

クラスJComponentのgetUI

戻り値:

ツールバーの現在のUI。

関連項目:

• setUI(javax.swing.plaf.ToolBarUI)

setUI

@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(ToolBarUI ui)

このコンポーネントをレンダリングするL&Fオブジェクトを設定します。

パラメータ:

ui - ToolBarUI L&Fオブジェクト

関連項目:

• UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

L&Fが変更されたことを示す、UIFactoryからの通知です。 UIをUIFactoryからの最新バージョンに置き換えるために呼び出されます。

オーバーライド:

updateUI、クラスJComponent

関連項目:

• JComponent.updateUI()

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

このコンポーネントをレンダリングするL&Fクラスの名前を返します。

オーバーライド:

getUIClassID、クラスJComponent

戻り値:

文字列「ToolBarUI」

関連項目:

• JComponent.getUIClassID()
• UIDefaults.getUI(javax.swing.JComponent)

getComponentIndex

public int getComponentIndex(Component c)

指定されたコンポーネントのインデックスを返します。 (ノート: セパレータもインデックス位置を占有します。)

パラメータ:

c - 検索対象のComponent

戻り値:

コンポーネントの位置を示す整数型。0は先頭位置

getComponentAtIndex

public Component getComponentAtIndex(int i)

指定されたインデックスの要素を返します。

パラメータ:

i - コンポーネントの位置。0は先頭位置

戻り値:

指定された位置のComponent。インデックスが無効の場合はnull

setMargin

@BeanProperty(expert=true, description="The margin between the tool bar\'s border and contents") public void setMargin(Insets m)

ツールバーのボーダーとそのボタンの間のマージンを設定します。 nullに設定すると、ツールバーはデフォルト・マージンを使います。 ツールバーのデフォルトのBorderオブジェクトは、この値を使用して適切なマージンを作成します。 ただし、ツールバーにデフォルト以外のボーダーが設定される場合は、Borderオブジェクト側で適切なマージン領域を生成する必要があります(そうでない場合、このプロパティは事実上無視されます)。

パラメータ:

m - ボーダーとボタンの間のスペースを定義するInsetsオブジェクト

関連項目:

• Insets

getMargin

public Insets getMargin()

ツールバーのボーダーとそのボタンの間のマージンを返します。

戻り値:

マージン値を保持するInsetsオブジェクト

関連項目:

• Insets

isBorderPainted

public boolean isBorderPainted()

borderPaintedプロパティを取得します。

戻り値:

borderPaintedプロパティの値

関連項目:

• setBorderPainted(boolean)

setBorderPainted

@BeanProperty(expert=true, description="Does the tool bar paint its borders?") public void setBorderPainted(boolean b)

borderPaintedプロパティを設定します。ボーダーをペイントする場合は、このプロパティをtrueにします。 このプロパティのデフォルト値はtrueです。 ルック・アンド・フィールによっては、ボーダーのペイントが実装されていない場合があります。その場合、このプロパティは無視されます。

パラメータ:

b - trueの場合はボーダーがペイントされる

関連項目:

• isBorderPainted()

paintBorder

protected void paintBorder(Graphics g)

borderPaintedプロパティがtrueの場合に、ツールバーのボーダーをペイントします。

オーバーライド:

paintBorder、クラスJComponent

パラメータ:

g - ペイントが行われるGraphicsコンテキスト

関連項目:

• JComponent.paint(java.awt.Graphics)
• JComponent.setBorder(javax.swing.border.Border)

isFloatable

public boolean isFloatable()

floatableプロパティを取得します。

戻り値:

floatableプロパティの値

関連項目:

• setFloatable(boolean)

setFloatable

@BeanProperty(preferred=true, description="Can the tool bar be made to float by the user?") public void setFloatable(boolean b)

floatableプロパティを設定します。ユーザーがツールバーを移動できるようにするには、このプロパティをtrueにする必要があります。 通常、移動可能なツールバーは、同じコンテナ内の別の場所にドラッグしたり、ツールバー専用のウィンドウにドラッグ・アウトしたりできます。 このプロパティのデフォルト値はtrueです。 ルック・アンド・フィールによっては、移動可能なツールバーが実装されていない場合があります。その場合、このプロパティは無視されます。

パラメータ:

b - 移動可能なツールバーにする場合はtrue、そうでない場合はfalse

関連項目:

• isFloatable()

getOrientation

public int getOrientation()

現在のツールバーの方向を返します。 値はHORIZONTALまたはVERTICALです。

戻り値:

現在の方向(HORIZONTALまたはVERTICAL)を表す整数値

関連項目:

• setOrientation(int)

setOrientation

@BeanProperty(preferred=true, enumerationValues={"SwingConstants.HORIZONTAL","SwingConstants.VERTICAL"}, description="The current orientation of the tool bar") public void setOrientation(int o)

ツールバーの方向を設定します。 方向の値は、HORIZONTALまたはVERTICALです。 orientationが無効な値の場合、例外がスローされます。

パラメータ:

o - 新規の方向。HORIZONTALまたはVERTICAL

例外:

IllegalArgumentException - 方向がHORIZONTALまたはVERTICALのどちらでもない場合

関連項目:

• getOrientation()

setRollover

@BeanProperty(preferred=true, visualUpdate=true, description="Will draw rollover button borders in the toolbar.") public void setRollover(boolean rollover)

このツールバーのロールオーバー状態を設定します。 ロールオーバー状態がtrueの場合、マウス・ポインタをツールバー・ボタンの位置に移動したときにだけボタンが描画されます。 このプロパティのデフォルト値はfalseです。

ルック・アンド・フィールの実装によっては、このプロパティが無視されることもあります。

パラメータ:

rollover - ツールバー・ボタンのロールオーバーを行う場合はtrue、そうでない場合はfalse

導入されたバージョン:

1.4

isRollover

public boolean isRollover()

ロールオーバー状態を返します。

戻り値:

ロールオーバー・ツールバー・ボタンが描画される場合はtrue、そうでない場合はfalse

導入されたバージョン:

1.4

関連項目:

• setRollover(boolean)

addSeparator

public void addSeparator()

デフォルト・サイズのセパレータをツールバーの終端に追加します。 デフォルト・サイズは現在のルック・アンド・フィールで指定されています。

addSeparator

public void addSeparator(Dimension size)

指定されたサイズのセパレータをツールバーの終端に追加します。

パラメータ:

size - セパレータのDimension

add

public JButton add(Action a)

アクションをディスパッチする新しいJButtonを追加します。

パラメータ:

a - 新しいメニュー項目として追加するActionオブジェクト

戻り値:

アクションをディスパッチする新しいボタン

createActionComponent

protected JButton createActionComponent(Action a)

JToolBarに追加されるActionのJButtonを作成するファクトリ・メソッドです。 nullアクションが渡された場合、デフォルト名は空になります。

パラメータ:

a - 追加されるボタンのAction

戻り値:

新しく作成されたボタン

導入されたバージョン:

1.3

関連項目:

• Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton b)

Actionへの変更が発生する場合にコントロールを更新するための、適切に設定されたPropertyChangeListenerを返します。コントロールにデフォルトのプロパティ変更リスナーが必要な場合は、nullが返されます。

パラメータ:

b - a JButton

戻り値:

null

addImpl

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

JButtonが追加されると、初期状態では使用不可に設定されます。

オーバーライド:

addImpl、クラスContainer

パラメータ:

comp - 拡張されるコンポーネント

constraints - コンポーネントで遵守されるべき制約

index - コンポーネントのインデックス

関連項目:

• Container.add(Component)
• Container.add(Component, int)
• Container.add(Component, java.lang.Object)
• Container.invalidate()
• LayoutManager
• LayoutManager2

paramString

protected String paramString()

このJToolBarの文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる可能性があります。 返される文字列は空でもかまいませんが、nullにはできません。

オーバーライド:

paramString、クラスJComponent

戻り値:

このJToolBarを表す文字列表現。

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

このJToolBarに関連付けられたAccessibleContextを取得します。 ツールバーの場合、AccessibleContextはAccessibleJToolBarの形式を取ります。 必要に応じて新規のAccessibleJToolBarインスタンスが作成されます。

定義:

getAccessibleContext、インタフェースAccessible

オーバーライド:

getAccessibleContext、クラスComponent

戻り値:

このJToolBarのAccessibleContextとして機能するAccessibleJToolBar