javax.swing
类 JLabel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLabel

所有已实现的接口：

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

直接已知子类：

BasicComboBoxRenderer, DefaultListCellRenderer, DefaultTableCellRenderer, DefaultTreeCellRenderer

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（Remote Method Invocation，远程方法调用）。从 1.4 版本开始，已在 java.beans 包中添加了支持所有 JavaBeans^TM 长期存储的功能。请参见 XMLEncoder。

labelFor

protected Component labelFor

JLabel

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

创建具有指定文本、图像和水平对齐方式的 JLabel 实例。该标签在其显示区内垂直居中对齐。文本位于图像的结尾边上。

参数：

text - 由标签显示的文本。

icon - 由标签显示的图像。

horizontalAlignment - SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

JLabel

public JLabel(String text,
              int horizontalAlignment)

创建具有指定文本和水平对齐方式的 JLabel 实例。该标签在其显示区内垂直居中对齐。

参数：

text - 由标签显示的文本。

horizontalAlignment - 在 SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

JLabel

public JLabel(String text)

创建具有指定文本的 JLabel 实例。该标签与其显示区的开始边对齐，并垂直居中。

参数：

text - 由标签显示的文本。

JLabel

public JLabel(Icon image,
              int horizontalAlignment)

创建具有指定图像和水平对齐方式的 JLabel 实例。该标签在其显示区内垂直居中对齐。

参数：

image - 由标签显示的图像。

horizontalAlignment - 在 SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

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

将 UI 属性重置为当前外观的值。

覆盖：

类 JComponent 中的 updateUI

另请参见：

JComponent.updateUI()

getUIClassID

public String getUIClassID()

返回一个指定 L&F 类名称的字符串，该类呈现此组件。

覆盖：

类 JComponent 中的 getUIClassID

返回：

字符串 "LabelUI"

另请参见：

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

getText

public String getText()

返回该标签所显示的文本字符串。

返回：

一个 String

另请参见：

setText(java.lang.String)

setText

public void setText(String text)

定义此组件将要显示的单行文本。如果 text 值为 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)

定义此组件将要显示的图标。如果 icon 值为 null，则什么也不显示。

此属性的默认值为 null。

这是一个 JavaBeans 绑定属性。

另请参见：

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

getDisabledIcon

public Icon getDisabledIcon()

返回该标签被禁用时所使用的图标。如果尚未设置禁用图标，则此方法将转发对外观的调用，以构造一个合适的禁用图标。

某些外观可能无法呈现禁用图标，在此情况下，外观将忽略此图标。

返回：

disabledIcon 属性

另请参见：

setDisabledIcon(javax.swing.Icon), LookAndFeel.getDisabledIcon(javax.swing.JComponent, javax.swing.Icon), ImageIcon

setDisabledIcon

public void setDisabledIcon(Icon disabledIcon)

设置如果此 JLabel 是“禁用的”(JLabel.setEnabled(false))，则要显示的图标。

此属性的默认值为 null。

参数：

disabledIcon - 组件禁用时要显示的图标

另请参见：

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)

setDisplayedMnemonicIndex

public void setDisplayedMnemonicIndex(int index)
                               throws IllegalArgumentException

关于应该装饰文本中的哪个字符以表示助记符，为外观提供一个提示。并非所有的外观都支持此功能。值 -1 指示没有助记符（字符串中不包含该助记符），或者开发人员不希望显示该助记符。

此值随着与助记符相关属性的变化（如助记符本身、文本……）而得到更新。只有不希望对默认字符加下划线时，才必须调用此方法。例如，如果文本为 'Save As'，助记符为 'a'，而您希望装饰 'A'，使文本显示为 'Save As'，那么您必须在调用 setDisplayedMnemonic(KeyEvent.VK_A) 之后调用 setDisplayedMnemonicIndex(5)。

参数：

index - 要加下划线的 String 中的索引

抛出：

IllegalArgumentException - 在 index >= 文本长度或< -1 时抛出

从以下版本开始：

1.4

getDisplayedMnemonicIndex

public int getDisplayedMnemonicIndex()

