Class DottedBorder


  • public class DottedBorder
    extends Border
    Draws a dotted border around the element it has been set to. Do note that this border draw square dots, if you want to draw round dots, see RoundDotsBorder.
    • Field Detail

      • GAP_MODIFIER

        private static final float GAP_MODIFIER
        The modifier to be applied on the width to have the initial gap size
        See Also:
        Constant Field Values
    • Constructor Detail

      • DottedBorder

        public DottedBorder​(float width)
        Creates a DottedBorder instance with the specified width. The color is set to the default: black.
        Parameters:
        width - width of the border
      • DottedBorder

        public DottedBorder​(Color color,
                            float width)
        Creates a DottedBorder instance with the specified width and color.
        Parameters:
        color - color of the border
        width - width of the border
      • DottedBorder

        public DottedBorder​(Color color,
                            float width,
                            float opacity)
        Creates a DottedBorder with the specified width, color and opacity.
        Parameters:
        color - color of the border
        width - width of the border
        opacity - width of the border
    • Method Detail

      • getType

        public int getType()
        Returns the type of the border
        Specified by:
        getType in class Border
        Returns:
        the type of border.
      • draw

        public void draw​(PdfCanvas canvas,
                         float x1,
                         float y1,
                         float x2,
                         float y2,
                         Border.Side defaultSide,
                         float borderWidthBefore,
                         float borderWidthAfter)
        All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. Borders are drawn in this order: top, right, bottom, left.

        Given points specify the line which lies on the border of the content area, therefore the border itself should be drawn to the left from the drawing direction.

        borderWidthBefore and borderWidthAfter parameters are used to define the widths of the borders that are before and after the current border, e.g. for the bottom border, borderWidthBefore specifies width of the right border and borderWidthAfter - width of the left border. Those width are used to handle areas of border joins.

        Specified by:
        draw in class Border
        Parameters:
        canvas - PdfCanvas to be written to
        x1 - x coordinate of the beginning point of the element side, that should be bordered
        y1 - y coordinate of the beginning point of the element side, that should be bordered
        x2 - x coordinate of the ending point of the element side, that should be bordered
        y2 - y coordinate of the ending point of the element side, that should be bordered
        defaultSide - the Border.Side, that we will fallback to, if it cannot be determined by border coordinates
        borderWidthBefore - defines width of the border that is before the current one
        borderWidthAfter - defines width of the border that is after the current one
      • draw

        public void draw​(PdfCanvas canvas,
                         float x1,
                         float y1,
                         float x2,
                         float y2,
                         float horizontalRadius1,
                         float verticalRadius1,
                         float horizontalRadius2,
                         float verticalRadius2,
                         Border.Side defaultSide,
                         float borderWidthBefore,
                         float borderWidthAfter)
        All borders are supposed to be drawn in such way, that inner content of the element is on the right from the drawing direction. Borders are drawn in this order: top, right, bottom, left.

        Given points specify the line which lies on the border of the content area, therefore the border itself should be drawn to the left from the drawing direction.

        borderWidthBefore and borderWidthAfter parameters are used to define the widths of the borders that are before and after the current border, e.g. for the bottom border, borderWidthBefore specifies width of the right border and borderWidthAfter - width of the left border. Those width are used to handle areas of border joins.

        horizontalRadius1, verticalRadius1, horizontalRadius2 and verticalRadius2 are used to draw rounded borders.

        Overrides:
        draw in class Border
        Parameters:
        canvas - PdfCanvas to be written to
        x1 - x coordinate of the beginning point of the element side, that should be bordered
        y1 - y coordinate of the beginning point of the element side, that should be bordered
        x2 - x coordinate of the ending point of the element side, that should be bordered
        y2 - y coordinate of the ending point of the element side, that should be bordered
        horizontalRadius1 - defines the horizontal radius of the border's first corner
        verticalRadius1 - defines the vertical radius of the border's first corner
        horizontalRadius2 - defines the horizontal radius of the border's second corner
        verticalRadius2 - defines the vertical radius of the border's second corner
        defaultSide - the Border.Side, that we will fallback to, if it cannot be determined by border coordinates
        borderWidthBefore - defines width of the border that is before the current one
        borderWidthAfter - defines width of the border that is after the current one
      • drawCellBorder

        public void drawCellBorder​(PdfCanvas canvas,
                                   float x1,
                                   float y1,
                                   float x2,
                                   float y2,
                                   Border.Side defaultSide)
        Draws the border of a cell.
        Specified by:
        drawCellBorder in class Border
        Parameters:
        canvas - PdfCanvas to be written to
        x1 - x coordinate of the beginning point of the element side, that should be bordered
        y1 - y coordinate of the beginning point of the element side, that should be bordered
        x2 - x coordinate of the ending point of the element side, that should be bordered
        y2 - y coordinate of the ending point of the element side, that should be bordered
        defaultSide - the Border.Side, that we will fallback to, if it cannot be determined by border coordinates