This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link + * #render} as this method invalidates the layout information. * - * @return true if the text changed as a result of being set, false if - * the label was already displaying the requested text. + * @return true if the text changed as a result of being set, false if the label was already + * displaying the requested text. */ public boolean setText (String text) { - // the Java text stuff freaks out in a variety of ways if it is - // asked to deal with the empty string, so we fake blank labels by - // just using a space + // the Java text stuff freaks out in a variety of ways if it is asked to deal with the + // empty string, so we fake blank labels by just using a space if (StringUtil.isBlank(text)) { text = " "; } @@ -178,8 +167,8 @@ public class Label implements SwingConstants, LabelStyleConstants } // _text should contain the text without any tags - // _rawText will be null if there are no tags _text = filterColors(text); + // _rawText will be null if there are no tags _rawText = text.equals(_text) ? null : text; // if what we were passed contains escaped color tags, unescape them @@ -193,12 +182,11 @@ public class Label implements SwingConstants, LabelStyleConstants } /** - * Sets the font to be used by this label. If the font is not set, the - * current font of the graphics context will be used. + * Sets the font to be used by this label. If the font is not set, the current font of the + * graphics context will be used. * - *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link
+ * #render} as this method invalidates the layout information.
*/
public void setFont (Font font)
{
@@ -215,9 +203,8 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Sets the color used to render the text. Setting the text color to
- * null will render the label in the graphics context
- * color (which is the default).
+ * Sets the color used to render the text. Setting the text color to null will
+ * render the label in the graphics context color (which is the default).
*/
public void setTextColor (Color color)
{
@@ -225,8 +212,7 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Returns the alternate color used to render the text's outline or
- * shadow, if any.
+ * Returns the alternate color used to render the text's outline or shadow, if any.
*/
public Color getAlternateColor ()
{
@@ -234,10 +220,9 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Instructs the label to render the text with the specified alternate
- * color when rendering. The text itself will be rendered in whatever
- * color is currently set in the graphics context, but the outline or
- * shadow (if any) will always be in the specified color.
+ * Instructs the label to render the text with the specified alternate color when
+ * rendering. The text itself will be rendered in whatever color is currently set in the
+ * graphics context, but the outline or shadow (if any) will always be in the specified color.
*/
public void setAlternateColor (Color color)
{
@@ -253,14 +238,12 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Sets the alignment of the text within the label to either {@link
- * SwingConstants#LEFT}, {@link SwingConstants#RIGHT}, or {@link
- * SwingConstants#CENTER}. The default alignment is selected to be
- * appropriate for the locale of the text being rendered.
+ * Sets the alignment of the text within the label to either {@link SwingConstants#LEFT},
+ * {@link SwingConstants#RIGHT}, or {@link SwingConstants#CENTER}. The default alignment is
+ * selected to be appropriate for the locale of the text being rendered.
*
- *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link
+ * #render} as this method invalidates the layout information.
*/
public void setAlignment (int align)
{
@@ -268,13 +251,12 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Sets the style of the text within the label to one of the styles
- * defined in {@link LabelStyleConstants}. Some styles can be combined
- * together into a mask, ie. BOLD|UNDERLINE.
+ * Sets the style of the text within the label to one of the styles defined in {@link
+ * LabelStyleConstants}. Some styles can be combined together into a mask,
+ * ie. BOLD|UNDERLINE.
*
- *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link + * #render} as this method invalidates the layout information. */ public void setStyle (int style) { @@ -283,13 +265,11 @@ public class Label implements SwingConstants, LabelStyleConstants } /** - * Instructs the label to attempt to achieve a balance between width - * and height that approximates the golden ratio (width ~1.618 times - * height). + * Instructs the label to attempt to achieve a balance between width and height that + * approximates the golden ratio (width ~1.618 times height). * - *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link + * #render} as this method invalidates the layout information. */ public void setGoldenLayout () { @@ -300,15 +280,13 @@ public class Label implements SwingConstants, LabelStyleConstants } /** - * Sets the target width for this label. Text will be wrapped to fit - * into this width, forcibly breaking words on character boundaries if - * a single word is too long to fit into the target width. Calling - * this method will annul any previously established target height as - * we must have one degree of freedom in which to maneuver. + * Sets the target width for this label. Text will be wrapped to fit into this width, forcibly + * breaking words on character boundaries if a single word is too long to fit into the target + * width. Calling this method will annul any previously established target height as we must + * have one degree of freedom in which to maneuver. * - *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link + * #render} as this method invalidates the layout information. */ public void setTargetWidth (int targetWidth) { @@ -322,17 +300,15 @@ public class Label implements SwingConstants, LabelStyleConstants } /** - * Sets the target height for this label. A simple algorithm will be - * used to balance the width of the text in order that there are only - * as many lines of text as fit into the target height. If rendering - * the label as a single line of text causes it to be taller than the - * target height, we simply render ourselves anyway. Calling this - * method will annul any previously established target width as we - * must have one degree of freedom in which to maneuver. + * Sets the target height for this label. A simple algorithm will be used to balance the width + * of the text in order that there are only as many lines of text as fit into the target + * height. If rendering the label as a single line of text causes it to be taller than the + * target height, we simply render ourselves anyway. Calling this method will annul any + * previously established target width as we must have one degree of freedom in which to + * maneuver. * - *
This should be followed by a call to {@link #layout} before a - * call is made to {@link #render} as this method invalidates the - * layout information. + *
This should be followed by a call to {@link #layout} before a call is made to {@link
+ * #render} as this method invalidates the layout information.
*/
public void setTargetHeight (int targetHeight)
{
@@ -363,8 +339,7 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Returns our computed dimensions. Only valid after a call to {@link
- * #layout}.
+ * Returns our computed dimensions. Only valid after a call to {@link #layout}.
*/
public Dimension getSize ()
{
@@ -380,8 +355,7 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Calls {@link #layout(Graphics2D)} with the graphics context for the
- * given component.
+ * Calls {@link #layout(Graphics2D)} with the graphics context for the given component.
*/
public void layout (Component comp)
{
@@ -393,27 +367,24 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Requests that this label lay out its text, obtaining information
- * from the supplied graphics context to do so. It is expected that
- * the label will be subsequently rendered in the same graphics
- * context or at least one that is configured very similarly. If not,
- * wackiness may ensue.
+ * Requests that this label lay out its text, obtaining information from the supplied graphics
+ * context to do so. It is expected that the label will be subsequently rendered in the same
+ * graphics context or at least one that is configured very similarly. If not, wackiness may
+ * ensue.
*/
public void layout (Graphics2D gfx)
{
FontRenderContext frc = gfx.getFontRenderContext();
- ArrayListsize parameter.
+ * Computes the lines of text for this label given the specified target width. The overall size
+ * of the computed lines is stored into the size parameter.
*
- * @return an {@link ArrayList} or null if keepWordsWhole
- * was true and the lines could not be layed out in the target width.
+ * @return an {@link List} or null if keepWordsWhole was true and the lines could
+ * not be layed out in the target width.
*/
- protected ArrayListgetBounds() which
- * rarely seems to have any bearing on reality.
+ * Computes the height based on the leading, ascent and descent rather than what the layout
+ * reports via getBounds() which rarely seems to have any bearing on reality.
*/
protected float getHeight (TextLayout layout)
{
- float height = layout.getLeading() + layout.getAscent() +
- layout.getDescent();
+ float height = layout.getLeading() + layout.getAscent() + layout.getDescent();
if ((_style & OUTLINE) != 0) {
height += 2;
} else if ((_style & SHADOW) != 0) {
@@ -750,8 +697,8 @@ public class Label implements SwingConstants, LabelStyleConstants
}
/**
- * Called when the label is changed in such a way that it must be
- * relaid out before again being rendered.
+ * Called when the label is changed in such a way that it must be relaid out before again being
+ * rendered.
*/
protected void invalidate (String where)
{
@@ -777,17 +724,15 @@ public class Label implements SwingConstants, LabelStyleConstants
/** Our calculated size. */
protected Dimension _size = new Dimension();
- /** Some fonts (God bless 'em) extend to the left of the position at
- * which you request that they be rendered. We opt to push such lines
- * to the right sufficiently that they line up with the rest of the
- * lines (perhaps not the typographically ideal thing to do, but we're
- * in computer land and when we say our bounds are (0, 0, width,
- * height) we damned well better not render outside those bounds,
- * which these wonderful fonts are choosing to do). */
+ /** Some fonts (God bless 'em) extend to the left of the position at which you request that
+ * they be rendered. We opt to push such lines to the right sufficiently that they line up with
+ * the rest of the lines (perhaps not the typographically ideal thing to do, but we're in
+ * computer land and when we say our bounds are (0, 0, width, height) we damned well better not
+ * render outside those bounds, which these wonderful fonts are choosing to do). */
protected float[] _leaders;
- /** The font we use when laying out and rendering out text, or null if
- * we're to use the default font. */
+ /** The font we use when laying out and rendering out text, or null if we're to use the default
+ * font. */
protected Font _font;
/** Formatted text layout instances that contain each line of text. */
@@ -796,17 +741,16 @@ public class Label implements SwingConstants, LabelStyleConstants
/** Formatted text layout instances that contain each line of text. */
protected Rectangle2D[] _lbounds;
- /** The color in which to render the text outline or shadow if we're
- * rendering in outline or shadow mode. */
+ /** The color in which to render the text outline or shadow if we're rendering in outline or
+ * shadow mode. */
protected Color _alternateColor = null;
- /** The color in which to render the text or null if the text should
- * be rendered with the graphics context color. */
+ /** The color in which to render the text or null if the text should be rendered with the
+ * graphics context color. */
protected Color _textColor = null;
- /** Will be true only when we're drawing a textlayout for the "main"
- * portion of the label. If we are in OUTLINE mode, we draw each layout
- * 9 times: the last one is the only main one. */
+ /** Will be true only when we're drawing a textlayout for the "main" portion of the label. If
+ * we are in OUTLINE mode, we draw each layout 9 times: the last one is the only main one. */
protected boolean _mainDraw = true;
// /** Used for debugging. */
@@ -814,4 +758,7 @@ public class Label implements SwingConstants, LabelStyleConstants
/** An approximation of the golden ratio. */
protected static final double GOLDEN_RATIO = 1.618034;
+
+ /** Used by {@link #unescapeColors}. */
+ protected static final Pattern ESCAPED_PATTERN = Pattern.compile("#''([Xx]|[0-9A-Fa-f]{6}+)");
}