以索引的形式返回字符，外观应提供该字符的装饰以表示助记符。

返回：

表示助记符的索引

从以下版本开始：

1.4

另请参见：

setDisplayedMnemonicIndex(int)

checkHorizontalKey

protected int checkHorizontalKey(int key,
                                 String message)

验证该键是否为 horizontalAlignment 属性的合法值。

参数：

key - 要检查的属性值

message - IllegalArgumentException 详细消息

抛出：

IllegalArgumentException - 如果 key 不是 LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

另请参见：

setHorizontalTextPosition(int), setHorizontalAlignment(int)

checkVerticalKey

protected int checkVerticalKey(int key,
                               String message)

验证该键是否为 verticalAlignment 或 verticalTextPosition 属性的合法值。

参数：

key - 要检查的属性值

message - IllegalArgumentException 详细消息

抛出：

IllegalArgumentException - 如果 key 不是 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。

另请参见：

SwingConstants, setVerticalAlignment(int)

setVerticalAlignment

public void setVerticalAlignment(int alignment)

设置标签内容沿 Y 轴的对齐方式。

此属性的默认值为 CENTER。

参数：

alignment - SwingConstants 中定义的以下常量之一：TOP、CENTER（默认）或 BOTTOM。

另请参见：

SwingConstants, getVerticalAlignment()

getHorizontalAlignment

public int getHorizontalAlignment()

返回标签内容沿 X 轴的对齐方式。

返回：

horizontalAlignment 属性的值，为 SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

另请参见：

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。

另请参见：

setVerticalTextPosition(int), SwingConstants

setVerticalTextPosition

public void setVerticalTextPosition(int textPosition)

设置标签的文本相对其图像的垂直位置。

此属性的默认值为 CENTER。

这是一个 JavaBeans 绑定属性。

参数：

textPosition - SwingConstants 中定义的以下常量之一：TOP、CENTER（默认）或 BOTTOM。

另请参见：

SwingConstants, getVerticalTextPosition()

getHorizontalTextPosition

public int getHorizontalTextPosition()

返回标签的文本相对其图像的水平位置。

返回：

SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING。

另请参见：

SwingConstants

setHorizontalTextPosition

public void setHorizontalTextPosition(int textPosition)

设置标签的文本相对其图像的水平位置。

参数：

textPosition - SwingConstants 中定义的以下常量之一：LEFT、CENTER、RIGHT、LEADING 或 TRAILING（默认）。

抛出：

IllegalArgumentException

另请参见：

SwingConstants

imageUpdate

public boolean imageUpdate(Image img,
                           int infoflags,
                           int x,
                           int y,
                           int w,
                           int h)

如果当前图标的图像不等于传入的图像 img，则重写此方法以返回 false。

指定者：

接口 ImageObserver 中的 imageUpdate

覆盖：

类 Component 中的 imageUpdate

参数：

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。

覆盖：

类 JComponent 中的 paramString

返回：

此 JLabel 的字符串表示形式。

getLabelFor

public Component getLabelFor()

获取要添加标签的组件。

返回：

要添加标签的 Component。如果无法为 Component 添加标签，则返回值可以为 null。如果设置了 displayedMnemonic 和 labelFor 属性，则助记符被激活时，标签将调用 labelFor 属性所指定组件的 requestFocus 方法。

另请参见：

getDisplayedMnemonic(), setDisplayedMnemonic(int)

setLabelFor

public void setLabelFor(Component c)

设置要添加标签的组件。如果无法为 Component 添加标签，则返回值可以为 null。如果设置了 displayedMnemonic 和 labelFor 属性，则助记符被激活时，标签将调用 labelFor 属性所指定组件的 requestFocus 方法。

参数：

c - 要添加此标签的 Component，如果该标签不是组件的标签，则为 null

另请参见：

getDisplayedMnemonic(), setDisplayedMnemonic(int)

getAccessibleContext

public AccessibleContext getAccessibleContext()

获得此对象的 AccessibleContext。

指定者：

接口 Accessible 中的 getAccessibleContext

覆盖：

类 JComponent 中的 getAccessibleContext

返回：

此对象的 AccessibleContext

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策。