javax.swing

クラス JToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

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

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class JToolBar
extends JComponent
implements SwingConstants, Accessible

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

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

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

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

関連項目:

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 から継承されたフィールド

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

クラス java.awt.Component から継承されたフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

インタフェース java.awt.image.ImageObserver から継承されたフィールド

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

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

コンストラクタ

コンストラクタと説明
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	setLayout(LayoutManager mgr) このコンテナのレイアウトマネージャーを設定します。
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, 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, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 を返します。

関連項目:

setUI(javax.swing.plaf.ToolBarUI)

setUI

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

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

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

public void setBorderPainted(boolean b)

borderPainted プロパティーを設定します。ボーダーをペイントする場合は、このプロパティーを true にします。このプロパティーのデフォルト値は true です。一部の Look & Feel ではボーダーのペイントが実装されていない可能性があります。実装されていない場合、このプロパティーは無視されます。

パラメータ:

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

public void setFloatable(boolean b)

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

パラメータ:

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

関連項目:

isFloatable()

getOrientation

public int getOrientation()

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

戻り値:

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

関連項目:

setOrientation(int)

setOrientation

public void setOrientation(int o)

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

パラメータ:

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

例外:

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

関連項目:

getOrientation()

setRollover

public void setRollover(boolean rollover)

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

Look & Feel の実装によっては、このプロパティーが無視されることもあります。

パラメータ:

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

導入されたバージョン:

1.4

isRollover

public boolean isRollover()

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

戻り値:

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

導入されたバージョン:

1.4

関連項目:

setRollover(boolean)

addSeparator

public void addSeparator()

デフォルトサイズのセパレータをツールバーの終端に追加します。デフォルトサイズは現在の Look & Feel で指定されています。

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 が返されます。

戻り値:

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 を表す文字列表現。

setLayout

public void setLayout(LayoutManager mgr)

次のクラスからコピーされた説明: Container

このコンテナのレイアウトマネージャーを設定します。

このメソッドではレイアウトに関連する情報が変更されるため、コンポーネント階層が無効になります。

オーバーライド:

setLayout 、クラス: Container

パラメータ:

mgr - 指定されたレイアウトマネージャー

関連項目:

Container.doLayout(), Container.getLayout(), Container.invalidate()

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

定義:

getAccessibleContext 、インタフェース: Accessible

オーバーライド:

getAccessibleContext 、クラス: JComponent

戻り値:

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