public class JLabel extends JComponent implements SwingConstants, Accessible
A display area for a short text string or an image, or both. A label does not react to input events. As a result, it cannot get the keyboard focus. A label can, however, display a keyboard alternative as a convenience for a nearby component that has a keyboard alternative but can't display it.
A JLabel object can display either text, an image, or both. You can specify where in the label's display area the label's contents are aligned by setting the vertical and horizontal alignment. By default, labels are vertically centered in their display area. Text-only labels are leading edge aligned, by default; image-only labels are horizontally centered, by default.
You can also specify the position of the text relative to the image. By default, text is on the trailing edge of the image, with the text and image vertically aligned.
A label's leading and trailing edge are determined from the value of its ComponentOrientation property. At present, the default ComponentOrientation setting maps the leading edge to left and the trailing edge to right.
Finally, you can use the setIconTextGap method to specify how many pixels should appear between the text and the image. The default is 4 pixels.
See How to Use Labels in The Java Tutorial for further documentation.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
| Modifier and Type | Class and Description |
|---|---|
protected class |
JLabel.AccessibleJLabel The class used to obtain the accessible role for this object. |
JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy protected Component labelFor
public JLabel(String text,
Icon icon,
int horizontalAlignment) Creates a JLabel instance with the specified text, image, and horizontal alignment. The label is centered vertically in its display area. The text is on the trailing edge of the image.
text - The text to be displayed by the label.icon - The image to be displayed by the label.horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.public JLabel(String text,
int horizontalAlignment) Creates a JLabel instance with the specified text and horizontal alignment. The label is centered vertically in its display area.
text - The text to be displayed by the label.horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.public JLabel(String text)
Creates a JLabel instance with the specified text. The label is aligned against the leading edge of its display area, and centered vertically.
text - The text to be displayed by the label.public JLabel(Icon image,
int horizontalAlignment) Creates a JLabel instance with the specified image and horizontal alignment. The label is centered vertically in its display area.
image - The image to be displayed by the label.horizontalAlignment - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.public JLabel(Icon image)
Creates a JLabel instance with the specified image. The label is centered vertically and horizontally in its display area.
image - The image to be displayed by the label.public JLabel()
Creates a JLabel instance with no image and with an empty string for the title. The label is centered vertically in its display area. The label's contents, once set, will be displayed on the leading edge of the label's display area.
public LabelUI getUI()
Returns the L&F object that renders this component.
public void setUI(LabelUI ui)
Sets the L&F object that renders this component.
ui - the LabelUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public void updateUI()
Resets the UI property to a value from the current look and feel.
updateUI in class JComponent
JComponent.updateUI()public String getUIClassID()
Returns a string that specifies the name of the l&f class that renders this component.
getUIClassID in class JComponent
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)
public String getText()
Returns the text string that the label displays.
setText(java.lang.String)public void setText(String text)
Defines the single line of text this component will display. If the value of text is null or empty string, nothing is displayed.
The default value of this property is null.
This is a JavaBeans bound property.
public Icon getIcon()
Returns the graphic image (glyph, icon) that the label displays.
setIcon(javax.swing.Icon)public void setIcon(Icon icon)
Defines the icon this component will display. If the value of icon is null, nothing is displayed.
The default value of this property is null.
This is a JavaBeans bound property.
public Icon getDisabledIcon()
Returns the icon used by the label when it's disabled. If no disabled icon has been set this will forward the call to the look and feel to construct an appropriate disabled Icon.
Some look and feels might not render the disabled Icon, in which case they will ignore this.
disabledIcon propertysetDisabledIcon(javax.swing.Icon), LookAndFeel.getDisabledIcon(javax.swing.JComponent, javax.swing.Icon), ImageIcon
public void setDisabledIcon(Icon disabledIcon)
Set the icon to be displayed if this JLabel is "disabled" (JLabel.setEnabled(false)).
The default value of this property is null.
disabledIcon - the Icon to display when the component is disabledgetDisabledIcon(), JComponent.setEnabled(boolean)
public void setDisplayedMnemonic(int key)
Specify a keycode that indicates a mnemonic key. This property is used when the label is part of a larger component. If the labelFor property of the label is not null, the label will call the requestFocus method of the component specified by the labelFor property when the mnemonic is activated.
getLabelFor(), setLabelFor(java.awt.Component)
public void setDisplayedMnemonic(char aChar)
Specifies the displayedMnemonic as a char value.
aChar - a char specifying the mnemonic to displaysetDisplayedMnemonic(int)public int getDisplayedMnemonic()
Return the keycode that indicates a mnemonic key. This property is used when the label is part of a larger component. If the labelFor property of the label is not null, the label will call the requestFocus method of the component specified by the labelFor property when the mnemonic is activated.
getLabelFor(), setLabelFor(java.awt.Component)
public void setDisplayedMnemonicIndex(int index)
throws IllegalArgumentException Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. Not all look and feels may support this. A value of -1 indicates either there is no mnemonic, the mnemonic character is not contained in the string, or the developer does not wish the mnemonic to be displayed.
The value of this is updated as the properties relating to the mnemonic change (such as the mnemonic itself, the text...). You should only ever have to call this if you do not wish the default character to be underlined. For example, if the text was 'Save As', with a mnemonic of 'a', and you wanted the 'A' to be decorated, as 'Save As', you would have to invoke setDisplayedMnemonicIndex(5) after invoking setDisplayedMnemonic(KeyEvent.VK_A).
index - Index into the String to underlineIllegalArgumentException - will be thrown if index is >= length of the text, or < -1public int getDisplayedMnemonicIndex()
Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.
setDisplayedMnemonicIndex(int)protected int checkHorizontalKey(int key,
String message) Verify that key is a legal value for the horizontalAlignment properties.
key - the property value to checkmessage - the IllegalArgumentException detail messageIllegalArgumentException - if key isn't LEFT, CENTER, RIGHT, LEADING or TRAILING.setHorizontalTextPosition(int), setHorizontalAlignment(int)
protected int checkVerticalKey(int key,
String message) Verify that key is a legal value for the verticalAlignment or verticalTextPosition properties.
key - the property value to checkmessage - the IllegalArgumentException detail messageIllegalArgumentException - if key isn't TOP, CENTER, or BOTTOM.setVerticalAlignment(int), setVerticalTextPosition(int)
public int getIconTextGap()
Returns the amount of space between the text and the icon displayed in this label.
setIconTextGap(int)public void setIconTextGap(int iconTextGap)
If both the icon and text properties are set, this property defines the space between them.
The default value of this property is 4 pixels.
This is a JavaBeans bound property.
getIconTextGap()public int getVerticalAlignment()
Returns the alignment of the label's contents along the Y axis.
SwingConstants: TOP, CENTER, or BOTTOM.SwingConstants, setVerticalAlignment(int)
public void setVerticalAlignment(int alignment)
Sets the alignment of the label's contents along the Y axis.
The default value of this property is CENTER.
alignment - One of the following constants defined in SwingConstants: TOP, CENTER (the default), or BOTTOM.SwingConstants, getVerticalAlignment()
public int getHorizontalAlignment()
Returns the alignment of the label's contents along the X axis.
SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.setHorizontalAlignment(int), SwingConstants
public void setHorizontalAlignment(int alignment)
Sets the alignment of the label's contents along the X axis.
This is a JavaBeans bound property.
alignment - One of the following constants defined in SwingConstants: LEFT, CENTER (the default for image-only labels), RIGHT, LEADING (the default for text-only labels) or TRAILING.SwingConstants, getHorizontalAlignment()
public int getVerticalTextPosition()
Returns the vertical position of the label's text, relative to its image.
SwingConstants: TOP, CENTER, or BOTTOM.setVerticalTextPosition(int), SwingConstants
public void setVerticalTextPosition(int textPosition)
Sets the vertical position of the label's text, relative to its image.
The default value of this property is CENTER.
This is a JavaBeans bound property.
textPosition - One of the following constants defined in SwingConstants: TOP, CENTER (the default), or BOTTOM.SwingConstants, getVerticalTextPosition()
public int getHorizontalTextPosition()
Returns the horizontal position of the label's text, relative to its image.
SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING.SwingConstantspublic void setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the label's text, relative to its image.
textPosition - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT, LEADING, or TRAILING (the default).IllegalArgumentExceptionSwingConstantspublic boolean imageUpdate(Image img,
int infoflags,
int x,
int y,
int w,
int h) This is overridden to return false if the current Icon's Image is not equal to the passed in Image img.
imageUpdate in interface ImageObserver
imageUpdate in class Component
img - the image being observedinfoflags - see imageUpdate for more informationx - the x coordinatey - the y coordinatew - the widthh - the heightfalse if the infoflags indicate that the image is completely loaded; true otherwise.ImageObserver, Component.imageUpdate(java.awt.Image, int, int, int, int, int)
protected String paramString()
Returns a string representation of this JLabel. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
paramString in class JComponent
public Component getLabelFor()
Get the component this is labelling.
getDisplayedMnemonic(), setDisplayedMnemonic(int)
public void setLabelFor(Component c)
Set the component this is labelling. Can be null if this does not label a Component. If the displayedMnemonic property is set and the labelFor property is also set, the label will call the requestFocus method of the component specified by the labelFor property when the mnemonic is activated.
c - the Component this label is for, or null if the label is not the label for a componentgetDisplayedMnemonic(), setDisplayedMnemonic(int)
public AccessibleContext getAccessibleContext()
Get the AccessibleContext of this object
getAccessibleContext in interface Accessible
getAccessibleContext in class Component
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.