|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JLabel
org.jdesktop.swingx.JXLabel
public class JXLabel
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.
| Nested Class Summary | |
|---|---|
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 |
|---|
javax.swing.JLabel.AccessibleJLabel |
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
javax.swing.JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
java.awt.Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
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 |
|---|
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, 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 | |
|---|---|
JXLabel()
Create a new JXLabel. |
|
JXLabel(javax.swing.Icon image)
Creates new JXLabel with given icon. |
|
JXLabel(javax.swing.Icon image,
int horizontalAlignment)
Creates new JXLabel with given icon and alignment. |
|
JXLabel(java.lang.String text)
Create a new JXLabel with the given text as the text for the label. |
|
JXLabel(java.lang.String text,
javax.swing.Icon image,
int horizontalAlignment)
Creates new JXLabel with given text, icon and alignment. |
|
JXLabel(java.lang.String text,
int horizontalAlignment)
Creates new JXLabel with given text and alignment. |
|
| Method Summary | |
|---|---|
Painter |
getBackgroundPainter()
Returns the current background painter. |
Painter |
getForegroundPainter()
Returns the current foregroundPainter. |
int |
getHeight()
|
int |
getMaxLineSpan()
|
protected JXLabel.MultiLineSupport |
getMultiLineSupport()
|
protected int |
getOccupiedWidth()
|
java.awt.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(java.awt.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 |
setBackground(java.awt.Color bg)
|
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final double NORMAL
public static final double INVERTED
public static final double VERTICAL_LEFT
public static final double VERTICAL_RIGHT
public boolean painted
| Constructor Detail |
|---|
public JXLabel()
public JXLabel(javax.swing.Icon image)
image - the icon to set.
public JXLabel(javax.swing.Icon image,
int horizontalAlignment)
image - the icon to set.horizontalAlignment - the text alignment.public JXLabel(java.lang.String text)
JXLabel label = new JXLabel();
label.setText("Some Text");
text - the text to set.
public JXLabel(java.lang.String text,
javax.swing.Icon image,
int horizontalAlignment)
text - the test to set.image - the icon to set.horizontalAlignment - the text alignment relative to the icon.
public JXLabel(java.lang.String text,
int horizontalAlignment)
text - the test to set.horizontalAlignment - the text alignment.| Method Detail |
|---|
public final Painter getForegroundPainter()
public void reshape(int x,
int y,
int w,
int h)
reshape in class javax.swing.JComponentpublic void setBackground(java.awt.Color bg)
setBackground in class javax.swing.JComponentpublic void setForegroundPainter(Painter painter)
painter - public void setBackgroundPainter(Painter p)
setBackgroundPainter will replace that existing painter.
p - the new paintergetBackgroundPainter()public final Painter getBackgroundPainter()
setBackgroundPainter(Painter)public double getTextRotation()
setTextRotation(double)public java.awt.Dimension getPreferredSize()
getPreferredSize in class javax.swing.JComponentpublic int getMaxLineSpan()
public void setMaxLineSpan(int maxLineSpan)
public void setTextRotation(double textOrientation)
textOrientation - Value for text rotation in range <0,2PI>getTextRotation()public void setLineWrap(boolean b)
b - the new valuepublic boolean isLineWrap()
public JXLabel.TextAlignment getTextAlignment()
public void setTextAlignment(JXLabel.TextAlignment alignment)
alignment - for accepted values.public boolean isPaintBorderInsets()
public boolean isOpaque()
isOpaque in class javax.swing.JComponentpublic void setPaintBorderInsets(boolean paintBorderInsets)
paintBorderInsets - new value of the paintBorderInsets propertyprotected void paintComponent(java.awt.Graphics g)
paintComponent in class javax.swing.JComponentg - graphics to paint onpublic void repaint()
repaint in class java.awt.Component
public void repaint(int x,
int y,
int width,
int height)
repaint in class java.awt.Componentpublic void repaint(long tm)
repaint in class java.awt.Component
public void repaint(long tm,
int x,
int y,
int width,
int height)
repaint in class javax.swing.JComponentpublic int getHeight()
getHeight in class javax.swing.JComponentpublic int getWidth()
getWidth in class javax.swing.JComponentprotected JXLabel.MultiLineSupport getMultiLineSupport()
protected int getOccupiedWidth()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||