java.awt
Class Label

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Label

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

public class Label

extends Component

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 label:

Since:

JDK1.0

See Also:

Serialized Form

Field Summary

static int	CENTER Indicates that the label should be centered.
static int	LEFT Indicates that the label should be left justified.
static int	RIGHT Indicates that the label should be right justified.

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

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.

Method Summary

int	getAlignment() Gets the current alignment of this label.
String	getText() Gets the text of this label.
protected String	paramString() Returns the parameter string representing the state of this label.
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.

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LEFT

public static final int LEFT

Indicates that the label should be left justified.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Indicates that the label should be centered.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Indicates that the label should be right justified.

Since:

JDK1.0t.

See Also:

Constant Field Values

Constructor Detail

Label

public Label()

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

Label

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.

Label

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.

Method Detail

getAlignment

public int getAlignment()

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

See Also:

setAlignment(int)

setAlignment

public 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:

getAlignment()

getText

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:

setText(java.lang.String)

setText

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:

getText()

paramString

protected String paramString()

Returns the parameter string representing the state of this label. This string is useful for debugging.

Overrides:

paramString in class Component

Returns:

the parameter string of this label.