javax.swing
クラス JLabel

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

直接の既知のサブクラス:

BasicComboBoxRenderer, DefaultListCellRenderer, DefaultTableCellRenderer, DefaultTreeCellRenderer

public class JLabel

extends JComponent

implements SwingConstants, Accessible

短いテキスト文字列やイメージの表示領域です。両方を一緒に表示することもできます。ラベルは入力イベントには反応しません。そのため、ラベルはキーボードフォーカスを取得しません。しかし、近くにあるコンポーネントにキーボードショートカットが割り当てられていて、そのコンポーネントが自分でショートカットを表示できない場合には、ラベルを利用して表示することができます。

JLabel オブジェクトには、文字列やイメージを表示することができます。両方を一緒に表示することもできます。垂直方向と水平方向の配置方法を設定することによって、ラベルの表示領域内でのラベル内容の表示場所を指定することができます。デフォルトでは、ラベルは表示領域内で垂直方向に中央揃えされて表示されます。また、デフォルトでは、テキストのみのラベルは左揃えになり、イメージのみのラベルは水平方向に中央揃えされます。

また、イメージに対するテキストの位置を相対的に指定することもできます。デフォルトでは、テキストはイメージの右側に表示され、テキストとイメージの上端が揃えられます。

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

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

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

関連項目:

直列化された形式

内部クラスの概要

protected class

JLabel.AccessibleJLabel このオブジェクトのユーザ補助機能を取得するために使用するクラスです。

クラス javax.swing.JComponent から継承した内部クラス

JComponent.AccessibleJComponent

フィールドの概要

protected Component

labelFor

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

コンストラクタの概要

JLabel()
JLabel のインスタンスを、イメージなしの空の文字列で作成します。

JLabel(Icon image)
JLabel のインスタンスを、指定されたイメージで作成します。

JLabel(Icon image, int horizontalAlignment)
JLabel のインスタンスを、指定されたイメージと水平方向の配置方法で作成します。

JLabel(String text)
JLabel のインスタンスを、指定されたテキストで作成します。

JLabel(String text, Icon icon, int horizontalAlignment)
JLabel のインスタンスを、指定されたテキスト、イメージ、および水平方向の配置方法で作成します。

JLabel(String text, int horizontalAlignment)
JLabel のインスタンスを、指定されたテキストと水平方向の配置方法で作成します。

メソッドの概要

protected int	checkHorizontalKey(int key, String message) horizontalAlignment プロパティに対してキーが正当な値であるかどうかを判定します。
protected int	checkVerticalKey(int key, String message) verticalAlignment または verticalTextPosition プロパティに対してキーが正当な値であるかどうかを判定します。
AccessibleContext	getAccessibleContext() このオブジェクトの AccessibleContext を取得します。
Icon	getDisabledIcon() disabledIcon プロパティの値を返します。
int	getDisplayedMnemonic() ニーモニックキーを示すキーコードを返します。
int	getHorizontalAlignment() ラベルの内容の X 軸に沿った配置方法を返します。
int	getHorizontalTextPosition() ラベルテキストのイメージに対する水平位置を返します。
Icon	getIcon() ラベルに表示するグラフィックイメージ (グリフやアイコン) を返します。
int	getIconTextGap() このラベルに表示されているテキストとアイコンとの距離を返します。
Component	getLabelFor() このラベルが割り当てられているコンポーネントを返します。
String	getText() ラベルが表示するテキスト文字列を返します。
LabelUI	getUI() このコンポーネントを描画する L&F オブジェクトを返します。
String	getUIClassID() このコンポーネントを描画する L&F クラスの名前を指定する文字列を返します。
int	getVerticalAlignment() ラベルの内容の Y 軸に沿った配置方法を返します。
int	getVerticalTextPosition() ラベルテキストのイメージに対する垂直位置を返します。
protected String	paramString() この JLabel の文字列表現を返します。
void	setDisabledIcon(Icon disabledIcon) この JLabel が無効にされている (JLabel.setEnabled(false) が実行されている) 場合に表示されるアイコンを設定します。
void	setDisplayedMnemonic(char aChar) displayedMnemonic を char 値で設定します。
void	setDisplayedMnemonic(int key) ニーモニックキーを示すキーコードを設定します。
void	setHorizontalAlignment(int alignment) ラベルの内容の X 軸に沿った配置方法を設定します。
void	setHorizontalTextPosition(int textPosition) ラベルテキストのイメージに対する水平位置を設定します。
void	setIcon(Icon icon) このコンポーネントが表示するアイコンを定義します。
void	setIconTextGap(int iconTextGap) アイコンプロパティとテキストプロパティが両方とも設定されていれば、このプロパティはそれらの間の距離を定義します。
void	setLabelFor(Component c) このラベルが割り当てられるコンポーネントを設定します。
void	setText(String text) このコンポーネントが表示する 1 行のテキストを定義します。
void	setUI(LabelUI ui) このコンポーネントを描画する L&F オブジェクトを設定します。
void	setVerticalAlignment(int alignment) ラベルの内容の Y 軸に沿った配置方法を設定します。
void	setVerticalTextPosition(int textPosition) ラベルのイメージに対するテキストの垂直位置を設定します。
void	updateUI() L&F が変更されたことを示す UIFactory からの通知です。

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

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

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

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

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

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, 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, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, 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

