java.awt
Class Label

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Label
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public class Label
extends Component
implements Accessible

This component is used for displaying simple text strings that cannot be edited by the user.

See Also:
Serialized Form

Nested Class Summary
protected  class Label.AccessibleAWTLabel
          This class provides accessibility support for the label.
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static int CENTER
          Alignment constant aligning the text in the center of its window.
static int LEFT
          Alignment constant aligning the text to the left of its window.
static int RIGHT
          Alignment constant aligning the text to the right of its window.
 
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()
          Initializes a new instance of Label with no text.
Label(String text)
          Initializes a new instance of Label with the specified text that is aligned to the left.
Label(String text, int alignment)
          Initializes a new instance of Label with the specified text and alignment.
 
Method Summary
 void addNotify()
          Notifies this label that it has been added to a container, causing the peer to be created.
 AccessibleContext getAccessibleContext()
          Gets the AccessibleContext associated with this Label.
 int getAlignment()
          Returns the constant indicating the alignment of the text in this label.
 String getText()
          Returns the text displayed in this label.
protected  String paramString()
          Returns a parameter string useful for debugging.
 void setAlignment(int alignment)
          Sets the text alignment of this label to the specified value.
 void setText(String text)
          Sets the text in this label to the specified value.
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, 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, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, 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
Alignment constant aligning the text to the left of its window.

See Also:
Constant Field Values

CENTER

public static final int CENTER
Alignment constant aligning the text in the center of its window.

See Also:
Constant Field Values

RIGHT

public static final int RIGHT
Alignment constant aligning the text to the right of its window.

See Also:
Constant Field Values
Constructor Detail

Label

public Label()
Initializes a new instance of Label with no text.

Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Label

public Label(String text)
Initializes a new instance of Label with the specified text that is aligned to the left.

Parameters:
text - The text of the label.
Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() is true.

Label

public Label(String text,
             int alignment)
Initializes a new instance of Label with the specified text and alignment.

Parameters:
text - The text of the label.
alignment - The desired alignment for the text in this label, which must be one of LEFT, CENTER, or RIGHT.
Throws:
HeadlessException - If GraphicsEnvironment.isHeadless() is true.
Method Detail

getAlignment

public int getAlignment()
Returns the constant indicating the alignment of the text in this label. The value returned will be one of the alignment constants from this class.

Returns:
The alignment of the text in the label.

setAlignment

public void setAlignment(int alignment)
Sets the text alignment of this label to the specified value.

Parameters:
alignment - The desired alignment for the text in this label, which must be one of LEFT, CENTER, or RIGHT.

getText

public String getText()
Returns the text displayed in this label.

Returns:
The text for this label.

setText

public void setText(String text)
Sets the text in this label to the specified value.

Parameters:
text - The new text for this label.

addNotify

public void addNotify()
Notifies this label that it has been added to a container, causing the peer to be created. This method is called internally by the AWT system.

Overrides:
addNotify in class Component
See Also:
Component.isDisplayable(), Component.removeNotify()

paramString

protected String paramString()
Returns a parameter string useful for debugging.

Overrides:
paramString in class Component
Returns:
A debugging string.

getAccessibleContext

public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this Label. The context is created, if necessary.

Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class Component
Returns:
the associated context