GNU Classpath (0.20) | |
Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
Nested Class Summary | |
protected class |
|
Nested classes/interfaces inherited from class javax.swing.JComponent | |
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container | |
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component | |
Component.AccessibleAWTComponent , Component.BltBufferStrategy , Component.FlipBufferStrategy |
Field Summary | |
protected Component |
|
Fields inherited from class javax.swing.JComponent | |
TOOL_TIP_TEXT_KEY , UNDEFINED_CONDITION , WHEN_ANCESTOR_OF_FOCUSED_COMPONENT , WHEN_FOCUSED , WHEN_IN_FOCUSED_WINDOW , accessibleContext , listenerList , ui |
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 |
Fields inherited from interface javax.swing.SwingConstants | |
BOTTOM , CENTER , EAST , HORIZONTAL , LEADING , LEFT , NEXT , NORTH , NORTH_EAST , NORTH_WEST , PREVIOUS , RIGHT , SOUTH , SOUTH_EAST , SOUTH_WEST , TOP , TRAILING , VERTICAL , WEST |
Constructor Summary | |
| |
Method Summary | |
protected int |
|
protected int |
|
AccessibleContext |
|
Icon |
|
int |
|
int |
|
int |
|
int |
|
Icon |
|
int |
|
Component |
|
String |
|
LabelUI |
|
String |
|
int |
|
int |
|
boolean |
|
protected String |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void | |
void |
|
void |
|
void | |
void | |
void |
|
void |
|
void |
|
Methods inherited from class java.lang.Object | |
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
public JLabel()
Creates a new vertically centered, horizontally on the leading edge JLabel object with text and no icon.
public JLabel(String text)
Creates a new horizontally leading and vertically centered JLabel object with no icon and the given text.
- Parameters:
text
- The text to use with the label.
public JLabel(String text, int horizontalAlignment)
Creates a new vertically centered JLabel object with no icon and the given text and horizontal alignment.
- Parameters:
text
- The text to use with the label.horizontalAlignment
- The horizontal alignment of the label.
public JLabel(String text, Icon icon, int horizontalAlignment)
Creates a new vertically centered JLabel object with the given text, icon, and horizontal alignment.
- Parameters:
text
- The text to use with the label.icon
- The icon to use with the label.horizontalAlignment
- The horizontal alignment of the label.
public JLabel(Icon image)
Creates a new vertically and horizontally centered JLabel object with no text and the given icon.
- Parameters:
image
- The icon to use with the label.
public JLabel(Icon image, int horizontalAlignment)
Creates a new vertically centered JLabel object with no text and the given icon and horizontal alignment. By default, the text is TRAILING the image.
- Parameters:
image
- The icon to use with the label.horizontalAlignment
- The horizontal alignment of the label.
protected int checkHorizontalKey(int key, String message)
This method ensures that the key is valid as a horizontal alignment. Valid keys are: LEFT, CENTER, RIGHT, LEADING, TRAILING
- Parameters:
key
- The key to check.message
- The message of the exception to be thrown if the key is invalid.
- Returns:
- The key if it's valid.
- Throws:
IllegalArgumentException
- If the key is invalid.
protected int checkVerticalKey(int key, String message)
This method ensures that the key is valid as a vertical alignment. Valid keys are: TOP, CENTER, and BOTTOM.
- Parameters:
key
- The key to check.message
- The message of the exception to be thrown if the key is invalid.
- Returns:
- The key if it's valid.
- Throws:
IllegalArgumentException
- If the key is invalid.
public AccessibleContext getAccessibleContext()
DOCUMENT ME!
- Specified by:
- getAccessibleContext in interface Accessible
- Overrides:
- getAccessibleContext in interface JComponent
- Returns:
- The accessible context.
public Icon getDisabledIcon()
This method returns the disabled icon. The disabled icon is painted when the label is disabled. If the disabled icon is null and the active icon is an ImageIcon, this method returns a grayed version of the icon. The grayed version of the icon becomes the disabledIcon.
- Returns:
- The disabled icon.
public int getDisplayedMnemonic()
This method returns the keycode that is used for the label's mnemonic.
- Returns:
- The keycode that is used for the label's mnemonic.
public int getDisplayedMnemonicIndex()
This method returns which character in the text will be the underlined character.
- Returns:
- The index of the character that will be underlined.
public int getHorizontalAlignment()
This method returns the horziontal alignment of the label.
- Returns:
- The horizontal alignment of the label.
public int getHorizontalTextPosition()
This method returns the horizontal text position of the label.
- Returns:
- The horizontal text position.
public Icon getIcon()
This method returns the active icon. The active icon is painted when the label is enabled.
- Returns:
- The active icon.
public int getIconTextGap()
This method returns the gap between the icon and the text.
- Returns:
- The gap between the icon and the text.
public Component getLabelFor()
This method returns the component that the label gives focus to when the mnemonic is activated.
- Returns:
- The component that gets focus when the label's mnemonic is activated.
public LabelUI getUI()
This method returns the label's UI delegate.
- Returns:
- The label's UI delegate.
public String getUIClassID()
This method returns a name to identify which look and feel class will be the UI delegate for this label.
- Overrides:
- getUIClassID in interface JComponent
- Returns:
- The UIClass identifier. "LabelUI"
public int getVerticalAlignment()
This method returns the vertical alignment of the label.
- Returns:
- The vertical alignment of the label.
public int getVerticalTextPosition()
This method returns the vertical text position of the label.
- Returns:
- The vertical text position of the label.
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)
This method simply returns false if the current icon image (current icon will depend on whether the label is enabled) is not equal to the passed in image.
- Specified by:
- imageUpdate in interface ImageObserver
- Overrides:
- imageUpdate in interface Component
- Parameters:
img
- The image to check.infoflags
- The bitwise inclusive OR of ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, and WIDTHx
- The x positiony
- The y positionw
- The widthh
- The height
- Returns:
- Whether the current icon image is equal to the image given.
protected String paramString()
This method is used primarily for debugging purposes and returns a string that can be used to represent this label.
- Overrides:
- paramString in interface JComponent
- Returns:
- A string to represent this label.
public void setDisabledIcon(Icon newIcon)
This method changes the "disabledIcon" property. This icon (the disabled icon) will be the one displayed when the label is disabled.
- Parameters:
newIcon
- The disabled icon.
public void setDisplayedMnemonic(char mnemonic)
This method sets the character that will be the mnemonic used. If the label is used as a label for another component, the label will give focus to that component when the mnemonic is activated.
- Parameters:
mnemonic
- The character to use for the mnemonic.
public void setDisplayedMnemonic(int mnemonic)
This method sets the keycode that will be the label's mnemonic. If the label is used as a label for another component, the label will give focus to that component when the mnemonic is activated.
- Parameters:
mnemonic
- The keycode to use for the mnemonic.
public void setDisplayedMnemonicIndex(int newIndex) throws IllegalArgumentException
This method sets which character in the text will be the underlined character. If the given index is -1, then this indicates that there is no mnemonic. If the index is less than -1 or if the index is equal to the length, this method will throw an IllegalArgumentException.
- Parameters:
newIndex
- The index of the character to underline.
- Throws:
IllegalArgumentException
- If index less than -1 or index equals length.
public void setFont(Font f)
This method overrides setFont so that we can call for a repaint after the font is changed.
- Overrides:
- setFont in interface JComponent
- Parameters:
f
- The font for this label.
public void setHorizontalAlignment(int alignment)
This method changes the "horizontalAlignment" property. The horizontal alignment determines where the label will be placed horizontally.
- Parameters:
alignment
- The horizontal alignment of the label.
public void setHorizontalTextPosition(int textPosition)
This method changes the "horizontalTextPosition" property of the label. The horizontal text position determines where the text will be placed horizontally relative to the icon.
- Parameters:
textPosition
- The horizontal text position.
public void setIcon(Icon newIcon)
This method changes the "icon" property. This icon (the active icon) will be the one displayed when the label is enabled.
- Parameters:
newIcon
- The active icon.
public void setIconTextGap(int newGap)
This method changes the "iconTextGap" property. The iconTextGap determines how much space there is between the icon and the text.
- Parameters:
newGap
- The gap between the icon and the text.
public void setLabelFor(Component c)
This method changes the "labelFor" property. The component that the label is acting as a label for will request focus when the label's mnemonic is activated.
- Parameters:
c
- The component that gets focus when the label's mnemonic is activated.
public void setText(String newText)
This method changes the "text" property. The given text will be painted in the label.
- Parameters:
newText
- The label's text.
public void setUI(LabelUI ui)
This method sets the label's UI delegate.
- Parameters:
ui
- The label's UI delegate.
public void setVerticalAlignment(int alignment)
This method changes the "verticalAlignment" property of the label. The vertical alignment determines how where the label will be placed vertically. If the alignment is not valid, it will default to the center.
- Parameters:
alignment
- The vertical alignment of the label.
public void setVerticalTextPosition(int textPosition)
This method changes the "verticalTextPosition" property of the label. The vertical text position determines where the text will be placed vertically relative to the icon.
- Parameters:
textPosition
- The vertical text position.
public void updateUI()
This method resets the label's UI delegate to the default UI for the current look and feel.
- Overrides:
- updateUI in interface JComponent
GNU Classpath (0.20) |