フィールドの詳細

labelFor

protected Component labelFor

コンストラクタの詳細

JLabel

public JLabel(String text,
              Icon icon,
              int horizontalAlignment)

JLabel のインスタンスを、指定されたテキスト、イメージ、および水平方向の配置方法で作成します。ラベルは、表示領域内で垂直方向に中央揃えされます。テキストはイメージの右側に表示されます。

パラメータ:

text - ラベルに表示されるテキスト

icon - ラベルに表示されるイメージ

horizontalAlignment - SwingConstants で定義されている定数 LEFT、CENTER、または RIGHT のうちの 1 つ

JLabel

public JLabel(String text,
              int horizontalAlignment)

JLabel のインスタンスを、指定されたテキストと水平方向の配置方法で作成します。ラベルは、表示領域内で垂直方向に中央揃えされます。

パラメータ:

text - ラベルに表示されるテキスト

horizontalAlignment - SwingConstants で定義されている定数 LEFT、CENTER、または RIGHT のうちの 1 つ

JLabel

public JLabel(String text)

JLabel のインスタンスを、指定されたテキストで作成します。ラベルは、表示領域内で左揃えになり、垂直方向に中央揃えされます。

パラメータ:

text - ラベルに表示されるテキスト

JLabel

public JLabel(Icon image,
              int horizontalAlignment)

JLabel のインスタンスを、指定されたイメージと水平方向の配置方法で作成します。ラベルは、表示領域内で垂直方向に中央揃えされます。

パラメータ:

icon - ラベルに表示されるイメージ

horizontalAlignment - SwingConstants で定義されている定数 LEFT、CENTER、または RIGHT のうちの 1 つ

JLabel

public JLabel(Icon image)

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

パラメータ:

image - ラベルに表示されるイメージ

JLabel

public JLabel()

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

メソッドの詳細

getUI

public LabelUI getUI()

このコンポーネントを描画する L&F オブジェクトを返します。

戻り値:

LabelUI オブジェクト

setUI

public void setUI(LabelUI ui)

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

パラメータ:

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

関連項目:

UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

L&F が変更されたことを示す UIFactory からの通知です。

オーバーライド:

クラス JComponent 内の updateUI

関連項目:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

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

戻り値:

String "LabelUI"

オーバーライド:

クラス JComponent 内の getUIClassID

関連項目:

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

getText

public String getText()

ラベルが表示するテキスト文字列を返します。

戻り値:

String

関連項目:

setText(java.lang.String)

setText

public void setText(String text)

このコンポーネントが表示する 1 行のテキストを定義します。テキストが null や空文字列である場合には、何も表示されません。

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

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

関連項目:

setVerticalTextPosition(int), setHorizontalTextPosition(int), setIcon(javax.swing.Icon)

getIcon

public Icon getIcon()

ラベルに表示するグラフィックイメージ (グリフやアイコン) を返します。

戻り値:

Icon

関連項目:

setIcon(javax.swing.Icon)

setIcon

public void setIcon(Icon icon)

このコンポーネントが表示するアイコンを定義します。アイコンの値が null である場合には、何も表示されません。

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

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

関連項目:

setVerticalTextPosition(int), setHorizontalTextPosition(int), getIcon()

getDisabledIcon

public Icon getDisabledIcon()

disabledIcon プロパティの値を返します。このプロパティが設定されておらず、アイコンプロパティの値が ImageIcon である場合には、アイコンの「グレー表示」バージョンを計算して、disabledIcon プロパティをその値で更新します。

戻り値:

disabledIcon プロパティの値

関連項目:

setDisabledIcon(javax.swing.Icon), ImageIcon

setDisabledIcon

public void setDisabledIcon(Icon disabledIcon)

この JLabel が無効にされている (JLabel.setEnabled(false) が実行されている) 場合に表示されるアイコンを設定します。

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

パラメータ:

disabledIcon - コンポーネントが無効である場合に表示される Icon

関連項目:

getDisabledIcon(), JComponent.setEnabled(boolean)

setDisplayedMnemonic

public void setDisplayedMnemonic(int key)

ニーモニックキーを示すキーコードを設定します。このプロパティは、ラベルが大きなコンポーネントの一部である場合に使用します。ラベルの labelFor プロパティが null でない場合、ラベルはニーモニックの起動時に、labelFor プロパティで指定されているコンポーネントの requestFocus メソッドを呼び出します。

関連項目:

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)

checkHorizontalKey

protected int checkHorizontalKey(int key,
                                 String message)

horizontalAlignment プロパティに対してキーが正当な値であるかどうかを判定します。

パラメータ:

key - チェックするプロパティ値

