Class RtfBorderGroup

java.lang.Object
com.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.table.RtfBorderGroup
All Implemented Interfaces:
RtfBasicElement
public class RtfBorderGroup extends RtfElement
The RtfBorderGroup represents a collection of RtfBorders to use in a RtfCell or RtfTable.
Version:
$Id: RtfBorderGroup.java 3427 2008-05-24 18:32:31Z xlv $

  • Field Details

    • borderType

      private int borderType
      The type of borders this RtfBorderGroup contains. RtfBorder.ROW_BORDER or RtfBorder.CELL_BORDER

    • borders

      private final Map<Integer, RtfBorder> borders
      The borders in this RtfBorderGroup

  • Constructor Details

    • RtfBorderGroup

      public RtfBorderGroup()
      Constructs an empty RtfBorderGroup.

    • RtfBorderGroup

      public RtfBorderGroup(int bordersToAdd, int borderStyle, float borderWidth, Color borderColor)
      Constructs a RtfBorderGroup with on border style for multiple borders.
      Parameters:
      bordersToAdd - The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)
      borderStyle - The style of border to add (from RtfBorder)
      borderWidth - The border width to use
      borderColor - The border color to use

    • RtfBorderGroup

      protected RtfBorderGroup(RtfDocument doc, int borderType, RtfBorderGroup borderGroup)
      Constructs a RtfBorderGroup based on another RtfBorderGroup.
      Parameters:
      doc - The RtfDocument this RtfBorderGroup belongs to
      borderType - The type of borders this RtfBorderGroup contains
      borderGroup - The RtfBorderGroup to use as a base

    • RtfBorderGroup

      protected RtfBorderGroup(RtfDocument doc, int borderType, int bordersToUse, float borderWidth, Color borderColor)
      Constructs a RtfBorderGroup with certain borders
      Parameters:
      doc - The RtfDocument this RtfBorderGroup belongs to
      borderType - The type of borders this RtfBorderGroup contains
      bordersToUse - The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)
      borderWidth - The border width to use
      borderColor - The border color to use

  • Method Details

    • setBorder

      private void setBorder(int borderPosition, int borderStyle, float borderWidth, Color borderColor)
      Sets a border in the Hashtable of borders
      Parameters:
      borderPosition - The position of this RtfBorder
      borderStyle - The type of borders this RtfBorderGroup contains
      borderWidth - The border width to use
      borderColor - The border color to use

    • addBorder

      public void addBorder(int bordersToAdd, int borderStyle, float borderWidth, Color borderColor)
      Adds borders to the RtfBorderGroup
      Parameters:
      bordersToAdd - The borders to add (Rectangle.LEFT, Rectangle.RIGHT, Rectangle.TOP, Rectangle.BOTTOM, Rectangle.BOX)
      borderStyle - The style of border to add (from RtfBorder)
      borderWidth - The border width to use
      borderColor - The border color to use

    • removeBorder

      public void removeBorder(int bordersToRemove)
      Removes borders from the list of borders
      Parameters:
      bordersToRemove - The borders to remove (from Rectangle)

    • writeContent

      public void writeContent(OutputStream result) throws IOException
      Writes the borders of this RtfBorderGroup
      Specified by:
      writeContent in interface RtfBasicElement
      Specified by:
      writeContent in class RtfElement
      Parameters:
      result - The OutputStream to write the content to
      Throws:
      IOException

    • getBorders

      protected Map<Integer, RtfBorder> getBorders()
      Gets the RtfBorders of this RtfBorderGroup
      Returns:
      The RtfBorders of this RtfBorderGroup