public class PlainView extends View implements TabExpander
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.
View
protected FontMetrics metrics
Font metrics for the current font.
public PlainView(Element elem)
Constructs a new PlainView wrapped on an element.
elem
- the elementprotected int getTabSize()
Returns the tab size set for the document, defaulting to 8.
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.
lineIndex
- the line to draw >= 0g
- the Graphics
contextx
- the starting X position >= 0y
- the starting Y position >= 0drawUnselectedText(java.awt.Graphics, int, int, int, int)
, drawSelectedText(java.awt.Graphics, int, int, int, int)
protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
Renders the given range in the model as normal unselected text. Uses the foreground or disabled color to render the text.
g
- the graphics contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- the ending position in the model >= 0BadLocationException
- if the range is invalidprotected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException
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.
g
- the graphics contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- the ending position in the model >= 0BadLocationException
- if the range is invalidprotected final Segment getLineBuffer()
Gives access to a buffer that can be used to fetch text from the associated document.
protected void updateMetrics()
Checks to see if the font metrics and longest line are up-to-date.
public float getPreferredSpan(int axis)
Determines the preferred span for this view along an axis.
getPreferredSpan
in class View
axis
- may be either View.X_AXIS or View.Y_AXISIllegalArgumentException
- for an invalid axisView.getPreferredSpan(int)
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.
paint
in class View
g
- the rendering surface to usea
- the allocated region to render intoView.paint(java.awt.Graphics, java.awt.Shape)
public Shape modelToView(int pos, Shape a, Position.Bias b) throws BadLocationException
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
modelToView
in class View
pos
- the position to convert >= 0a
- the allocated region to render intob
- 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
BadLocationException
- if the given position does not represent a valid location in the associated documentView.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)
public int viewToModel(float fx, float fy, Shape a, Position.Bias[] bias)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.
viewToModel
in class View
fx
- the X coordinate >= 0fy
- the Y coordinate >= 0a
- the allocated region to render intoView.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
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.
insertUpdate
in class View
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenView.insertUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
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.
removeUpdate
in class View
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenView.removeUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
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.
changedUpdate
in class View
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has childrenView.changedUpdate(javax.swing.event.DocumentEvent, java.awt.Shape, javax.swing.text.ViewFactory)
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.
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.
nextTabStop
in interface TabExpander
x
- the current position >= 0tabOffset
- the position within the text stream that the tab occurred at >= 0.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 damageLineRange(int line0, int line1, Shape a, Component host)
Repaint the given line range.
host
- the component hosting the view (used to call repaint)a
- the region allocated for the view to render intoline0
- 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.protected Rectangle lineToRect(Shape a, int line)
Determine the rectangle that represents the given line.
a
- the region allocated for the view to render intoline
- the line number to find the region of. This must be a valid line number in the model.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.