|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JLabel
A display area for a short text string or an image, or both. A label does not react to input events. As a result, it cannot get the keyboard focus. A label can, however, display a keyboard alternative as a convenience for a nearby component that has a keyboard alternative but can't display it.
A JLabel
object can display
either text, an image, or both.
You can specify where in the label's display area
the label's contents are aligned
by setting the vertical and horizontal alignment.
By default, labels are vertically centered
in their display area.
Text-only labels are leading edge aligned, by default;
image-only labels are horizontally centered, by default.
You can also specify the position of the text relative to the image. By default, text is on the trailing edge of the image, with the text and image vertically aligned.
A label's leading and trailing edge are determined from the value of its
ComponentOrientation
property. At present, the default
ComponentOrientation setting maps the leading edge to left and the trailing
edge to right.
Finally, you can use the setIconTextGap
method
to specify how many pixels
should appear between the text and the image.
The default is 4 pixels.
See How to Use Labels in The Java Tutorial for further documentation.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
Inner Class Summary | |
protected class |
JLabel.AccessibleJLabel
The class used to obtain the accessible role for this object. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent |
Field Summary | |
protected Component |
labelFor
|
Fields inherited from class javax.swing.JComponent |
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
JLabel()
Creates a JLabel instance with
no image and with an empty string for the title. |
|
JLabel(Icon image)
Creates a JLabel instance with the specified image. |
|
JLabel(Icon image,
int horizontalAlignment)
Creates a JLabel instance with the specified
image and horizontal alignment. |
|
JLabel(String text)
Creates a JLabel instance with the specified text. |
|
JLabel(String text,
Icon icon,
int horizontalAlignment)
Creates a JLabel instance with the specified
text, image, and horizontal alignment. |
|
JLabel(String text,
int horizontalAlignment)
Creates a JLabel instance with the specified
text and horizontal alignment. |
Method Summary | |
protected int |
checkHorizontalKey(int key,
String message)
Verify that key is a legal value for the horizontalAlignment properties. |
protected int |
checkVerticalKey(int key,
String message)
Verify that key is a legal value for the verticalAlignment or verticalTextPosition properties. |
AccessibleContext |
getAccessibleContext()
Get the AccessibleContext of this object |
Icon |
getDisabledIcon()
Returns the value of the disabledIcon property if it's been set, If it hasn't been set and the value of the icon property is an ImageIcon, we compute a "grayed out" version of the icon and update the disabledIcon property with that. |
int |
getDisplayedMnemonic()
Return the keycode that indicates a mnemonic key. |
int |
getHorizontalAlignment()
Returns the alignment of the label's contents along the X axis. |
int |
getHorizontalTextPosition()
Returns the horizontal position of the label's text, relative to its image. |
Icon |
getIcon()
Returns the graphic image (glyph, icon) that the label displays. |
int |
getIconTextGap()
Returns the amount of space between the text and the icon displayed in this label. |
Component |
getLabelFor()
Get the component this is labelling. |
String |
getText()
Returns the text string that the label displays. |
LabelUI |
getUI()
Returns the L&F object that renders this component. |
String |
getUIClassID()
Returns a string that specifies the name of the l&f class that renders this component. |
int |
getVerticalAlignment()
Returns the alignment of the label's contents along the Y axis. |
int |
getVerticalTextPosition()
Returns the vertical position of the label's text, relative to its image. |
boolean |
imageUpdate(Image img,
int infoflags,
int x,
int y,
int w,
int h)
This is overriden to return false if the current Icon's Image is not equal to the passed in Image img . |
protected String |
paramString()
Returns a string representation of this JLabel. |
void |
setDisabledIcon(Icon disabledIcon)
Set the icon to be displayed if this JLabel is "disabled" (JLabel.setEnabled(false)). |
void |
setDisplayedMnemonic(char aChar)
Specifies the displayedMnemonic as a char value. |
void |
setDisplayedMnemonic(int key)
Specify a keycode that indicates a mnemonic key. |
void |
setHorizontalAlignment(int alignment)
Sets the alignment of the label's contents along the X axis. |
void |
setHorizontalTextPosition(int textPosition)
Sets the horizontal position of the label's text, relative to its image. |
void |
setIcon(Icon icon)
Defines the icon this component will display. |
void |
setIconTextGap(int iconTextGap)
If both the icon and text properties are set, this property defines the space between them. |
void |
setLabelFor(Component c)
Set the component this is labelling. |
void |
setText(String text)
Defines the single line of text this component will display. |
void |
setUI(LabelUI ui)
Sets the L&F object that renders this component. |
void |
setVerticalAlignment(int alignment)
Sets the alignment of the label's contents along the Y axis. |
void |
setVerticalTextPosition(int textPosition)
Sets the vertical position of the label's text, relative to its image. |
void |
updateUI()
Notification from the UIFactory that the L&F has changed. |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected Component labelFor
Constructor Detail |
public JLabel(String text, Icon icon, int horizontalAlignment)
JLabel
instance with the specified
text, image, and horizontal alignment.
The label is centered vertically in its display area.
The text is on the trailing edge of the image.text
- The text to be displayed by the label.icon
- The image to be displayed by the label.horizontalAlignment
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.public JLabel(String text, int horizontalAlignment)
JLabel
instance with the specified
text and horizontal alignment.
The label is centered vertically in its display area.text
- The text to be displayed by the label.horizontalAlignment
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.public JLabel(String text)
JLabel
instance with the specified text.
The label is aligned against the leading edge of its display area,
and centered vertically.text
- The text to be displayed by the label.public JLabel(Icon image, int horizontalAlignment)
JLabel
instance with the specified
image and horizontal alignment.
The label is centered vertically in its display area.icon
- The image to be displayed by the label.horizontalAlignment
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.public JLabel(Icon image)
JLabel
instance with the specified image.
The label is centered vertically and horizontally
in its display area.icon
- The image to be displayed by the label.public JLabel()
JLabel
instance with
no image and with an empty string for the title.
The label is centered vertically
in its display area.
The label's contents, once set, will be displayed on the leading edge
of the label's display area.Method Detail |
public LabelUI getUI()
public void setUI(LabelUI ui)
ui
- the LabelUI L&F objectUIDefaults.getUI(javax.swing.JComponent)
public void updateUI()
updateUI
in class JComponent
JComponent.updateUI()
public String getUIClassID()
getUIClassID
in class JComponent
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public String getText()
setText(java.lang.String)
public void setText(String text)
The default value of this property is null.
This is a JavaBeans bound property.
setVerticalTextPosition(int)
,
setHorizontalTextPosition(int)
,
setIcon(javax.swing.Icon)
public Icon getIcon()
setIcon(javax.swing.Icon)
public void setIcon(Icon icon)
The default value of this property is null.
This is a JavaBeans bound property.
setVerticalTextPosition(int)
,
setHorizontalTextPosition(int)
,
getIcon()
public Icon getDisabledIcon()
setDisabledIcon(javax.swing.Icon)
,
ImageIcon
public void setDisabledIcon(Icon disabledIcon)
The default value of this property is null.
disabledIcon
- the Icon to display when the component is disabledgetDisabledIcon()
,
JComponent.setEnabled(boolean)
public void setDisplayedMnemonic(int key)
getLabelFor()
,
setLabelFor(java.awt.Component)
public void setDisplayedMnemonic(char aChar)
aChar
- a char specifying the mnemonic to displaysetDisplayedMnemonic(int)
public int getDisplayedMnemonic()
getLabelFor()
,
setLabelFor(java.awt.Component)
protected int checkHorizontalKey(int key, String message)
key
- the property value to checkmessage
- the IllegalArgumentException detail messageIllegalArgumentException
- if key isn't LEFT, CENTER, RIGHT,
LEADING or TRAILING.setHorizontalTextPosition(int)
,
setHorizontalAlignment(int)
protected int checkVerticalKey(int key, String message)
key
- the property value to checkmessage
- the IllegalArgumentException detail messageIllegalArgumentException
- if key isn't TOP, CENTER, or BOTTOM.setVerticalAlignment(int)
,
setVerticalTextPosition(int)
public int getIconTextGap()
setIconTextGap(int)
public void setIconTextGap(int iconTextGap)
The default value of this property is 4 pixels.
This is a JavaBeans bound property.
getIconTextGap()
public int getVerticalAlignment()
SwingConstants
:
TOP
,
CENTER
, or
BOTTOM
.SwingConstants
,
setVerticalAlignment(int)
public void setVerticalAlignment(int alignment)
The default value of this property is CENTER.
alignment
- One of the following constants
defined in SwingConstants
:
TOP
,
CENTER
(the default), or
BOTTOM
.SwingConstants
,
getVerticalAlignment()
public int getHorizontalAlignment()
SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.setHorizontalAlignment(int)
,
SwingConstants
public void setHorizontalAlignment(int alignment)
This is a JavaBeans bound property.
alignment
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
(the default for image-only labels),
RIGHT
,
LEADING
(the default for text-only labels) or
TRAILING
.SwingConstants
,
getHorizontalAlignment()
public int getVerticalTextPosition()
SwingConstants
:
TOP
,
CENTER
, or
BOTTOM
.setVerticalTextPosition(int)
,
SwingConstants
public void setVerticalTextPosition(int textPosition)
The default value of this property is CENTER.
This is a JavaBeans bound property.
textPosition
- One of the following constants
defined in SwingConstants
:
TOP
,
CENTER
(the default), or
BOTTOM
.SwingConstants
,
getVerticalTextPosition()
public int getHorizontalTextPosition()
SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
or
TRAILING
.SwingConstants
public void setHorizontalTextPosition(int textPosition)
x
- One of the following constants
defined in SwingConstants
:
LEFT
,
CENTER
,
RIGHT
,
LEADING
, or
TRAILING
(the default).IllegalArgumentException
- SwingConstants
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
img
.imageUpdate
in class Component
ImageObserver
,
Component.imageUpdate(java.awt.Image, int, int, int, int, int)
protected String paramString()
null
.paramString
in class JComponent
public Component getLabelFor()
getDisplayedMnemonic()
,
setDisplayedMnemonic(int)
public void setLabelFor(Component c)
c
- the Component this label is for, or null if the label is
not the label for a componentgetDisplayedMnemonic()
,
setDisplayedMnemonic(int)
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JComponent
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.