モジュール java.desktop
パッケージ javax.swing

クラスJLabel

  • すべての実装されたインタフェース:
    ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants
    直系の既知のサブクラス:
    BasicComboBoxRenderer, DefaultListCellRenderer, DefaultTableCellRenderer, DefaultTreeCellRenderer
    @JavaBean(defaultProperty="UI",
          description="A component that displays a short string and an icon.")
public class JLabel
extends JComponent
implements SwingConstants, Accessible
    短いテキスト文字列やイメージの表示領域です。両方を一緒に表示することもできます。 ラベルは入力イベントには反応しません。 そのため、ラベルはキーボード・フォーカスを取得できません。 ただし、隣接するコンポーネントにキーボード・ショートカットが割り当てられていて、そのコンポーネントがショートカットを表示できない場合は、ラベルを利用してショートカットを表示できます。

    JLabelオブジェクトには、テキスト、イメージまたはその両方を表示できます。 垂直方向と水平方向の位置合せ方法を設定することによって、ラベルの表示領域内でのラベル内容の表示場所を指定できます。 デフォルトでは、ラベルは表示領域内で垂直方向に中央揃えで配置されます。 テキストのみのラベルは、デフォルトではリーディング・エッジに揃えて配置されます。イメージのみのラベルは、デフォルトでは水平方向に中央揃えで配置されます。

    また、イメージに対するテキストの位置を相対的に指定することもできます。 デフォルトでは、テキストはイメージのトレーリング・エッジに表示され、テキストとイメージは垂直方向にそろえられます。

    ラベルのリーディング・エッジおよびトレーリング・エッジは、ComponentOrientationプロパティの値から判定されます。 現在では、デフォルトのComponentOrientation設定は、リーディング・エッジが左、トレーリング・エッジが右にマッピングされています。

    さらに、setIconTextGapメソッドを使用して、テキストとイメージの間の距離をピクセル数で指定することができます。 デフォルトは4ピクセルです。

    詳細は、「The Java Tutorial」の「How to Use Labels」を参照してください。

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

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

    導入されたバージョン:
    1.2
    関連項目:
    直列化された形式

    • フィールドの詳細

      • labelFor

        protected Component labelFor
        このラベルのコンポーネントです; ラベルがコンポーネントのラベルでない場合はnull

    • コンストラクタの詳細

      • JLabel

        public JLabel​(String text,
              Icon icon,
              int horizontalAlignment)
        指定されたテキスト、イメージ、および水平方向の配置方法で、JLabelのインスタンスを作成します。 ラベルは、表示領域内で垂直方向に中央揃えされます。 テキストはイメージのトレーリング・エッジに表示されます。
        パラメータ:
        text - ラベルに表示されるテキスト。
        icon - ラベルに表示されるイメージ。
        horizontalAlignment - SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILINGのうちの1つ。

      • JLabel

        public JLabel​(String text,
              int horizontalAlignment)
        JLabelのインスタンスを、指定されたテキストと水平方向の配置方法で作成します。 ラベルは、表示領域内で垂直方向に中央揃えされます。
        パラメータ:
        text - ラベルに表示されるテキスト。
        horizontalAlignment - SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILINGのうちの1つ。

      • JLabel

        public JLabel​(String text)
        JLabelのインスタンスを、指定されたテキストで作成します。 ラベルは、表示領域のリーディング・エッジにそろえられ、垂直方向に中央揃えされます。
        パラメータ:
        text - ラベルに表示されるテキスト。

      • JLabel

        public JLabel​(Icon image,
              int horizontalAlignment)
        JLabelのインスタンスを、指定されたイメージと水平方向の配置方法で作成します。 ラベルは、表示領域内で垂直方向に中央揃えされます。
        パラメータ:
        image - ラベルに表示されるイメージ。
        horizontalAlignment - SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILINGのうちの1つ。

      • JLabel

        public JLabel​(Icon image)
        JLabelのインスタンスを、指定されたイメージで作成します。 ラベルは、表示領域内で垂直方向と水平方向に中央揃えされます。
        パラメータ:
        image - ラベルに表示されるイメージ。

      • JLabel

        public JLabel()
        JLabelのインスタンスを、イメージなしの空のタイトル文字列で作成します。 ラベルは、表示領域内で垂直方向に中央揃えされます。 ラベルの内容が設定されると、ラベルは表示領域のリーディング・エッジに表示されます。

    • メソッドの詳細

      • getUI

        public LabelUI getUI()
        このコンポーネントを描画するL&Fオブジェクトを返します。
        オーバーライド:
        クラスJComponentのgetUI
        戻り値:
        LabelUIオブジェクト

      • updateUI

        public void updateUI()
        現在のLook & Feelからの値にUIプロパティをリセットします。
        オーバーライド:
        updateUI 、クラス:  JComponent
        関連項目:
        JComponent.updateUI()

      • getText

        public String getText()
        ラベルが表示するテキスト文字列を返します。
        戻り値:
        文字列
        関連項目:
        setText(java.lang.String)

      • getIcon

        public Icon getIcon()
        ラベルに表示するグラフィック・イメージ(グリフやアイコン)を返します。
        戻り値:
        アイコン
        関連項目:
        setIcon(javax.swing.Icon)

      • setIcon

        @BeanProperty(preferred=true,
              visualUpdate=true,
              description="The icon this component will display.")