message - IllegalArgumentException の詳細メッセージ

例外:

IllegalArgumentException - キーが LEFT、CENTER、RIGHT、LEADING、TRAILING のどれでもない場合

関連項目:

setHorizontalTextPosition(int), setHorizontalAlignment(int)

checkVerticalKey

protected int checkVerticalKey(int key,
                               String message)

verticalAlignment または verticalTextPosition プロパティに対してキーが正当な値であるかどうかを判定します。

パラメータ:

key - チェックするプロパティ値

message - IllegalArgumentException の詳細メッセージ

例外:

IllegalArgumentException - キーが TOP、CENTER、または BOTTOM ではない場合

関連項目:

setVerticalAlignment(int), setVerticalTextPosition(int)

getIconTextGap

public int getIconTextGap()

このラベルに表示されているテキストとアイコンとの距離を返します。

戻り値:

テキスト、アイコン間のピクセル数。int 値

関連項目:

setIconTextGap(int)

setIconTextGap

public void setIconTextGap(int iconTextGap)

アイコンプロパティとテキストプロパティが両方とも設定されていれば、このプロパティはそれらの間の距離を定義します。

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

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

関連項目:

getIconTextGap()

getVerticalAlignment

public int getVerticalAlignment()

ラベルの内容の Y 軸に沿った配置方法を返します。

戻り値:

verticalAlignment プロパティの値。SwingConstants で定義されている定数 TOP、CENTER、または BOTTOM のうちの 1 つ

関連項目:

SwingConstants, setVerticalAlignment(int)

setVerticalAlignment

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 のうちの 1 つ

関連項目:

setHorizontalAlignment(int), SwingConstants

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

ラベルの内容の X 軸に沿った配置方法を設定します。

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

パラメータ:

alignment - SwingConstants で定義されている定数。LEFT (テキストのみのラベルのデフォルト)、CENTER (イメージのみのラベルのデフォルト)、RIGHT、LEADING、TRAILING のどれか

関連項目:

SwingConstants, getHorizontalAlignment()

getVerticalTextPosition

public int getVerticalTextPosition()

ラベルテキストのイメージに対する垂直位置を返します。

戻り値:

SwingConstants で定義されている定数 TOP、CENTER、または BOTTOM のうちの 1 つ

関連項目:

setVerticalTextPosition(int), SwingConstants

setVerticalTextPosition

public void setVerticalTextPosition(int textPosition)

ラベルのイメージに対するテキストの垂直位置を設定します。

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

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

パラメータ:

textPosition - SwingConstants で定義されている定数 TOP、CENTER、または BOTTOM のうちの 1 つ

関連項目:

SwingConstants, getVerticalTextPosition()

getHorizontalTextPosition

public int getHorizontalTextPosition()

ラベルテキストのイメージに対する水平位置を返します。

戻り値:

SwingConstants で定義されている定数。LEFT、CENTER、RIGHT のどれか

関連項目:

SwingConstants

setHorizontalTextPosition

public void setHorizontalTextPosition(int textPosition)

ラベルテキストのイメージに対する水平位置を設定します。

パラメータ:

textPosition - SwingConstants で定義されている定数 LEFT、CENTER、RIGHT (デフォルト)、LEADING、または TRAILING のうちの 1 つ

例外:

IllegalArgumentException -

関連項目:

SwingConstants

paramString

protected String paramString()

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

JFC コンポーネントの新しい側面についての情報を返すには、paramString() をオーバーライドします。

戻り値:

この JLabel の文字列表現

オーバーライド:

クラス JComponent 内の paramString

getAccessibleContext

public AccessibleContext getAccessibleContext()

このオブジェクトの AccessibleContext を取得します。

定義:

インタフェース Accessible 内の getAccessibleContext

戻り値:

このオブジェクトの AccessibleContext

オーバーライド:

クラス JComponent 内の getAccessibleContext

getLabelFor

public Component getLabelFor()

このラベルが割り当てられているコンポーネントを返します。

戻り値:

このラベルが割り当てられているコンポーネント。このラベルがコンポーネントに割り当てられていない場合は null。displayedMnemonic プロパティが設定されていて、labelFor プロパティも設定されている場合には、ラベルはニーモニックの起動時に、labelFor プロパティで指定されているコンポーネントの requestFocus メソッドを呼び出す

関連項目:

getDisplayedMnemonic(), setDisplayedMnemonic(int)

setLabelFor

public void setLabelFor(Component c)

このラベルが割り当てられるコンポーネントを設定します。このラベルがコンポーネントに割り当てられていない場合は null を返します。displayedMnemonic プロパティが設定されていて、labelFor プロパティも設定されている場合には、ラベルはニーモニックの起動時に、labelFor プロパティで指定されているコンポーネントの requestFocus メソッドを呼び出します。

パラメータ:

c - ラベルが割り当てられているコンポーネント。ラベルがコンポーネントに割り当てられていない場合は null

関連項目:

getDisplayedMnemonic(), setDisplayedMnemonic(int)