org.jdesktop.swingx

Class JXLabel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

org.jdesktop.swingx.JXLabel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

Direct Known Subclasses:

BasicHeaderUI.DescriptionPane

@JavaBean
public class JXLabel
extends JLabel

A JLabel subclass which supports Painters, multi-line text, and text rotation.

Painter support consists of the foregroundPainter and backgroundPainter properties. The backgroundPainter refers to a painter responsible for painting beneath the text and icon. This painter, if set, will paint regardless of the opaque property. If the background painter does not fully paint each pixel, then you should make sure the opaque property is set to false.

The foregroundPainter is responsible for painting the icon and the text label. If no foregroundPainter is specified, then the look and feel will paint the label. Note that if opaque is set to true and the look and feel is rendering the foreground, then the foreground may paint over the background. Most look and feels will paint a background when opaque is true. To avoid this behavior, set opaque to false.

Since JXLabel is not opaque by default (isOpaque() returns false), neither of these problems typically present themselves.

Multi-line text is enabled via the lineWrap property. Simply set it to true. By default, line wrapping occurs on word boundaries.

The text (actually, the entire foreground and background) of the JXLabel may be rotated. Set the rotation property to specify what the rotation should be. Specify rotation angle in radian units.

Author:

joshua.marinacci@sun.com, rbair, rah, mario_cesar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	JXLabel.IValue
static class	JXLabel.MultiLineSupport
static class	JXLabel.TextAlignment Text alignment enums.

Nested classes/interfaces inherited from class javax.swing.JLabel

JLabel.AccessibleJLabel

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static double	INVERTED
static double	NORMAL
boolean	painted
static double	VERTICAL_LEFT
static double	VERTICAL_RIGHT

Fields inherited from class javax.swing.JLabel

labelFor

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JXLabel() Create a new JXLabel.
JXLabel(Icon image) Creates new JXLabel with given icon.
JXLabel(Icon image, int horizontalAlignment) Creates new JXLabel with given icon and alignment.
JXLabel(String text) Create a new JXLabel with the given text as the text for the label.
JXLabel(String text, Icon image, int horizontalAlignment) Creates new JXLabel with given text, icon and alignment.
JXLabel(String text, int horizontalAlignment) Creates new JXLabel with given text and alignment.

Method Summary

Modifier and Type	Method and Description
Painter	getBackgroundPainter() Returns the current background painter.
Painter	getForegroundPainter() Returns the current foregroundPainter.
int	getHeight()
int	getMaxLineSpan()
protected JXLabel.MultiLineSupport	getMultiLineSupport()
protected int	getOccupiedWidth()
Dimension	getPreferredSize()
JXLabel.TextAlignment	getTextAlignment() Gets current text wrapping style.
double	getTextRotation() Gets current value of text rotation in rads.
int	getWidth()
boolean	isLineWrap() Returns the current status of line wrap support.
boolean	isOpaque()
boolean	isPaintBorderInsets() Returns true if the background painter should paint where the border is or false if it should only paint inside the border.
protected void	paintComponent(Graphics g)
void	repaint()
void	repaint(int x, int y, int width, int height)
void	repaint(long tm)
void	repaint(long tm, int x, int y, int width, int height)
void	reshape(int x, int y, int w, int h)
void	setBackgroundPainter(Painter p) Sets a Painter to use to paint the background of this component By default there is already a single painter installed which draws the normal background for this component according to the current Look and Feel.
void	setForegroundPainter(Painter painter) Sets a new foregroundPainter on the label.
void	setLineWrap(boolean b) Enables line wrapping support for plain text.
void	setMaxLineSpan(int maxLineSpan)
void	setPaintBorderInsets(boolean paintBorderInsets) Sets the paintBorderInsets property.
void	setTextAlignment(JXLabel.TextAlignment alignment) Sets style of wrapping the text.
void	setTextRotation(double textOrientation) Sets new value for text rotation.

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NORMAL

public static final double NORMAL

See Also:

Constant Field Values

INVERTED

public static final double INVERTED

See Also:

Constant Field Values

VERTICAL_LEFT

public static final double VERTICAL_LEFT

See Also:

Constant Field Values

VERTICAL_RIGHT

public static final double VERTICAL_RIGHT

See Also:

Constant Field Values

painted

public boolean painted

Constructor Detail

JXLabel

public JXLabel()

Create a new JXLabel. This has the same semantics as creating a new JLabel.

JXLabel

public JXLabel(Icon image)

Creates new JXLabel with given icon.

Parameters:

image - the icon to set.

JXLabel

public JXLabel(Icon image,
               int horizontalAlignment)

Creates new JXLabel with given icon and alignment.

Parameters:

image - the icon to set.

horizontalAlignment - the text alignment.

JXLabel

