モジュール java.desktop
パッケージ 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」を参照してください。

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

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

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

    導入されたバージョン:
    1.2
    関連項目:
    Action, 「直列化されたフォーム」

    • コンストラクタの詳細

      • 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

    • メソッドの詳細

      • updateUI

        public void updateUI​()
        L&Fが変更されたことを示す、UIFactoryからの通知です。 UIをUIFactoryからの最新バージョンに置き換えるために呼び出されます。
        オーバーライド:
        updateUI 、クラス:  JComponent
        関連項目:
        JComponent.updateUI()

      • 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です。 Look & Feelによっては、ボーダーのペイントが実装されていない場合があります。その場合、このプロパティは無視されます。
        パラメータ:
        b - trueの場合はボーダーがペイントされる
        関連項目:
        isBorderPainted()

      • 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です。 Look & Feelによっては、移動可能なツールバーが実装されていない場合があります。その場合、このプロパティは無視されます。
        パラメータ:
        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です。

        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が返されます。
        パラメータ:
        b - JButton
        戻り値:
        null

      • 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

        @BeanProperty(bound=false)
public AccessibleContext getAccessibleContext​()
        このJToolBarに関連付けられたAccessibleContextを取得します。 ツールバーの場合、AccessibleContextはAccessibleJToolBarの形式を取ります。 必要に応じて新規のAccessibleJToolBarインスタンスが作成されます。
        定義:
        getAccessibleContext 、インタフェース: Accessible
        オーバーライド:
        getAccessibleContext、クラス: Component
        戻り値:
        このJToolBarのAccessibleContextとして機能するAccessibleJToolBar