public class

Label

extends Component
implements Accessible
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Label

Class Overview

A Label object is a component for placing text in a container. A label displays a single line of read-only text. The text can be changed by the application, but a user cannot edit it directly.

For example, the code . . . 

 setLayout(new FlowLayout(FlowLayout.CENTER, 10, 10));
 add(new Label("Hi There!"));
 add(new Label("Another Label"));

produces the following labels:

Two labels: 'Hi There!' and 'Another label'

Summary

Nested Classes
class Label.AccessibleAWTLabel This class implements accessibility support for the Label class. 
Constants
int CENTER Indicates that the label should be centered.
int LEFT Indicates that the label should be left justified.
int RIGHT Indicates that the label should be right justified.
[Expand]
Inherited Constants
From class java.awt.Component
From interface java.awt.image.ImageObserver
Public Constructors
Label()
Constructs an empty label.
Label(String text)
Constructs a new label with the specified string of text, left justified.
Label(String text, int alignment)
Constructs a new label that presents the specified string of text with the specified alignment.
Public Methods
void addNotify()
Creates the peer for this label.
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this Label.
int getAlignment()
Gets the current alignment of this label.
String getText()
Gets the text of this label.
synchronized void setAlignment(int alignment)
Sets the alignment for this label to the specified alignment.
void setText(String text)
Sets the text for this label to the specified text.
Protected Methods
String paramString()
Returns a string representing the state of this Label.
[Expand]
Inherited Methods
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible

Constants

public static final int CENTER

Indicates that the label should be centered.

Constant Value: 1 (0x00000001)

public static final int LEFT

Indicates that the label should be left justified.

Constant Value: 0 (0x00000000)

public static final int RIGHT

Indicates that the label should be right justified.

Constant Value: 2 (0x00000002)

Public Constructors

public Label ()

Constructs an empty label. The text of the label is the empty string "".

Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.
See Also

public Label (String text)

Constructs a new label with the specified string of text, left justified.

Parameters
text the string that the label presents. A null value will be accepted without causing a NullPointerException to be thrown.
Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.
See Also

public Label (String text, int alignment)

Constructs a new label that presents the specified string of text with the specified alignment. Possible values for alignment are Label.LEFT, Label.RIGHT, and Label.CENTER.

Parameters
text the string that the label presents. A null value will be accepted without causing a NullPointerException to be thrown.
alignment the alignment value.
Throws
HeadlessException if GraphicsEnvironment.isHeadless() returns true.
See Also

Public Methods

public void addNotify ()

Creates the peer for this label. The peer allows us to modify the appearance of the label without changing its functionality.

public AccessibleContext getAccessibleContext ()

Gets the AccessibleContext associated with this Label. For labels, the AccessibleContext takes the form of an AccessibleAWTLabel. A new AccessibleAWTLabel instance is created if necessary.

Returns
  • an AccessibleAWTLabel that serves as the AccessibleContext of this Label

public int getAlignment ()

Gets the current alignment of this label. Possible values are Label.LEFT, Label.RIGHT, and Label.CENTER.

See Also

public String getText ()

Gets the text of this label.

Returns
  • the text of this label, or null if the text has been set to null.
See Also

public synchronized void setAlignment (int alignment)

Sets the alignment for this label to the specified alignment. Possible values are Label.LEFT, Label.RIGHT, and Label.CENTER.

Parameters
alignment the alignment to be set.
Throws
IllegalArgumentException if an improper value for alignment is given.
See Also

public void setText (String text)

Sets the text for this label to the specified text.

Parameters
text the text that this label displays. If text is null, it is treated for display purposes like an empty string "".
See Also

Protected Methods

protected String paramString ()

Returns a string representing the state of this Label. 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.

Returns
  • the parameter string of this label