javax.swing
クラス JToolBar

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

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

Accessible, ImageObserver, MenuContainer, Serializable, SwingConstants

public class JToolBar

extends JComponent

implements SwingConstants, Accessible

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

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

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JToolBar のキーの割り当てを参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

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

クラス 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, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

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

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

コンストラクタの概要

JToolBar()
新しいツールバーを作成します。

JToolBar(int orientation)
orientation を指定して新しいツールバーを作成します。

JToolBar(String name)
Creates a new toolbar with the specified 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 を返します。
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() ボーダをペイントするかどうかを調べます。
boolean	isFloatable() ユーザが JToolbar をドラッグアウトできる場合に true を返します。
protected void	paintBorder(Graphics g) BorderPainted プロパティが true の場合、ツールバーのボーダをペイントします。
protected String	paramString() この JToolBar の文字列表現を返します。
void	setBorderPainted(boolean b) ボーダをペイントするかどうかを設定します。
void	setFloatable(boolean b) ツールバーを浮動状態にできるかどうかを設定します。
void	setMargin(Insets m) ツールバーのボーダとそのボタンの間のマージンを設定します。
void	setOrientation(int o) ツールバーの方向を設定します。
void	setUI(ToolBarUI ui) このコンポーネントを描画する L&F オブジェクトを設定します。
void	updateUI() L&F が変更されたことを示す UIFactory からの通知です。

クラス javax.swing.JComponent から継承したメソッド

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラス 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

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

クラス 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)

Creates a new toolbar with the specified name. The name is used as the title of the undocked toolbar. The default orientation is HORIZONTAL.

パラメータ:

name - the name of the toolbar

導入されたバージョン:

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 からの最新バージョンに置き換えるために呼び出されます。

オーバーライド:

クラス JComponent 内の updateUI

関連項目:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

このコンポーネントを描画する L&F クラスの名前を返します。

オーバーライド:

クラス JComponent 内の getUIClassID

戻り値:

文字列「ToolBarUI」

関連項目:

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

getComponentIndex

public int getComponentIndex(Component c)

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

パラメータ:

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()

ボーダをペイントするかどうかを調べます。

戻り値:

ボーダをペイントする場合は true、そうでない場合は false

関連項目:

setBorderPainted(boolean)

setBorderPainted

public void setBorderPainted(boolean b)

ボーダをペイントするかどうかを設定します。

パラメータ:

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

関連項目:

isBorderPainted()

paintBorder

protected void paintBorder(Graphics g)

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

オーバーライド:

クラス JComponent 内の paintBorder

パラメータ:

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

関連項目:

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

isFloatable

public boolean isFloatable()

ユーザが JToolbar をドラッグアウトできる場合に true を返します。

戻り値:

ユーザが JToolbar をドラッグアウトできる場合は true、そうでない場合は false

setFloatable

public void setFloatable(boolean b)

ツールバーを浮動状態にできるかどうかを設定します。

パラメータ:

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()

addSeparator

public void addSeparator()

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

addSeparator

public void addSeparator(Dimension size)

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

パラメータ:

size - セパレータの Dimension

add

public JButton add(Action a)

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

JDK 1.3 以降は、これはコンテナに Action を追加するメソッドとしてはお勧めしません。代わりに、setAction を使ってアクションを持つコントロールを設定し、そのコントロールを直接 Container に追加することをお奨めします。

パラメータ:

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

戻り値:

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

createActionComponent

protected JButton createActionComponent(Action a)

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

JDK 1.3 以降は、これは Container に Action を追加するメソッドとしてはお勧めしません。代わりに、setAction を使ってアクションを持つコントロールを設定し、そのコントロールを直接 Container に追加することをお勧めします。

パラメータ:

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

戻り値:

新しく作成されたボタン

関連項目:

Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JButton b)

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

JDK 1.3 以降は、これは Container に Action を追加するメソッドとしてはお勧めしません。代わりに、setAction を使ってアクションを持つコントロールを設定し、そのコントロールを直接 Container に追加することをお勧めします。

戻り値:

null

addImpl

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

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

オーバーライド:

クラス Container 内の addImpl

パラメータ:

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

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

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

paramString

protected String paramString()

この JToolBar の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列のコンテンツおよび形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス JComponent 内の paramString

戻り値:

この JToolBar の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス JComponent 内の getAccessibleContext

戻り値:

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