public class

PlainView

extends View
implements TabExpander
java.lang.Object
   ↳ javax.swing.text.View
     ↳ javax.swing.text.PlainView
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Implements View interface for a simple multi-line text view that has text in one font and color. The view represents each child element as a line of text.

See Also

Summary

[Expand]
Inherited Constants
From class javax.swing.text.View
From interface javax.swing.SwingConstants
Fields
protected FontMetrics metrics Font metrics for the current font.
Public Constructors
PlainView(Element elem)
Constructs a new PlainView wrapped on an element.
Public Methods
void changedUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Gives notification from the document that attributes were changed in a location that this view is responsible for.
float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.
void insertUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Gives notification that something was inserted into the document in a location that this view is responsible for.
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.
float nextTabStop(float x, int tabOffset)
Returns the next tab stop position after a given reference position.
void paint(Graphics g, Shape a)
Renders using the given rendering surface and area on that surface.
void removeUpdate(DocumentEvent changes, Shape a, ViewFactory f)
Gives notification that something was removed from the document in a location that this view is responsible for.
void setSize(float width, float height)
Sets the size of the view.
int viewToModel(float fx, float fy, Shape a, Bias[] bias)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.
Protected Methods
void damageLineRange(int line0, int line1, Shape a, Component host)
Repaint the given line range.
void drawLine(int lineIndex, Graphics g, int x, int y)
Renders a line of text, suppressing whitespace at the end and expanding any tabs.
int drawSelectedText(Graphics g, int x, int y, int p0, int p1)
Renders the given range in the model as selected text.
int drawUnselectedText(Graphics g, int x, int y, int p0, int p1)
Renders the given range in the model as normal unselected text.
final Segment getLineBuffer()
Gives access to a buffer that can be used to fetch text from the associated document.
int getTabSize()
Returns the tab size set for the document, defaulting to 8.
Rectangle lineToRect(Shape a, int line)
Determine the rectangle that represents the given line.
void updateDamage(DocumentEvent changes, Shape a, ViewFactory f)
Repaint the region of change covered by the given document event.
void updateMetrics()
Checks to see if the font metrics and longest line are up-to-date.
[Expand]
Inherited Methods
From class javax.swing.text.View
From class java.lang.Object
From interface javax.swing.text.TabExpander

Fields

protected FontMetrics metrics

Font metrics for the current font.

Public Constructors

public PlainView (Element elem)

Constructs a new PlainView wrapped on an element.

Parameters
elem the element

Public Methods

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

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

Parameters
changes 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
See Also

public float getPreferredSpan (int axis)

Determines the preferred span for this view along an axis.

Parameters
axis may be either View.X_AXIS or View.Y_AXIS
Returns
  • the span the view would like to be rendered into >= 0. Typically the view is told to render into the span that is returned, although there is no guarantee. The parent may choose to resize or break the view.
Throws
IllegalArgumentException for an invalid axis

public void insertUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Gives notification that something was inserted into the document in a location that this view is responsible for.

Parameters
changes 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
See Also

public 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.

Parameters
pos the position to convert >= 0
a the allocated region to render into
b the bias toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b will have one of these values:
  • Position.Bias.Forward
  • Position.Bias.Backward
Returns
  • the bounding box of the given position
Throws
BadLocationException if the given position does not represent a valid location in the associated document
See Also

public float nextTabStop (float x, int tabOffset)

Returns the next tab stop position after a given reference position. This implementation does not support things like centering so it ignores the tabOffset argument.

Parameters
x the current position >= 0
tabOffset the position within the text stream that the tab occurred at >= 0.
Returns
  • the tab stop, measured in points >= 0

public void paint (Graphics g, Shape a)

Renders using the given rendering surface and area on that surface. The view may need to do layout and create child views to enable itself to render into the given allocation.

Parameters
g the rendering surface to use
a the allocated region to render into
See Also

public void removeUpdate (DocumentEvent changes, Shape a, ViewFactory f)

Gives notification that something was removed from the document in a location that this view is responsible for.

Parameters
changes 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
See Also

public void setSize (float width, float height)

Sets the size of the view. This should cause layout of the view along the given axis, if it has any layout duties.

Parameters
width the width >= 0
height the height >= 0

public int viewToModel (float fx, float fy, Shape a, Bias[] bias)

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters
fx the X coordinate >= 0
fy the Y coordinate >= 0
a the allocated region to render into
Returns
  • the location within the model that best represents the given point in the view >= 0
See Also

Protected Methods

protected void damageLineRange (int line0, int line1, Shape a, Component host)

Repaint the given line range.

Parameters
line0 the starting line number to repaint. This must be a valid line number in the model.
line1 the ending line number to repaint. This must be a valid line number in the model.
a the region allocated for the view to render into
host the component hosting the view (used to call repaint)

protected void drawLine (int lineIndex, Graphics g, int x, int y)

Renders a line of text, suppressing whitespace at the end and expanding any tabs. This is implemented to make calls to the methods drawUnselectedText and drawSelectedText so that the way selected and unselected text are rendered can be customized.

Parameters
lineIndex the line to draw >= 0
g the Graphics context
x the starting X position >= 0
y the starting Y position >= 0
See Also

protected int drawSelectedText (Graphics g, int x, int y, int p0, int p1)

Renders the given range in the model as selected text. This is implemented to render the text in the color specified in the hosting component. It assumes the highlighter will render the selected background.

Parameters
g the graphics context
x the starting X coordinate >= 0
y the starting Y coordinate >= 0
p0 the beginning position in the model >= 0
p1 the ending position in the model >= 0
Returns
  • the location of the end of the range
Throws
BadLocationException if the range is invalid

protected int drawUnselectedText (Graphics g, int x, int y, int p0, int p1)

Renders the given range in the model as normal unselected text. Uses the foreground or disabled color to render the text.

Parameters
g the graphics context
x the starting X coordinate >= 0
y the starting Y coordinate >= 0
p0 the beginning position in the model >= 0
p1 the ending position in the model >= 0
Returns
  • the X location of the end of the range >= 0
Throws
BadLocationException if the range is invalid

protected final Segment getLineBuffer ()

Gives access to a buffer that can be used to fetch text from the associated document.

Returns
  • the buffer

protected int getTabSize ()

Returns the tab size set for the document, defaulting to 8.

Returns
  • the tab size

protected Rectangle lineToRect (Shape a, int line)

Determine the rectangle that represents the given line.

Parameters
a the region allocated for the view to render into
line the line number to find the region of. This must be a valid line number in the model.

protected void updateDamage (DocumentEvent changes, Shape a, ViewFactory f)

Repaint the region of change covered by the given document event. Damages the line that begins the range to cover the case when the insert/remove is only on one line. If lines are added or removed, damages the whole view. The longest line is checked to see if it has changed.

protected void updateMetrics ()

Checks to see if the font metrics and longest line are up-to-date.