This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.awt
class Label
- All Implemented Interfaces:
- MenuContainer, ImageObserver, Serializable, Accessible
-
Most common way to construct:
-
Label messageLabel = new Label("Description");
Based on 48 examples
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:
Nested Class Summary |
protected class |
This class implements accessibility support for the
Label class. |
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. |
Constructor Summary |
Constructs an empty label.
|
Constructs a new label with the specified string of text,
left justified.
|
Constructs a new label that presents the specified string of
text with the specified alignment.
|
Method Summary |
void |
Creates the peer for this label.
|
AccessibleContext |
Gets the AccessibleContext associated with this Label.
|
int |
Gets the current alignment of this label.
|
String |
Gets the text of this label.
|
protected String |
Returns a string representing the state of this Label .
|
void |
Sets the alignment for this label to the specified alignment.
|
void |
Sets the text for this label to the specified text.
|
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, 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, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, 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, paramString, 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, toString, wait, wait, wait |
CENTER
public static final int CENTER
-
Indicates that the label should be centered.
LEFT
public static final int LEFT
-
Indicates that the label should be left justified.
RIGHT
public static final int RIGHT
-
Indicates that the label should be right justified.
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.
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.
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.
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
in class Component
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.
- Overrides:
getAccessibleContext
in class Component
- Returns:
- an AccessibleAWTLabel that serves as the
AccessibleContext of this Label
getAlignment
public int getAlignment()
-
Gets the current alignment of this label. Possible values are
Label.LEFT
, Label.RIGHT
, and
Label.CENTER
.
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
.
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
setAlignment
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.
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 ""
.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.