public void setIcon​(Icon icon)
        このコンポーネントが表示するアイコンを定義します。 アイコンの値がnullである場合には、何も表示されません。

        このプロパティのデフォルト値はnullです。

        これはJavaBeansバウンド・プロパティです。

        パラメータ:
        icon - このコンポーネントが表示するデフォルトのアイコン
        関連項目:
        setVerticalTextPosition(int), setHorizontalTextPosition(int), getIcon()

      • getDisabledIcon

        public Icon getDisabledIcon()
        無効な状態のラベルのアイコンを返します。 無効な状態のアイコンが設定されていない場合は、呼出しがLook & Feelに転送されて、適切な状態のアイコンが構築されます。

        Look & Feelによっては無効な状態のアイコンがレンダリングされないことがあり、その場合、無効な状態のアイコンは無視されます。

        戻り値:
        disabledIconプロパティ
        関連項目:
        setDisabledIcon(javax.swing.Icon), LookAndFeel.getDisabledIcon(javax.swing.JComponent, javax.swing.Icon), ImageIcon

      • setDisabledIcon

        @BeanProperty(visualUpdate=true,
              description="The icon to display if the label is disabled.")
public void setDisabledIcon​(Icon disabledIcon)
        このJLabelが無効にされている(JLabel.setEnabled(false)が実行されている)場合に表示されるアイコンを設定します。

        このプロパティのデフォルト値はnullです。

        パラメータ:
        disabledIcon - コンポーネントが無効である場合に表示されるIcon
        関連項目:
        getDisabledIcon(), JComponent.setEnabled(boolean)

      • setDisplayedMnemonic

        @BeanProperty(visualUpdate=true,
              description="The mnemonic keycode.")
public void setDisplayedMnemonic​(int key)
        ニーモニック・キーを示すキー・コードを設定します。 このプロパティは、ラベルが大きなコンポーネントの一部である場合に使用します。 ラベルのlabelForプロパティがnullでない場合、ラベルはニーモニックの起動時に、labelForプロパティで指定されているコンポーネントのrequestFocusメソッドを呼び出します。
        パラメータ:
        key - ニーモニック・キーを示すキー・コード
        関連項目:
        getLabelFor(), setLabelFor(java.awt.Component)

      • setDisplayedMnemonic

        public void setDisplayedMnemonic​(char aChar)
        displayedMnemonicをchar値で設定します。
        パラメータ:
        aChar - 表示されるニーモニックを指定するchar
        関連項目:
        setDisplayedMnemonic(int)

      • getDisplayedMnemonic

        public int getDisplayedMnemonic()
        ニーモニック・キーを示すキー・コードを返します。 このプロパティは、ラベルが大きなコンポーネントの一部である場合に使用します。 ラベルのlabelForプロパティがnullでない場合、ラベルはニーモニックの起動時に、labelForプロパティで指定されているコンポーネントのrequestFocusメソッドを呼び出します。
        戻り値:
        ニーモニック・キーのコードを示すint値
        関連項目:
        getLabelFor(), setLabelFor(java.awt.Component)

      • setDisplayedMnemonicIndex

        @BeanProperty(visualUpdate=true,
              description="the index into the String to draw the keyboard character mnemonic at")
