Package net.sf.jasperreports.engine

Interface JRLineBox

All Superinterfaces:
JRPenContainer, JRStyleContainer
All Known Implementing Classes:
CachingLineBox, JRBaseLineBox
public interface JRLineBox extends JRPenContainer
This is useful for drawing borders around text elements and images. Boxes can have borders and paddings, which can have different width and color on each side of the element.

Text elements, images, and charts are considered "box elements" because one can surround them by a border that's customizable on each side. When defining the border around such a box element, the user can control the width, style, and color of each of the four sides of the element, as well as the padding (the amount of blank space to reserve between the border of the element and its actual content).These properties are grouped into the <box> tag.

Border Line Settings

Border line settings such as line width, line style and the line color can be accessed using the getPen() method and are grouped into the pen tag.

The attributes for specifying the border style for each side of the box are grouped into topPen, leftPen, bottomPen, and rightPen tag. These can be used for overriding the border style specified by the pen element mentioned previously. There is a getter method for each side pen element.

Box Padding

The amount of space to be left blank as margins within the bounds of a box element can be controlled using either the padding attribute (providing the same amount of padding on all four sides) or the individual attributes for each side: topPadding, leftPadding, bottomPadding, and rightPadding. Each padding attribute is accessed with a corresponding getter method.
Author:
Teodor Danciu (teodord@users.sourceforge.net)
See Also:

  • Method Details

    • getBoxContainer

      JRBoxContainer getBoxContainer()

    • clone

      JRLineBox clone(JRBoxContainer boxContainer)

    • populateStyle

      void populateStyle()

    • getPen

      JRBoxPen getPen()
      Gets the pen properties for the border.

    • copyPen

      void copyPen(JRBoxPen pen)

    • getTopPen

      JRBoxPen getTopPen()
      Gets the pen properties for the top border.

    • copyTopPen

      void copyTopPen(JRBoxPen topPen)

    • getLeftPen

      JRBoxPen getLeftPen()
      Gets the pen properties for the left border.

    • copyLeftPen

      void copyLeftPen(JRBoxPen leftPen)

    • getBottomPen

      JRBoxPen getBottomPen()
      Gets the pen properties for the bottom border.

    • copyBottomPen

      void copyBottomPen(JRBoxPen bottomPen)

    • getRightPen

      JRBoxPen getRightPen()
      Gets the pen properties for the right border.

    • copyRightPen

      void copyRightPen(JRBoxPen rightPen)

    • getPadding

      Integer getPadding()
      Gets the default padding in pixels (can be overwritten by individual settings).

    • getOwnPadding

      Integer getOwnPadding()

    • setPadding

      void setPadding(Integer padding)
      Sets the default padding in pixels (can be overwritten by individual settings).

    • getTopPadding

      Integer getTopPadding()

    • getOwnTopPadding

      Integer getOwnTopPadding()

    • setTopPadding

      void setTopPadding(Integer padding)

    • getLeftPadding

      Integer getLeftPadding()

    • getOwnLeftPadding

      Integer getOwnLeftPadding()

    • setLeftPadding

      void setLeftPadding(Integer padding)

    • getBottomPadding

      Integer getBottomPadding()

    • getOwnBottomPadding

      Integer getOwnBottomPadding()

    • setBottomPadding

      void setBottomPadding(Integer padding)

    • getRightPadding

      Integer getRightPadding()

    • getOwnRightPadding

      Integer getOwnRightPadding()

    • setRightPadding

      void setRightPadding(Integer padding)