Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

JSR 216 (Maintenance Release)

java.awt
Class Label

java.lang.Object
  extended byjava.awt.Component
      extended byjava.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 labels:

Two labels: 'Hi There!' and 'Another 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 a 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, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getCursor, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, 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, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, 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()
      throws HeadlessException
Constructs an empty label. The text of the label is the empty string "".

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

Label

public Label(String text)
      throws HeadlessException
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:
GraphicsEnvironment.isHeadless()

Label

public Label(String text,
             int alignment)
      throws HeadlessException
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:
GraphicsEnvironment.isHeadless()
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 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.

Overrides:
paramString in class Component
Returns:
the parameter string of this label

JSR 216 (Maintenance Release)

Copyright © 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

For more information, please consult the JSR 216 specification.