public void setDisplayedMnemonicIndex​(int index)
                               throws IllegalArgumentException
        ニーモニックを表すためにテキストのどの文字を装飾するかについてのヒントを、Look & Feelに提供します。 すべてのLook & Feelがこれをサポートしているわけではありません。 値 -1はニーモニックがないか、ニーモニック文字が文字列に含まれていないか、開発者がニーモニックを表示させないようにしていることを示します。

        この値は、ニーモニックの変更(ニーモニック自身またはテキストの変更など)に関連するプロパティとして更新されます。 デフォルトの文字を下線付きでないようにする場合、これだけを呼び出す必要があります。 たとえば、ニーモニック「a」を持つテキスト「Save As」について、「Save As」のようにAを修飾する場合は、setDisplayedMnemonic(KeyEvent.VK_A)を呼び出してからsetDisplayedMnemonicIndex(5)を呼び出します。

        パラメータ:
        index - 下線を付けるStringに対するインデックス
        例外:
        IllegalArgumentException - indexがテキストの長さ以上、または -1より小さい場合にスローされる
        導入されたバージョン:
        1.4

      • getDisplayedMnemonicIndex

        public int getDisplayedMnemonicIndex()
        Look & Feelがニーモニック文字を表すための修飾を提供する文字をインデックスとして返します。
        戻り値:
        ニーモニック文字を表すインデックス
        導入されたバージョン:
        1.4
        関連項目:
        setDisplayedMnemonicIndex(int)

      • checkHorizontalKey

        protected int checkHorizontalKey​(int key,
                                 String message)
        horizontalAlignmentプロパティに対してキーが正当な値であるかどうかを判定します。
        パラメータ:
        key - チェックするプロパティ値
        message - IllegalArgumentExceptionの詳細メッセージ
        戻り値:
        keyがhorizontalAlignmentプロパティの正当な値である場合のキー値
        例外:
        IllegalArgumentException - キーがLEFT、CENTER、RIGHT、LEADING、TRAILINGのどれでもない場合。
        関連項目:
        setHorizontalTextPosition(int), setHorizontalAlignment(int)

      • checkVerticalKey

        protected int checkVerticalKey​(int key,
                               String message)
        verticalAlignmentまたはverticalTextPositionプロパティに対してキーが正当な値であるかどうかを判定します。
        パラメータ:
        key - チェックするプロパティ値
        message - IllegalArgumentExceptionの詳細メッセージ
        戻り値:
        keyがverticalAlignmentまたはverticalTextPositionプロパティの正当な値である場合のキー値
        例外:
        IllegalArgumentException - キーがTOP、CENTER、またはBOTTOMではない場合。
        関連項目:
        setVerticalAlignment(int), setVerticalTextPosition(int)

      • getIconTextGap

        public int getIconTextGap()
        このラベルに表示されているテキストとアイコンとの距離を返します。
        戻り値:
        テキスト、アイコン間のピクセル数を示すint値。
        関連項目:
        setIconTextGap(int)

      • setIconTextGap

        @BeanProperty(visualUpdate=true,
              description="If both the icon and text properties are set, this property defines the space between them.")
public void setIconTextGap​(int iconTextGap)
        アイコン・プロパティとテキスト・プロパティが両方とも設定されている場合に、このプロパティはそれらの間の距離を定義します。

        このプロパティのデフォルト値は4ピクセルです。

        これはJavaBeansバウンド・プロパティです。

        パラメータ:
        iconTextGap - アイコンとテキスト・プロパティの間のスペース
        関連項目:
        getIconTextGap()

      • getVerticalAlignment

        public int getVerticalAlignment()
        ラベルの内容のY軸に沿った配置方法を返します。
        戻り値:
        verticalAlignmentプロパティの値。SwingConstantsで定義されている定数TOP、CENTER、またはBOTTOMのうちの1つ。
        関連項目:
        SwingConstants, setVerticalAlignment(int)

      • setVerticalAlignment

        @BeanProperty(visualUpdate=true,
              enumerationValues={"SwingConstants.TOP","SwingConstants.CENTER","SwingConstants.BOTTOM"},
              description="The alignment of the label\'s contents along the Y axis.")
public void setVerticalAlignment​(int alignment)
        ラベルの内容のY軸に沿った配置方法を設定します。

        このプロパティのデフォルト値はCENTERです。

        パラメータ:
        alignment - SwingConstantsで定義されている定数TOP、CENTER (デフォルト)、またはBOTTOMのうちの1つ。
        関連項目:
        SwingConstants, getVerticalAlignment()

      • getHorizontalAlignment

        public int getHorizontalAlignment()
        ラベルの内容のX軸に沿った配置方法を返します。
        戻り値:
        horizontalAlignmentプロパティの値。SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILINGのうちの1つ。
        関連項目:
        setHorizontalAlignment(int), SwingConstants

      • setHorizontalAlignment

        @BeanProperty(visualUpdate=true,
              enumerationValues={"SwingConstants.LEFT","SwingConstants.CENTER","SwingConstants.RIGHT","SwingConstants.LEADING","SwingConstants.TRAILING"},
              description="The alignment of the label\'s content along the X axis.")
