Class PlainView

protected FontMetrics metrics

public PlainView(Element elem)

Creates a new View instance.

Parameters:

elem - an Element value

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

This method is called when attributes were changed in the Document in a location that this view is responsible for.

Overrides:

changedUpdate in interface View

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

Repaint the given line range. This is called from insertUpdate, changedUpdate, and removeUpdate when no new lines were added and no lines were removed, to repaint the line that was modified.

Parameters:

line0 - the start of the range

line1 - the end of the range

a - the rendering region of the host

host - the Component that uses this View (used to call repaint on that Component)

Since:

1.4

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

Draws a line of text. The X and Y coordinates specify the start of the baseline of the line.

Parameters:

lineIndex - the index of the line

g - the graphics to use for drawing the text

x - the X coordinate of the baseline

y - the Y coordinate of the baseline

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

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

Draws a chunk of unselected text.

Parameters:

g - the graphics to use for drawing the text

x - the X coordinate of the baseline

y - the Y coordinate of the baseline

p0 - the start position in the text model

p1 - the end position in the text model

Returns:

the X location of the end of the range

Throws:

BadLocationException - if p0 or p1 are invalid

protected final Segment getLineBuffer()

Provides a Segment object, that can be used to fetch text from the document.

public float getPreferredSpan(int axis)

Returns the preferred span along the specified axis. Normally the view is rendered with the span returned here if that is possible.

Overrides:

getPreferredSpan in interface View

Parameters:

axis - the axis

Returns:

the preferred span along the specified axis

protected int getTabSize()

Returns the tab size of a tab. Checks the Document's properties for PlainDocument.tabSizeAttribute and returns it if it is defined, otherwise returns 8.

Returns:

the tab size.

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

This method is called when something is inserted into the Document that this View is displaying.

Overrides:

insertUpdate in interface View

Parameters:

changes - the DocumentEvent for the changes.

a - the allocation of the View

f - the ViewFactory used to rebuild

protected Rectangle lineToRect(Shape a,
                               int line)

Since:

1.4

public Shape modelToView(int position,
                         Shape a,
                         Position.Bias b)
            throws BadLocationException

Maps a position in the document into the coordinate space of the View. The output rectangle usually reflects the font height but has a width of zero.

Overrides:

modelToView in interface View

Parameters:

a - the area that is occupied by the view

b - either Position.Bias.Forward or Position.Bias.Backward depending on the preferred direction bias. If null this defaults to Position.Bias.Forward

Returns:

a rectangle that gives the location of the document position inside the view coordinate space

Throws:

BadLocationException - if pos is invalid

IllegalArgumentException - if b is not one of the above listed valid values

public float nextTabStop(float x,
                         int tabStop)

Returns the next tab stop position after a given reference position. This implementation ignores the tabStop argument.

Specified by:

nextTabStop in interface TabExpander

Parameters:

x - the current x position in pixels

tabStop - the position within the text stream that the tab occured at

public void paint(Graphics g,
                  Shape s)

Overrides:

paint in interface View

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

This method is called when something is removed from the Document that this View is displaying.

Overrides:

removeUpdate in interface View

Parameters:

changes - the DocumentEvent for the changes.

a - the allocation of the View

f - the ViewFactory used to rebuild

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

Since insertUpdate and removeUpdate each deal with children Elements being both added and removed, they both have to perform the same checks. So they both simply call this method.

Parameters:

changes - the DocumentEvent for the changes to the Document.

a - the allocation of the View.

f - the ViewFactory to use for rebuilding.

protected void updateMetrics()

Since:

1.4

public int viewToModel(float x,
                       float y,
                       Shape a,
                       Position.Bias[] b)

Maps coordinates from the View's space into a position in the document model.

Overrides:

viewToModel in interface View

Parameters:

x - the x coordinate in the view space

y - the y coordinate in the view space

a - the allocation of this View

b - the bias to use

Returns:

the position in the document that corresponds to the screen coordinates x, y