Module java.desktop
Package javax.swing.text

Class PlainView

  • All Implemented Interfaces:
    SwingConstants, TabExpander
    Direct Known Subclasses:
    FieldView

    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.
    See Also:
    View

    • Field Detail

      • metrics

        protected FontMetrics metrics
        Font metrics for the current font.

    • Constructor Detail

      • PlainView

        public PlainView​(Element elem)
        Constructs a new PlainView wrapped on an element.
        Parameters:
        elem - the element

    • Method Detail

      • getTabSize

        protected int getTabSize​()
        Returns the tab size set for the document, defaulting to 8.
        Returns:
        the tab size

      • drawUnselectedText

        @Deprecated(since="9")
protected int drawUnselectedText​(Graphics g,
                                 int x,
                                 int y,
                                 int p0,
                                 int p1)
                          throws BadLocationException
        Deprecated. replaced by drawUnselectedText(Graphics2D, float, float, int, int)
        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

      • 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 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
        Since:
        9

      • drawSelectedText

        @Deprecated(since="9")
protected int drawSelectedText​(Graphics g,
                               int x,
                               int y,
                               int p0,
                               int p1)
                        throws BadLocationException
        Deprecated. replaced by drawSelectedText(Graphics2D, float, float, int, int)
        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

      • 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 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
        Since:
        9

      • getLineBuffer

        protected final Segment 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 class View
        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
        See Also:
        View.getPreferredSpan(int)

      • paint

        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.
        Specified by:
        paint in class View
        Parameters:
        g - the rendering surface to use
        a - the allocated region to render into
        See Also:
        View.paint(java.awt.Graphics, java.awt.Shape)

      • modelToView

        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.
        Specified by:
        modelToView in class View
        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:
        View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)

      • 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.
        Overrides:
        setSize in class View
        Parameters:
        width - the width >= 0
        height - the height >= 0

      • 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 interface TabExpander
        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

      • updateDamage

        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.
        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
        Since:
        1.4

      • damageLineRange

        protected void damageLineRange​(int line0,
                               int line1,
                               Shape a,
                               Component host)
        Repaint the given line range.
        Parameters:
        host - the component hosting the view (used to call repaint)
        a - the region allocated for the view to render into
        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.
        Since:
        1.4

      • lineToRect

        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.
        Returns:
        the rectangle that represents the given line
        Since:
        1.4