public class

LabelView

extends GlyphView
implements TabableView
java.lang.Object
   ↳ javax.swing.text.View
     ↳ javax.swing.text.GlyphView
       ↳ javax.swing.text.LabelView
Known Direct Subclasses

Class Overview

A LabelView 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.

Summary

[Expand]
Inherited Constants
From class javax.swing.text.View
From interface javax.swing.SwingConstants
Public Constructors
LabelView(Element elem)
Constructs a new view wrapped on an element.
Public Methods
void changedUpdate(DocumentEvent e, Shape a, ViewFactory f)
Gives notification from the document that attributes were changed in a location that this view is responsible for.
Color getBackground()
Fetches the background color to use to render the glyphs.
Font getFont()
Fetches the font that the glyphs should be based upon.
Color getForeground()
Fetches the foreground color to use to render the glyphs.
boolean isStrikeThrough()
Determines if the glyphs should have a strikethrough line.
boolean isSubscript()
Determines if the glyphs should be rendered as superscript.
boolean isSuperscript()
Determines if the glyphs should be rendered as subscript.
boolean isUnderline()
Determines if the glyphs should be underlined.
Protected Methods
FontMetrics getFontMetrics()
This method is deprecated. FontMetrics are not used for glyph rendering when running in the JDK.
void setBackground(Color bg)
Sets the background color for the view.
void setPropertiesFromAttributes()
Sets the cached properties from the attributes.
void setStrikeThrough(boolean s)
Sets whether or not the view has a strike/line through it.
void setSubscript(boolean s)
Sets whether or not the view represents a subscript.
void setSuperscript(boolean s)
Sets whether or not the view represents a superscript.
void setUnderline(boolean u)
Sets whether or not the view is underlined.
[Expand]
Inherited Methods
From class javax.swing.text.GlyphView
From class javax.swing.text.View
From class java.lang.Object
From interface javax.swing.text.TabableView

Public Constructors

public LabelView (Element elem)

Constructs a new view wrapped on an element.

Parameters
elem the element

Public Methods

public void changedUpdate (DocumentEvent e, Shape a, ViewFactory f)

Gives notification from the document that attributes were changed in a location that this view is responsible for.

Parameters
e the change information from the associated document
a the current allocation of the view
f the factory to use to rebuild if the view has children

public Color getBackground ()

Fetches the background color to use to render the glyphs. This is implemented to return a cached background color, which defaults to null.

Returns
  • the cached background color

public Font getFont ()

Fetches the font that the glyphs should be based upon. This is implemented to return a cached font.

Returns
  • the cached font

public Color getForeground ()

Fetches the foreground color to use to render the glyphs. This is implemented to return a cached foreground color, which defaults to null.

Returns
  • the cached foreground color

public boolean isStrikeThrough ()

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 strikeThrough property.

When you request this property, LabelView re-syncs its state with the properties of the Element's AttributeSet. If Element's AttributeSet does not have this property set, it will revert to false.

Returns
  • the value of the cached strikeThrough property

public boolean isSubscript ()

Determines if the glyphs should be rendered as superscript.

Returns
  • the value of the cached subscript property

    When you request this property, LabelView re-syncs its state with the properties of the Element's AttributeSet. If Element's AttributeSet does not have this property set, it will revert to false.the value of the cached subscript property

public boolean isSuperscript ()

Determines if the glyphs should be rendered as subscript.

When you request this property, LabelView re-syncs its state with the properties of the Element's AttributeSet. If Element's AttributeSet does not have this property set, it will revert to false.

Returns
  • the value of the cached superscript property

public boolean isUnderline ()

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.

When you request this property, LabelView re-syncs its state with the properties of the Element's AttributeSet. If Element's AttributeSet does not have this property set, it will revert to false.

Returns
  • the value of the cached underline property

Protected Methods

protected FontMetrics getFontMetrics ()

This method is deprecated.
FontMetrics are not used for glyph rendering when running in the JDK.

Fetches the FontMetrics used for this view.

protected void setBackground (Color bg)

Sets the background color for the view. This method is typically invoked as part of configuring this View. If you need to customize the background color you should override setPropertiesFromAttributes and invoke this method. A value of null indicates no background should be rendered, so that the background of the parent View will show through.

Parameters
bg background color, or null

protected void setPropertiesFromAttributes ()

Sets the cached properties from the attributes.

protected void setStrikeThrough (boolean s)

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.

Parameters
s true if the view has a strike/line through it, otherwise false

protected void setSubscript (boolean 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.

Parameters
s true if the view represents a subscript, otherwise false
See Also

protected void setSuperscript (boolean 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.

Parameters
s true if the view represents a superscript, otherwise false
See Also

protected void setUnderline (boolean u)

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.

Parameters
u true if the view is underlined, otherwise false
See Also