Label (Java Platform SE 6) (original) (raw)

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

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

Nested Class Summary
protected class Label.AccessibleAWTLabel This class implements accessibility support for the Label class.
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
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](../../java/awt/Label.html#Label%28java.lang.String, int%29)(String text, int alignment) Constructs a new label that presents the specified string of text with the specified alignment.
Method Summary
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.
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](../../java/awt/Component.html#action%28java.awt.Event, java.lang.Object%29), add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, [addPropertyChangeListener](../../java/awt/Component.html#addPropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), applyComponentOrientation, areFocusTraversalKeysSet, bounds, [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, java.awt.image.ImageObserver%29), [checkImage](../../java/awt/Component.html#checkImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), [coalesceEvents](../../java/awt/Component.html#coalesceEvents%28java.awt.AWTEvent, java.awt.AWTEvent%29), [contains](../../java/awt/Component.html#contains%28int, int%29), contains, createImage, [createImage](../../java/awt/Component.html#createImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int%29), [createVolatileImage](../../java/awt/Component.html#createVolatileImage%28int, int, java.awt.ImageCapabilities%29), deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, boolean, boolean%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, byte, byte%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, char, char%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, double, double%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, float, float%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, int, int%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, long, long%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), [firePropertyChange](../../java/awt/Component.html#firePropertyChange%28java.lang.String, short, short%29), getAlignmentX, getAlignmentY, getBackground, [getBaseline](../../java/awt/Component.html#getBaseline%28int, int%29), getBaselineResizeBehavior, getBounds, getBounds, getColorModel, [getComponentAt](../../java/awt/Component.html#getComponentAt%28int, int%29), 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](../../java/awt/Component.html#gotFocus%28java.awt.Event, java.lang.Object%29), handleEvent, hasFocus, hide, [imageUpdate](../../java/awt/Component.html#imageUpdate%28java.awt.Image, int, int, int, int, int%29), [inside](../../java/awt/Component.html#inside%28int, int%29), invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, [keyDown](../../java/awt/Component.html#keyDown%28java.awt.Event, int%29), [keyUp](../../java/awt/Component.html#keyUp%28java.awt.Event, int%29), layout, list, list, [list](../../java/awt/Component.html#list%28java.io.PrintStream, int%29), list, [list](../../java/awt/Component.html#list%28java.io.PrintWriter, int%29), [locate](../../java/awt/Component.html#locate%28int, int%29), location, [lostFocus](../../java/awt/Component.html#lostFocus%28java.awt.Event, java.lang.Object%29), minimumSize, [mouseDown](../../java/awt/Component.html#mouseDown%28java.awt.Event, int, int%29), [mouseDrag](../../java/awt/Component.html#mouseDrag%28java.awt.Event, int, int%29), [mouseEnter](../../java/awt/Component.html#mouseEnter%28java.awt.Event, int, int%29), [mouseExit](../../java/awt/Component.html#mouseExit%28java.awt.Event, int, int%29), [mouseMove](../../java/awt/Component.html#mouseMove%28java.awt.Event, int, int%29), [mouseUp](../../java/awt/Component.html#mouseUp%28java.awt.Event, int, int%29), [move](../../java/awt/Component.html#move%28int, int%29), nextFocus, paint, paintAll, postEvent, preferredSize, [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, java.awt.image.ImageObserver%29), [prepareImage](../../java/awt/Component.html#prepareImage%28java.awt.Image, int, int, java.awt.image.ImageObserver%29), 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](../../java/awt/Component.html#removePropertyChangeListener%28java.lang.String, java.beans.PropertyChangeListener%29), repaint, [repaint](../../java/awt/Component.html#repaint%28int, int, int, int%29), repaint, [repaint](../../java/awt/Component.html#repaint%28long, int, int, int, int%29), requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, [reshape](../../java/awt/Component.html#reshape%28int, int, int, int%29), resize, [resize](../../java/awt/Component.html#resize%28int, int%29), setBackground, [setBounds](../../java/awt/Component.html#setBounds%28int, int, int, int%29), setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, [setFocusTraversalKeys](../../java/awt/Component.html#setFocusTraversalKeys%28int, java.util.Set%29), setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, [setLocation](../../java/awt/Component.html#setLocation%28int, int%29), setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, [setSize](../../java/awt/Component.html#setSize%28int, int%29), 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](../../java/lang/Object.html#wait%28long, int%29)
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

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](../../java/awt/HeadlessException.html "class in java.awt") - 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](../../java/awt/HeadlessException.html "class in java.awt") - 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](../../java/awt/HeadlessException.html "class in java.awt") - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless()

Method Detail

addNotify

public void addNotify()

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

Overrides:

[addNotify](../../java/awt/Component.html#addNotify%28%29) in class [Component](../../java/awt/Component.html "class in java.awt")

See Also:

Component.isDisplayable(), Component.removeNotify()

getAlignment

public int getAlignment()

Gets the current alignment of this label. Possible values areLabel.LEFT, Label.RIGHT, andLabel.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](../../java/lang/IllegalArgumentException.html "class in java.lang") - if an improper value foralignment 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](../../java/awt/Component.html#paramString%28%29) in class [Component](../../java/awt/Component.html "class in java.awt")

Returns:

the parameter string of this label

getAccessibleContext

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.

Specified by:

[getAccessibleContext](../../javax/accessibility/Accessible.html#getAccessibleContext%28%29) in interface [Accessible](../../javax/accessibility/Accessible.html "interface in javax.accessibility")

Overrides:

[getAccessibleContext](../../java/awt/Component.html#getAccessibleContext%28%29) in class [Component](../../java/awt/Component.html "class in java.awt")

Returns:

an AccessibleAWTLabel that serves as the AccessibleContext of this Label

Since:

1.3

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.