1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
/* * @(#)LabelView.java 1.70 06/04/07 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.text; import java.awt.*; import javax.swing.event.*; /** * A <code>LabelView</code> is a styled chunk of text * that represents a view mapped over an element in the * text model. It caches the character level attributes * used for rendering. * * @author Timothy Prinzing * @version 1.70 04/07/06 */ public class LabelView extends GlyphView implements TabableView { /** * Constructs a new view wrapped on an element. * * @param elem the element */ public LabelView(Element elem) { super(elem); } /** * Synchronize the view's cached values with the model. * This causes the font, metrics, color, etc to be * re-cached if the cache has been invalidated. */ final void sync() { if (font == null) { setPropertiesFromAttributes(); } } /** * Sets whether or not the view is underlined. * Note that this setter is protected and is really * only meant if you need to update some additional * state when set. * * @param u true if the view is underlined, otherwise * false * @see #isUnderline */ protected void setUnderline(boolean u) { underline = u; } /** * Sets whether or not the view has a strike/line * through it. * Note that this setter is protected and is really * only meant if you need to update some additional * state when set. * * @param s true if the view has a strike/line * through it, otherwise false * @see #isStrikeThrough */ protected void setStrikeThrough(boolean s) { strike = s; } /** * Sets whether or not the view represents a * superscript. * Note that this setter is protected and is really * only meant if you need to update some additional * state when set. * * @param s true if the view represents a * superscript, otherwise false * @see #isSuperscript */ protected void setSuperscript(boolean s) { superscript = s; } /** * Sets whether or not the view represents a * subscript. * Note that this setter is protected and is really * only meant if you need to update some additional * state when set. * * @param s true if the view represents a * subscript, otherwise false * @see #isSubscript */ protected void setSubscript(boolean s) { subscript = s; } /** * Sets the background color for the view. This method is typically * invoked as part of configuring this <code>View</code>. If you need * to customize the background color you should override * <code>setPropertiesFromAttributes</code> and invoke this method. A * value of null indicates no background should be rendered, so that the * background of the parent <code>View</code> will show through. * * @param bg background color, or null * @see #setPropertiesFromAttributes * @since 1.5 */ protected void setBackground(Color bg) { this.bg = bg; } /** * Sets the cached properties from the attributes. */ protected void setPropertiesFromAttributes() { AttributeSet attr = getAttributes(); if (attr != null) { Document d = getDocument(); if (d instanceof StyledDocument) { StyledDocument doc = (StyledDocument) d; font = doc.getFont(attr); fg = doc.getForeground(attr); if (attr.isDefined(StyleConstants.Background)) { bg = doc.getBackground(attr); } else { bg = null; } setUnderline(StyleConstants.isUnderline(attr)); setStrikeThrough(StyleConstants.isStrikeThrough(attr)); setSuperscript(StyleConstants.isSuperscript(attr)); setSubscript(StyleConstants.isSubscript(attr)); } else { throw new StateInvariantError("LabelView needs StyledDocument"); } } } /** * Fetches the <code>FontMetrics</code> used for this view. * @deprecated FontMetrics are not used for glyph rendering * when running in the JDK. */ @Deprecated protected FontMetrics getFontMetrics() { sync(); Container c = getContainer(); return (c != null) ? c.getFontMetrics(font) : Toolkit.getDefaultToolkit().getFontMetrics(font); } /** * Fetches the background color to use to render the glyphs. * This is implemented to return a cached background color, * which defaults to <code>null</code>. * * @return the cached background color * @since 1.3 */ public Color getBackground() { sync(); return bg; } /** * Fetches the foreground color to use to render the glyphs. * This is implemented to return a cached foreground color, * which defaults to <code>null</code>. * * @return the cached foreground color * @since 1.3 */ public Color getForeground() { sync(); return fg; } /** * Fetches the font that the glyphs should be based upon. * This is implemented to return a cached font. * * @return the cached font */ public Font getFont() { sync(); return font; } /** * Determines if the glyphs should be underlined. If true, * an underline should be drawn through the baseline. This * is implemented to return the cached underline property. * * <p>When you request this property, <code>LabelView</code> * re-syncs its state with the properties of the * <code>Element</code>'s <code>AttributeSet</code>. * If <code>Element</code>'s <code>AttributeSet</code> * does not have this property set, it will revert to false. * * @return the value of the cached * <code>underline</code> property * @since 1.3 */ public boolean isUnderline() { sync(); return underline; } /** * Determines if the glyphs should have a strikethrough * line. If true, a line should be drawn through the center * of the glyphs. This is implemented to return the * cached <code>strikeThrough</code> property. * * <p>When you request this property, <code>LabelView</code> * re-syncs its state with the properties of the * <code>Element</code>'s <code>AttributeSet</code>. * If <code>Element</code>'s <code>AttributeSet</code> * does not have this property set, it will revert to false. * * @return the value of the cached * <code>strikeThrough</code> property * @since 1.3 */ public boolean isStrikeThrough() { sync(); return strike; } /** * Determines if the glyphs should be rendered as superscript. * @return the value of the cached subscript property * * <p>When you request this property, <code>LabelView</code> * re-syncs its state with the properties of the * <code>Element</code>'s <code>AttributeSet</code>. * If <code>Element</code>'s <code>AttributeSet</code> * does not have this property set, it will revert to false. * * @return the value of the cached * <code>subscript</code> property * @since 1.3 */ public boolean isSubscript() { sync(); return subscript; } /** * Determines if the glyphs should be rendered as subscript. * * <p>When you request this property, <code>LabelView</code> * re-syncs its state with the properties of the * <code>Element</code>'s <code>AttributeSet</code>. * If <code>Element</code>'s <code>AttributeSet</code> * does not have this property set, it will revert to false. * * @return the value of the cached * <code>superscript</code> property * @since 1.3 */ public boolean isSuperscript() { sync(); return superscript; } // --- View methods --------------------------------------------- /** * Gives notification from the document that attributes were changed * in a location that this view is responsible for. * * @param e the change information from the associated document * @param a the current allocation of the view * @param f the factory to use to rebuild if the view has children * @see View#changedUpdate */ public void changedUpdate(DocumentEvent e, Shape a, ViewFactory f) { font = null; super.changedUpdate(e, a, f); } // --- variables ------------------------------------------------ private Font font; private Color fg; private Color bg; private boolean underline; private boolean strike; private boolean superscript; private boolean subscript; }