Uses of Class org.apache.fop.traits.BorderProps (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Class
org.apache.fop.traits.BorderProps

- Packages that use BorderProps
  Package | Description
  --- | ---
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.afp | An AFP Renderer implementation and supporting classes.
  org.apache.fop.render.intermediate |
  org.apache.fop.render.java2d | Java2D Renderer which paints rendered pages on Graphics2D instances.
  org.apache.fop.render.pcl | PCL Renderer (Supports PCL5 and HP GL/2)
  org.apache.fop.render.pdf | PDF Renderer
  org.apache.fop.render.ps | PostScript Renderer
  org.apache.fop.traits | Trait classes and other supporting data structures.

- - ### Uses of BorderProps in org.apache.fop.render

    Methods in org.apache.fop.render with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | AbstractPathOrientedRenderer.`clipBackground(float startx, float starty, float width, float height, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` TODO represent border related parameters in a class Clip the background to the inner border.
    `protected void` | AbstractPathOrientedRenderer.`drawBackground(float startx, float starty, float width, float height, Trait.Background back, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight)` Draw the background.
    `protected void` | AbstractPathOrientedRenderer.`drawBackground(float startx, float starty, float width, float height, Trait.Background back, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd, int level)` Draw the background.
    `protected void` | AbstractPathOrientedRenderer.`drawBorders(float startx, float starty, float width, float height, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd, int level, Color innerBackgroundColor)` Draw the borders.
    `protected void` | AbstractPathOrientedRenderer.`drawBorders(Rectangle2D.Float borderRect, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight, Color innerBackgroundColor)` Draws borders.

  - ### Uses of BorderProps in org.apache.fop.render.afp

    Methods in org.apache.fop.render.afp with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `void` | AFPPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | AFPPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)`
    `void` | AFPPainter.`fillBackground(Rectangle rect, Paint fill, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)`
    `boolean` | AFPPainter.`isBackgroundRequired(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` TODO Painter-specific rounded borders logic required background drawing to be made optional.

  - ### Uses of BorderProps in org.apache.fop.render.intermediate

    Methods in org.apache.fop.render.intermediate with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `protected static double` | BorderPainter.`calculateCornerCorrectionFactor(int width, int height, BorderProps before, BorderProps after, BorderProps start, BorderProps end)` Calculate the correction factor to handle over-sized elliptic corner radii.
    `protected void` | IFRenderer.`clipBackground(float startx, float starty, float width, float height, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` TODO represent border related parameters in a class Clip the background to the inner border.
    `void` | IFPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | BorderPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Clip the background to the inner border
    `void` | IFSerializer.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `protected void` | IFRenderer.`drawBackground(float startx, float starty, float width, float height, Trait.Background back, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Draw the background.
    `void` | IFPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)` Draws a border rectangle.
    `void` | AbstractIFPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)` Draws a border rectangle.
    `void` | IFSerializer.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)` Draws a border rectangle.
    `protected void` | IFRenderer.`drawBorders(float startx, float starty, float width, float height, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd, int level, Color innerBackgroundColor)` Draw the borders.
    `void` | BorderPainter.`drawBorders(Rectangle borderRect, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight, Color innerBackgroundColor)` Draws borders.
    `protected void` | BorderPainter.`drawRectangularBorders(Rectangle borderRect, BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight)` TODO merge with drawRoundedBorders()?
    `protected void` | BorderPainter.`drawRoundedBorders(Rectangle borderRect, BorderProps beforeBorderProps, BorderProps afterBorderProps, BorderProps startBorderProps, BorderProps endBorderProps)` TODO merge with drawRectangularBorders?
    `protected boolean` | AbstractIFPainter.`hasOnlySolidBorders(BorderProps top, BorderProps bottom, BorderProps left, BorderProps right)` Indicates whether the given border segments (if present) have only solid borders, i.e.
    `boolean` | IFPainter.`isBackgroundRequired(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` TODO Painter-specific rounded borders logic required background drawing to be made optional.
    `boolean` | AbstractIFPainter.`isBackgroundRequired(BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` TODO Painter-specific rounded borders logic required background drawing to be made optional.
    `boolean` | IFSerializer.`isBackgroundRequired(BorderProps bpsTop, BorderProps bpsBottom, BorderProps bpsLeft, BorderProps bpsRight)` TODO Painter-specific rounded borders logic required background drawing to be made optional.

  - ### Uses of BorderProps in org.apache.fop.render.java2d

    Methods in org.apache.fop.render.java2d with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `void` | Java2DPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | Java2DPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right)`

  - ### Uses of BorderProps in org.apache.fop.render.pcl

    Methods in org.apache.fop.render.pcl with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `void` | PCLPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | PCLPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right)`

  - ### Uses of BorderProps in org.apache.fop.render.pdf

    Methods in org.apache.fop.render.pdf with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | PDFPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)` Draws a border rectangle.

  - ### Uses of BorderProps in org.apache.fop.render.ps

    Methods in org.apache.fop.render.ps with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `void` | PSPainter.`clipBackground(Rectangle rect, BorderProps bpsBefore, BorderProps bpsAfter, BorderProps bpsStart, BorderProps bpsEnd)` Restricts the current clipping region to the inner border.
    `void` | PSPainter.`drawBorderRect(Rectangle rect, BorderProps top, BorderProps bottom, BorderProps left, BorderProps right, Color innerBackgroundColor)` Draws a border rectangle.

  - ### Uses of BorderProps in org.apache.fop.traits

    Methods in org.apache.fop.traits that return BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `static BorderProps` | BorderProps.`makeRectangular(int style, int width, Color color, BorderProps.Mode mode)` Factory method for a new BorderProps instance with rectangular corners.
    `static BorderProps` | BorderProps.`valueOf(FOUserAgent foUserAgent, String s)` Returns a BorderProps represtation of a string of the format as written by BorderProps.toString().

    Methods in org.apache.fop.traits with parameters of type BorderProps
    Modifier and Type | Method and Description
    --- | ---
    `static int` | BorderProps.`getClippedWidth(BorderProps bp)`

Copyright © 2025 Apache Software Foundation. All rights reserved.