java.lang.Object
javax.swing.text.View
javax.swing.text.PlainView
- All Implemented Interfaces:
SwingConstants
,TabExpander
- Direct Known Subclasses:
FieldView
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:
-
Field Summary
Fields declared in class javax.swing.text.View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS
Fields declared in interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.protected void
damageLineRange
(int line0, int line1, Shape a, Component host) Repaint the given line range.protected void
drawLine
(int lineIndex, Graphics2D g, float x, float y) Renders a line of text, suppressing whitespace at the end and expanding any tabs.protected void
Deprecated.protected float
drawSelectedText
(Graphics2D g, float x, float y, int p0, int p1) Renders the given range in the model as selected text.protected int
drawSelectedText
(Graphics g, int x, int y, int p0, int p1) Deprecated.protected float
drawUnselectedText
(Graphics2D g, float x, float y, int p0, int p1) Renders the given range in the model as normal unselected text.protected int
drawUnselectedText
(Graphics g, int x, int y, int p0, int p1) Deprecated.protected final Segment
Gives access to a buffer that can be used to fetch text from the associated document.float
getPreferredSpan
(int axis) Determines the preferred span for this view along an axis.protected int
Returns the tab size set for the document, defaulting to 8.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.protected Rectangle
lineToRect
(Shape a, int line) Determine the rectangle that represents the given line.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
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.protected void
updateDamage
(DocumentEvent changes, Shape a, ViewFactory f) Repaint the region of change covered by the given document event.protected void
Checks to see if the font metrics and longest line are up-to-date.int
viewToModel
(float x, float y, Shape a, Position.Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.Methods declared in class javax.swing.text.View
append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getAlignment, getAttributes, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getToolTipText, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, replace, setParent, updateChildren, updateLayout, viewToModel
-
Field Details
-
metrics
Font metrics for the current font.
-
-
Constructor Details
-
PlainView
Constructs a new PlainView wrapped on an element.- Parameters:
elem
- the element
-
-
Method Details
-
getTabSize
protected int getTabSize()Returns the tab size set for the document, defaulting to 8.- Returns:
- the tab size
-
drawLine
Deprecated.replaced bydrawLine(int, Graphics2D, float, float)
Renders a line of text, suppressing whitespace at the end and expanding any tabs. This is implemented to make calls to the methodsdrawUnselectedText
anddrawSelectedText
so that the way selected and unselected text are rendered can be customized.- Parameters:
lineIndex
- the line to draw >= 0g
- theGraphics
contextx
- the starting X position >= 0y
- the starting Y position >= 0- See Also:
-
drawLine
Renders a line of text, suppressing whitespace at the end and expanding any tabs. This is implemented to make calls to the methodsdrawUnselectedText
anddrawSelectedText
so that the way selected and unselected text are rendered can be customized.- Parameters:
lineIndex
- the line to draw>= 0
g
- theGraphics
contextx
- the starting X position>= 0
y
- the starting Y position>= 0
- Since:
- 9
- See Also:
-
drawUnselectedText
@Deprecated(since="9") protected int drawUnselectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Deprecated.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 contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- 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
-
drawUnselectedText
protected float drawUnselectedText(Graphics2D g, float x, float 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.- Parameters:
g
- the graphics contextx
- 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- Since:
- 9
-
drawSelectedText
@Deprecated(since="9") protected int drawSelectedText(Graphics g, int x, int y, int p0, int p1) throws BadLocationException Deprecated.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 contextx
- the starting X coordinate >= 0y
- the starting Y coordinate >= 0p0
- the beginning position in the model >= 0p1
- the ending position in the model >= 0- Returns:
- the location of the end of the range
- Throws:
BadLocationException
- if the range is invalid
-
drawSelectedText
protected float drawSelectedText(Graphics2D g, float x, float 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.- Parameters:
g
- the graphics contextx
- 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- Since:
- 9
-
getLineBuffer
Gives access to a buffer that can be used to fetch text from the associated document.- Returns:
- the buffer
-
updateMetrics
protected void updateMetrics()Checks to see if the font metrics and longest line are up-to-date.- Since:
- 1.4
-
getPreferredSpan
public float getPreferredSpan(int axis) Determines the preferred span for this view along an axis.- Specified by:
getPreferredSpan
in classView
- 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
-
paint
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. -
modelToView
Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.- Specified by:
modelToView
in classView
- Parameters:
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
-
- 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:
-
viewToModel
Provides a mapping from the view coordinate space to the logical coordinate space of the model.- Specified by:
viewToModel
in classView
- Parameters:
x
- the X coordinate >= 0y
- the Y coordinate >= 0a
- the allocated region to render intobias
- the returned bias- Returns:
- the location within the model that best represents the given point in the view >= 0
- See Also:
-
insertUpdate
Gives notification that something was inserted into the document in a location that this view is responsible for.- Overrides:
insertUpdate
in classView
- Parameters:
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
-
removeUpdate
Gives notification that something was removed from the document in a location that this view is responsible for.- Overrides:
removeUpdate
in classView
- Parameters:
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
-
changedUpdate
Gives notification from the document that attributes were changed in a location that this view is responsible for.- Overrides:
changedUpdate
in classView
- Parameters:
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- See Also:
-
setSize
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. -
nextTabStop
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.- Specified by:
nextTabStop
in interfaceTabExpander
- Parameters:
x
- the current position >= 0tabOffset
- the position within the text stream that the tab occurred at >= 0.- Returns:
- the tab stop, measured in points >= 0
-
updateDamage
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.- Parameters:
changes
- the change information from the associated documenta
- the current allocation of the viewf
- the factory to use to rebuild if the view has children- Since:
- 1.4
-
damageLineRange
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 intohost
- the component hosting the view (used to call repaint)- Since:
- 1.4
-
lineToRect
Determine the rectangle that represents the given line.- Parameters:
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.- Returns:
- the rectangle that represents the given line
- Since:
- 1.4
-
drawLine(int, Graphics2D, float, float)