public JXLabel(String text)

Create a new JXLabel with the given text as the text for the label. This is shorthand for:

 JXLabel label = new JXLabel();
 label.setText("Some Text");
 

Parameters:

text - the text to set.

JXLabel

public JXLabel(String text,
               Icon image,
               int horizontalAlignment)

Creates new JXLabel with given text, icon and alignment.

Parameters:

text - the test to set.

image - the icon to set.

horizontalAlignment - the text alignment relative to the icon.

JXLabel

public JXLabel(String text,
               int horizontalAlignment)

Creates new JXLabel with given text and alignment.

Parameters:

text - the test to set.

horizontalAlignment - the text alignment.

Method Detail

getForegroundPainter

public final Painter getForegroundPainter()

Returns the current foregroundPainter. This is a bound property. By default the foregroundPainter will be an internal painter which executes the standard painting code (paintComponent()).

Returns:

the current foreground painter.

reshape

public void reshape(int x,
                    int y,
                    int w,
                    int h)

Overrides:

reshape in class JComponent

setForegroundPainter

public void setForegroundPainter(Painter painter)

Sets a new foregroundPainter on the label. This will replace the existing foreground painter. Existing painters can be wrapped by using a CompoundPainter.

Parameters:

painter -

setBackgroundPainter

public void setBackgroundPainter(Painter p)

Sets a Painter to use to paint the background of this component By default there is already a single painter installed which draws the normal background for this component according to the current Look and Feel. Calling setBackgroundPainter will replace that existing painter.

Parameters:

p - the new painter

See Also:

getBackgroundPainter()

getBackgroundPainter

public final Painter getBackgroundPainter()

Returns the current background painter. The default value of this property is a painter which draws the normal JPanel background according to the current look and feel.

Returns:

the current painter

See Also:

setBackgroundPainter(Painter)

getTextRotation

public double getTextRotation()

Gets current value of text rotation in rads.

Returns:

a double representing the current rotation of the text

See Also:

setTextRotation(double)

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getMaxLineSpan

public int getMaxLineSpan()

setMaxLineSpan

public void setMaxLineSpan(int maxLineSpan)

setTextRotation

public void setTextRotation(double textOrientation)

Sets new value for text rotation. The value can be anything in range <0,2PI>. Note that although property name suggests only text rotation, the whole foreground painter is rotated in fact. Due to various reasons it is strongly discouraged to access any size related properties of the label from other threads then EDT when this property is set.

Parameters:

textOrientation - Value for text rotation in range <0,2PI>

See Also:

getTextRotation()

setLineWrap

public void setLineWrap(boolean b)

Enables line wrapping support for plain text. By default this support is disabled to mimic default of the JLabel. Value of this property has no effect on HTML text.

Parameters:

b - the new value

isLineWrap

public boolean isLineWrap()

Returns the current status of line wrap support. The default value of this property is false to mimic default JLabel behavior. Value of this property has no effect on HTML text.

Returns:

the current multiple line splitting status

getTextAlignment

public JXLabel.TextAlignment getTextAlignment()

Gets current text wrapping style.

Returns:

the text alignment for this label

setTextAlignment

public void setTextAlignment(JXLabel.TextAlignment alignment)

Sets style of wrapping the text.

Parameters:

alignment -

See Also:

for accepted values.

isPaintBorderInsets

public boolean isPaintBorderInsets()

Returns true if the background painter should paint where the border is or false if it should only paint inside the border. This property is true by default. This property affects the width, height, and initial transform passed to the background painter.

Returns:

current value of the paintBorderInsets property

isOpaque

public boolean isOpaque()

Overrides:

isOpaque in class JComponent

setPaintBorderInsets

public void setPaintBorderInsets(boolean paintBorderInsets)

Sets the paintBorderInsets property. Set to true if the background painter should paint where the border is or false if it should only paint inside the border. This property is true by default. This property affects the width, height, and initial transform passed to the background painter. This is a bound property.

Parameters:

paintBorderInsets - new value of the paintBorderInsets property

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

Parameters:

g - graphics to paint on

repaint

public void repaint()

Overrides:

repaint in class Component

repaint

public void repaint(int x,
                    int y,
                    int width,
                    int height)

Overrides:

repaint in class Component

repaint

public void repaint(long tm)

Overrides:

repaint in class Component

repaint

public void repaint(long tm,
                    int x,
                    int y,
                    int width,
                    int height)

Overrides:

repaint in class JComponent

getHeight

public int getHeight()

Overrides:

getHeight in class JComponent

getWidth

public int getWidth()

Overrides:

getWidth in class JComponent

getMultiLineSupport

protected JXLabel.MultiLineSupport getMultiLineSupport()

getOccupiedWidth

protected int getOccupiedWidth()