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

InlineView

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

View	breakView(int axis, int p0, float pos, float len) Breaks this view on the given axis at the given length.
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.
void	checkPainter() Check to see that a glyph painter exists.
final Object	clone() Creates a shallow copy.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
Color	getBackground() Fetch the background color to use to render the glyphs.
int	getBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.
int	getEndOffset() Fetches the portion of the model that this view is responsible for.
Font	getFont() Fetch the font that the glyphs should be based upon.
Color	getForeground() Fetch the foreground color to use to render the glyphs.
GlyphView.GlyphPainter	getGlyphPainter() Fetch the currently installed glyph painter.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location that one might place a caret.
float	getPartialSpan(int p0, int p1) Determines the span along the same axis as tab expansion for a portion of the view.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getStartOffset() Fetches the portion of the model that this view is responsible for.
TabExpander	getTabExpander() Fetch the TabExpander to use if tabs are present in this view.
float	getTabbedSpan(float x, TabExpander e) Determines the desired span when using the given tab expansion implementation.
Segment	getText(int p0, int p1) Fetch a reference to the text that occupies the given range.
void	insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
boolean	isStrikeThrough() Determine if the glyphs should have a strikethrough line.
boolean	isSubscript() Determine if the glyphs should be rendered as superscript.
boolean	isSuperscript() Determine if the glyphs should be rendered as subscript.
boolean	isUnderline() Determine if the glyphs should be underlined.
Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
void	paint(Graphics g, Shape a) Renders a portion of a text style run.
void	removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	setGlyphPainter(GlyphView.GlyphPainter p) Sets the painter to use for rendering glyphs.
int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class javax.swing.text.View

void	append(View v) Appends a single child view.
View	breakView(int axis, int offset, float pos, float len) Tries to break this view on the given axis.
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.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
void	forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards the `DocumentEvent` to the give child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
AttributeSet	getAttributes() Fetches the attributes to use when rendering.
int	getBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
Container	getContainer() Fetches the container hosting the view.
Document	getDocument() Fetches the model associated with the view.
Element	getElement() Fetches the structural portion of the subject that this view is mapped to.
int	getEndOffset() Fetches the portion of the model for which this view is responsible.
Graphics	getGraphics() Fetch a `Graphics` for rendering.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis) Determines the minimum span for this view along an axis.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.
View	getParent() Returns the parent of the view.
abstract float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Determines the resizability of the view along the given axis.
int	getStartOffset() Fetches the portion of the model for which this view is responsible.
String	getToolTipText(float x, float y, Shape allocation) Returns the tooltip text at the specified location.
View	getView(int n) Gets the nth child view.
int	getViewCount() Returns the number of views in this view.
ViewFactory	getViewFactory() Fetches the `ViewFactory` implementation that is feeding the view hierarchy.
int	getViewIndex(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.
int	getViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
void	insert(int offs, View v) Inserts a single child view.
void	insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
boolean	isVisible() Returns a boolean that indicates whether the view is visible or not.
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
Shape	modelToView(int pos, Shape a) This method is deprecated. No replacement.
abstract Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
void	preferenceChanged(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.
void	remove(int i) Removes one of the children at the given position.
void	removeAll() Removes all of the children.
void	removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	replace(int offset, int length, View[] views) Replaces child views.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
boolean	updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f) Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.
void	updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a) Updates the layout in response to receiving notification of change from the model.
int	viewToModel(float x, float y, Shape a) This method is deprecated. No replacement.
abstract int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

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

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

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

Interfaces

Classes

Exceptions

LabelView

Class Overview

Summary

Public Constructors

public LabelView (Element elem)

Parameters

Public Methods

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

Parameters

See Also

public Color getBackground ()

Returns

public Font getFont ()

Returns

public Color getForeground ()

Returns

public boolean isStrikeThrough ()

Returns

public boolean isSubscript ()

Returns

public boolean isSuperscript ()

Returns

public boolean isUnderline ()

Returns

Protected Methods

protected FontMetrics getFontMetrics ()

protected void setBackground (Color bg)

Parameters

See Also

protected void setPropertiesFromAttributes ()

protected void setStrikeThrough (boolean s)

Parameters

See Also

protected void setSubscript (boolean s)

Parameters

See Also

protected void setSuperscript (boolean s)

Parameters

See Also

protected void setUnderline (boolean u)

Parameters

See Also