public void setHorizontalAlignment​(int alignment)
        ラベルの内容のX軸に沿った配置方法を設定します。

        これはJavaBeansバウンド・プロパティです。

        パラメータ:
        alignment - SwingConstantsで定義されている定数LEFT、CENTER (イメージのみのラベルのデフォルト)、RIGHT、LEADING (テキストのみのラベルのデフォルト)、TRAILINGのうちの1つ。
        関連項目:
        SwingConstants, getHorizontalAlignment()

      • getVerticalTextPosition

        public int getVerticalTextPosition()
        ラベル・テキストのイメージに対する垂直位置を返します。
        戻り値:
        SwingConstantsで定義されている定数TOP、CENTER、またはBOTTOMのうちの1つ。
        関連項目:
        setVerticalTextPosition(int), SwingConstants

      • setVerticalTextPosition

        @BeanProperty(expert=true,
              visualUpdate=true,
              enumerationValues={"SwingConstants.TOP","SwingConstants.CENTER","SwingConstants.BOTTOM"},
              description="The vertical position of the text relative to it\'s image.")
public void setVerticalTextPosition​(int textPosition)
        ラベルのイメージに対するテキストの垂直位置を設定します。

        このプロパティのデフォルト値はCENTERです。

        これはJavaBeansバウンド・プロパティです。

        パラメータ:
        textPosition - SwingConstantsで定義されている定数TOP、CENTER (デフォルト)、またはBOTTOMのうちの1つ。
        関連項目:
        SwingConstants, getVerticalTextPosition()

      • getHorizontalTextPosition

        public int getHorizontalTextPosition()
        ラベル・テキストのイメージに対する水平位置を返します。
        戻り値:
        SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILINGのうちの1つ。
        関連項目:
        SwingConstants

      • setHorizontalTextPosition

        @BeanProperty(expert=true,
              visualUpdate=true,
              enumerationValues={"SwingConstants.LEFT","SwingConstants.CENTER","SwingConstants.RIGHT","SwingConstants.LEADING","SwingConstants.TRAILING"},
              description="The horizontal position of the label\'s text, relative to its image.")
public void setHorizontalTextPosition​(int textPosition)
        ラベル・テキストのイメージに対する水平位置を設定します。
        パラメータ:
        textPosition - SwingConstantsで定義されている定数LEFT、CENTER、RIGHT、LEADING、またはTRAILING (デフォルト)のうちの1つ。
        関連項目:
        SwingConstants

      • imageUpdate

        public boolean imageUpdate​(Image img,
                           int infoflags,
                           int x,
                           int y,
                           int w,
                           int h)
        現在のIconのImageが、渡されたImage imgと異なる場合は、オーバーライドされてfalseを返します。
        定義:
        imageUpdate 、インタフェース: ImageObserver
        オーバーライド:
        imageUpdate 、クラス:  Component
        パラメータ:
        img - 監視対象のイメージ
        infoflags - 詳細は、imageUpdateを参照してください
        x - x座標
        y - y座標
        w - 幅
        h - 高さ
        戻り値:
        イメージ全体がロードされることをinfoflagsが示す場合はfalse、そうでない場合はtrue。
        関連項目:
        ImageObserver、Component.imageUpdate(java.awt.Image, int, int, int, int, int)

      • paramString

        protected String paramString()
        このJLabelの文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。 返される文字列は空の場合がありますが、nullにはなりません。
        オーバーライド:
        paramString 、クラス:  JComponent
        戻り値:
        このJLabelの文字列表現。

      • getLabelFor

        public Component getLabelFor()
        このラベルが割り当てられているコンポーネントを返します。
        戻り値:
        このラベルが割り当てられているコンポーネント。 このラベルがコンポーネントに割り当てられていない場合はnullを返します。 displayedMnemonicプロパティが設定されていて、labelForプロパティも設定されている場合には、ラベルはニーモニックがアクティブになったときに、labelForプロパティで指定されているコンポーネントのrequestFocusメソッドを呼び出します。
        関連項目:
        getDisplayedMnemonic(), setDisplayedMnemonic(int)

      • setLabelFor

        @BeanProperty(description="The component this is labelling.")
public void setLabelFor​(Component c)
        このラベルが割り当てられているコンポーネントを設定します。 このラベルがコンポーネントに割り当てられていない場合はnullを返します。 displayedMnemonicプロパティが設定されていて、labelForプロパティも設定されている場合には、ラベルはニーモニックがアクティブになったときに、labelForプロパティで指定されているコンポーネントのrequestFocusメソッドを呼び出します。
        パラメータ:
        c - ラベルが割り当てられているコンポーネント。ラベルがコンポーネントに割り当てられていない場合はnull
        関連項目:
        getDisplayedMnemonic(), setDisplayedMnemonic(int)