All Packages Class Hierarchy This Package Previous Next Index
Class java.awt.swing.JLabel
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----java.awt.swing.JComponent
|
+----java.awt.swing.JLabel
- public class JLabel
- extends JComponent
- implements SwingConstants, Accessible
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 left-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 to the right of the image,
with the text and image vertically aligned.
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.
labelFor- --- Accessibility Support ---
JLabel()
- Creates a
JLabel
instance with
no image and with an empty string for the title.
JLabel(Icon)
- Creates a
JLabel
instance with the specified image.
JLabel(Icon, int)
- Creates a
JLabel
instance with the specified
image and horizontal alignment.
JLabel(String)
- Creates a
JLabel
instance with the specified text.
JLabel(String, Icon, int)
- Creates a
JLabel
instance with the specified
text, image, and horizontal alignment.
JLabel(String, int)
- Creates a
JLabel
instance with the specified
text and horizontal alignment.
checkHorizontalKey(int, String)
-
checkVerticalKey(int, String)
-
getAccessibleName()
- Get the accessible name of this object.
getAccessibleRole()
- Get the role of this object.
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.
getDisplayedKeyAccelerator()
- Return the char that indicates a shortcut key.
getHorizontalAlignment()
- Returns the alignment of the label's contents along the X axis.
getHorizontalTextPosition()
- Returns the horizontal position of the label's text,
relative to its image.
getIcon()
- Returns the graphic image (glyph, icon) that the label displays.
getIconTextGap()
- Returns the amount of space between the text and the icon
displayed in this label.
getLabelFor()
- Get the component this is labelling.
getText()
- Returns the text string that the label displays.
getUI()
- Return the current L&F for this component.
getUIClassID()
- Returns a string that specifies the name of the l&f class
that renders this component.
getVerticalAlignment()
- Returns the alignment of the label's contents along the Y axis.
getVerticalTextPosition()
- Returns the vertical position of the label's text,
relative to its image.
isOpaque()
- Identifies whether the label's background is opaque or transparent.
setDisabledIcon(Icon)
- Set the icon to be displayed if this JLabel is "disabled", i.e.
setDisplayedKeyAccelerator(char)
- Specify a character that indicates a shortcut key.
setFont(Font)
- Sets the font used to display the label's text.
setHorizontalAlignment(int)
- Sets the alignment of the label's contents along the X axis.
setHorizontalTextPosition(int)
- Sets the horizontal position of the label's text,
relative to its image.
setIcon(Icon)
- Defines the icon this component will display.
setIconTextGap(int)
- If both the icon and text properties are set, this property
defines the space between them.
setLabelFor(Component)
- Set the component this is labelling.
setOpaque(boolean)
- If true the labels background will be filled with the
background color.
setText(String)
- Defines the single line of text this component will display.
setUI(LabelUI)
- Set the L&F for the component.
setVerticalAlignment(int)
- Sets the alignment of the label's contents along the Y axis.
setVerticalTextPosition(int)
- Sets the vertical position of the label's text,
relative to its image.
updateUI()
- Notification from the UIFactory that the L&F
has changed.
labelFor
protected Component labelFor
- --- Accessibility Support ---
JLabel
public JLabel(String text,
Icon icon,
int horizontalAlignment)
- Creates a
JLabel
instance with the specified
text, image, and horizontal alignment.
The label is centered vertically in its display area.
The text is to the right of the image.
- Parameters:
- 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
, or
RIGHT
.
JLabel
public JLabel(String text,
int horizontalAlignment)
- Creates a
JLabel
instance with the specified
text and horizontal alignment.
The label is centered vertically in its display area.
- Parameters:
- text - The text to be displayed by the label.
- horizontalAlignment - One of the following constants
defined in
SwingConstants
:
LEFT
,
CENTER
, or
RIGHT
.
JLabel
public JLabel(String text)
- Creates a
JLabel
instance with the specified text.
The label is aligned against the left side of its display area,
and centered vertically.
- Parameters:
- text - The text to be displayed by the label.
JLabel
public JLabel(Icon image,
int horizontalAlignment)
- Creates a
JLabel
instance with the specified
image and horizontal alignment.
The label is centered vertically in its display area.
- Parameters:
- icon - The image to be displayed by the label.
- horizontalAlignment - One of the following constants
defined in
SwingConstants
:
LEFT
,
CENTER
, or
RIGHT
.
JLabel
public JLabel(Icon image)
- Creates a
JLabel
instance with the specified image.
The label is centered vertically and horizontally
in its display area.
- Parameters:
- icon - The image to be displayed by the label.
JLabel
public JLabel()
- Creates a
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 at the left
of the label's display area.
getUI
public LabelUI getUI()
- Return the current L&F for this component.
- Returns:
- LabelUI object
setUI
public void setUI(LabelUI ui)
- Set the L&F for the component.
updateUI
public void updateUI()
- Notification from the UIFactory that the L&F
has changed.
- Overrides:
- updateUI in class JComponent
- See Also:
- updateUI
getUIClassID
public String getUIClassID()
- Returns a string that specifies the name of the l&f class
that renders this component.
- Returns:
- String "LabelUI"
- Overrides:
- getUIClassID in class JComponent
- See Also:
- getUIClassID, getUI
getText
public String getText()
- Returns the text string that the label displays.
- Returns:
- a String
- See Also:
- setText
setText
public void setText(String text)
- Defines the single line of text this component will display. If
the value of text is null or empty string, nothing is displayed.
The default value of this property is null.
This is a JavaBeans bound property.
- See Also:
- setVerticalTextPosition, setHorizontalTextPosition, setIcon
getIcon
public Icon getIcon()
- Returns the graphic image (glyph, icon) that the label displays.
- Returns:
- an Icon
- See Also:
- setIcon
setIcon
public void setIcon(Icon icon)
- Defines the icon this component will display. If
the value of icon is null, nothing is displayed.
The default value of this property is null.
This is a JavaBeans bound property.
- See Also:
- setVerticalTextPosition, setHorizontalTextPosition, getIcon
getDisabledIcon
public 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.
- Returns:
- The value of the disabledIcon property.
- See Also:
- setDisabledIcon, ImageIcon
setDisabledIcon
public void setDisabledIcon(Icon disabledIcon)
- Set the icon to be displayed if this JLabel is "disabled", i.e.
JLabel.setEnabled(false).
The default value of this property is null.
This is a JavaBeans bound property.
- See Also:
- getDisabledIcon, setEnabled
setDisplayedKeyAccelerator
public void setDisplayedKeyAccelerator(char aKey)
- Specify a character that indicates a shortcut key.
This property is used when the label is part of a larger component.
getDisplayedKeyAccelerator
public char getDisplayedKeyAccelerator()
- Return the char that indicates a shortcut key.
This property is used when the label is part of a larger component.
- Returns:
- char value for the shortcut key
setOpaque
public void setOpaque(boolean isOpaque)
- If true the labels background will be filled with the
background color. Otherwise, the background is transparent,
and whatever is "underneath" (already drawn where the label
is to be drawn) will remain visible in the label's background.
The default value of this property is false.
This is a JavaBeans bound property.
- See Also:
- isOpaque, getBackground
isOpaque
public boolean isOpaque()
- Identifies whether the label's background is opaque or transparent.
- Returns:
- true if the label's background will be filled with the
background color, otherwise false.
- Overrides:
- isOpaque in class JComponent
- See Also:
- setOpaque
checkHorizontalKey
protected int checkHorizontalKey(int x,
String s)
checkVerticalKey
protected int checkVerticalKey(int x,
String s)
getIconTextGap
public int getIconTextGap()
- Returns the amount of space between the text and the icon
displayed in this label.
- Returns:
- an int equal to the number of pixels between the text
and the icon.
- See Also:
- setIconTextGap
setIconTextGap
public void setIconTextGap(int iconTextGap)
- If both the icon and text properties are set, this property
defines the space between them.
The default value of this property is 4 pixels.
This is a JavaBeans bound property.
- See Also:
- getIconTextGap
getVerticalAlignment
public int getVerticalAlignment()
- Returns the alignment of the label's contents along the Y axis.
- Returns:
- The value of the verticalAlignment property, one of the
following constants defined in
SwingConstants
:
TOP
,
CENTER
, or
BOTTOM
. - See Also:
- SwingConstants, setVerticalAlignment
setVerticalAlignment
public void setVerticalAlignment(int alignment)
- Sets the alignment of the label's contents along the Y axis.
The default value of this property is CENTER.
This is a JavaBeans bound property.
- Parameters:
- alignment - One of the following constants
defined in
SwingConstants
:
TOP
,
CENTER
(the default), or
BOTTOM
.
- See Also:
- SwingConstants, getVerticalAlignment
getHorizontalAlignment
public int getHorizontalAlignment()
- Returns the alignment of the label's contents along the X axis.
- Returns:
- The value of the horizontalAlignment property, one of the
following constants defined in
SwingConstants
:
LEFT
,
CENTER
, or
RIGHT
. - See Also:
- setHorizontalAlignment, SwingConstants
setHorizontalAlignment
public void setHorizontalAlignment(int alignment)
- Sets the alignment of the label's contents along the X axis.
This is a JavaBeans bound property.
- Parameters:
- alignment - One of the following constants
defined in
SwingConstants
:
LEFT
(the default for text-only labels),
CENTER
(the default for image-only labels), or
RIGHT
.
- See Also:
- SwingConstants, getHorizontalAlignment
getVerticalTextPosition
public int getVerticalTextPosition()
- Returns the vertical position of the label's text,
relative to its image.
- Returns:
- One of the following constants
defined in
SwingConstants
:
TOP
,
CENTER
, or
BOTTOM
. - See Also:
- setVerticalTextPosition, SwingConstants
setVerticalTextPosition
public void setVerticalTextPosition(int textPosition)
- Sets the vertical position of the label's text,
relative to its image.
The default value of this property is CENTER.
This is a JavaBeans bound property.
- Parameters:
- textPosition - One of the following constants
defined in
SwingConstants
:
TOP
,
CENTER
(the default), or
BOTTOM
.
- See Also:
- SwingConstants, getVerticalTextPosition
getHorizontalTextPosition
public int getHorizontalTextPosition()
- Returns the horizontal position of the label's text,
relative to its image.
- Returns:
- One of the following constants
defined in
SwingConstants
:
LEFT
,
CENTER
, or
RIGHT
. - See Also:
- SwingConstants
setHorizontalTextPosition
public void setHorizontalTextPosition(int x)
- Sets the horizontal position of the label's text,
relative to its image.
- Parameters:
- x - One of the following constants
defined in
SwingConstants
:
LEFT
,
CENTER
, or
RIGHT
(the default).
- See Also:
- SwingConstants
setFont
public void setFont(Font font)
- Sets the font used to display the label's text.
- Parameters:
- font - The font to use.
- Overrides:
- setFont in class Component
getAccessibleName
public String getAccessibleName()
- Get the accessible name of this object.
- Returns:
- the localized name of the object -- can be null if this
object does not have a name
- Overrides:
- getAccessibleName in class JComponent
- See Also:
- setAccessibleName
getAccessibleRole
public AccessibleRole getAccessibleRole()
- Get the role of this object.
- Returns:
- an instance of AccessibleRole describing the role of the object
- Overrides:
- getAccessibleRole in class JComponent
- See Also:
- AccessibleRole
getLabelFor
public Component getLabelFor()
- Get the component this is labelling.
- Returns:
- the Component this is labelling. Can be null if this
does not label a Component.
setLabelFor
public void setLabelFor(Component c)
- Set the component this is labelling. Can be null if this does not
label a Component.
All Packages Class Hierarchy This Package Previous Next Index
Submit a bug or feature