Package org.fife.ui.rsyntaxtextarea

Class WrappedSyntaxView

    • Constructor Detail

      • WrappedSyntaxView

        public WrappedSyntaxView​(Element elem)
        Creates a new WrappedSyntaxView. Lines will be wrapped on character boundaries.
        Parameters:
        elem - the element underlying the view

    • Method Detail

      • calculateBreakPosition

        protected int calculateBreakPosition​(int p0,
                                     Token tokenList,
                                     float x0)
        This is called by the nested wrapped line views to determine the break location. This can be reimplemented to alter the breaking behavior. It will either break at word or character boundaries depending upon the break argument given at construction.

      • drawView

        protected void drawView​(org.fife.ui.rsyntaxtextarea.TokenPainter painter,
                        Graphics2D g,
                        Rectangle r,
                        View view,
                        int fontHeight,
                        int y,
                        int line)
        Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary.
        Parameters:
        painter - The painter to use to render tokens.
        g - The graphics context in which to paint.
        r - The rectangle in which to paint.
        view - The View to paint.
        fontHeight - The height of the font being used.
        y - The y-coordinate at which to begin painting.

      • drawViewWithSelection

        protected void drawViewWithSelection​(org.fife.ui.rsyntaxtextarea.TokenPainter painter,
                                     Graphics2D g,
                                     Rectangle r,
                                     View view,
                                     int fontHeight,
                                     int y,
                                     int selStart,
                                     int selEnd)
        Draws a single view (i.e., a line of text for a wrapped view), wrapping the text onto multiple lines if necessary. Any selected text is rendered with the editor's "selected text" color.
        Parameters:
        painter - The painter to use to render tokens.
        g - The graphics context in which to paint.
        r - The rectangle in which to paint.
        view - The View to paint.
        fontHeight - The height of the font being used.
        y - The y-coordinate at which to begin painting.
        selStart - The start of the selection.
        selEnd - The end of the selection.

      • getChildAllocation

        public Shape getChildAllocation​(int index,
                                Shape a)
        Fetches the allocation for the given child view.

        Overridden to account for code folding.

        Overrides:
        getChildAllocation in class BoxView
        Parameters:
        index - The index of the child, >= 0 &&< getViewCount().
        a - The allocation to this view
        Returns:
        The allocation to the child; or null if a is null; or null if the layout is invalid

      • getChildAllocationImpl

        public Shape getChildAllocationImpl​(int line,
                                    Shape a)
        Fetches the allocation for the given child view to render into.

        Overridden to account for lines hidden by collapsed folded regions.

        Parameters:
        line - The index of the child, >= 0 &&< getViewCount()
        a - The allocation to this view
        Returns:
        The allocation to the child

      • getMaximumSpan

        public float getMaximumSpan​(int axis)
        Determines the maximum span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).
        Overrides:
        getMaximumSpan in class BoxView
        Parameters:
        axis - may be either View.X_AXIS or View.Y_AXIS
        Returns:
        the span the view would like to be rendered into. 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.
        See Also:
        View.getMaximumSpan(int)

      • getMinimumSpan

        public float getMinimumSpan​(int axis)
        Determines the minimum span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).
        Overrides:
        getMinimumSpan in class BoxView
        Parameters:
        axis - may be either View.X_AXIS or View.Y_AXIS
        Returns:
        the span the view would like to be rendered into. 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.
        See Also:
        View.getMinimumSpan(int)

      • getPreferredSpan

        public float getPreferredSpan​(int axis)
        Determines the preferred span for this view along an axis. This is implemented to provide the superclass behavior after first making sure that the current font metrics are cached (for the nested lines which use the metrics to determine the height of the potentially wrapped lines).
        Overrides:
        getPreferredSpan in class BoxView
        Parameters:
        axis - may be either View.X_AXIS or View.Y_AXIS
        Returns:
        the span the view would like to be rendered into. 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.
        See Also:
        View.getPreferredSpan(int)

      • getTabSize

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

      • getViewAtPoint

        protected View getViewAtPoint​(int x,
                              int y,
                              Rectangle alloc)
        Overridden to allow for folded regions.
        Overrides:
        getViewAtPoint in class BoxView

      • loadChildren

        protected void loadChildren​(ViewFactory f)
        Loads all of the children to initialize the view. This is called by the setParent method. Subclasses can re-implement this to initialize their child views in a different manner. The default implementation creates a child view for each child element.
        Overrides:
        loadChildren in class CompositeView
        Parameters:
        f - the view factory

      • modelToView

        public Shape modelToView​(int p0,
                         Position.Bias b0,
                         int p1,
                         Position.Bias b1,
                         Shape a)
                  throws BadLocationException
        Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space. The specified region is created as a union of the first and last character positions.

        This is implemented to subtract the width of the second character, as this view's modelToView actually returns the width of the character instead of "1" or "0" like the View implementations in javax.swing.text. Thus, if we don't override this method, the View implementation will return one character's width too much for its consumers (implementations of javax.swing.text.Highlighter).

        Overrides:
        modelToView in class CompositeView
        Parameters:
        p0 - the position of the first character (>=0)
        b0 - The bias of the first character position, toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; b0 will have one of these values:
        • Position.Bias.Forward
        • Position.Bias.Backward
        p1 - the position of the last character (>=0)
        b1 - the bias for the second character position, defined one of the legal values shown above
        a - the area of the view, which encompasses the requested region
        Returns:
        the bounding box which is a union of the region specified by the first and last character positions
        Throws:
        BadLocationException - if the given position does not represent a valid location in the associated document
        IllegalArgumentException - if b0 or b1 are not one of the legal Position.Bias values listed above
        See Also:
        View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])

      • 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

      • paint

        public void paint​(Graphics g,
                  Shape a)
        Paints the word-wrapped text.
        Overrides:
        paint in class BoxView
        Parameters:
        g - The graphics context in which to paint.
        a - The shape (usually a rectangle) in which to paint.

      • 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 BoxView
        Parameters:
        width - the width >= 0
        height - the height >= 0