Class PDBorderStyleDictionary

java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
All Implemented Interfaces:
COSObjectable

public class PDBorderStyleDictionary extends Object implements COSObjectable
This class represents a PDF /BS entry the border style dictionary.
  • Field Details

  • Constructor Details

    • PDBorderStyleDictionary

      public PDBorderStyleDictionary()
      Constructor.
    • PDBorderStyleDictionary

      public PDBorderStyleDictionary(COSDictionary dict)
      Constructor.
      Parameters:
      dict - a border style dictionary.
  • Method Details

    • getCOSObject

      public COSDictionary getCOSObject()
      returns the dictionary.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      the dictionary
    • setWidth

      public void setWidth(float w)
      This will set the border width in points, 0 = no border. There is a bug in Adobe Reader DC, float values are ignored for text field widgets. As a workaround, floats that are integers (e.g. 2.0) are written as integer in the PDF.

      In Adobe Acrobat DC, the values are shown as "0 = Invisible, 1 = Thin, 2 = Medium, 3 = Thick" for widget and link annotations.

      Parameters:
      w - float the width in points
    • getWidth

      public float getWidth()
      This will retrieve the border width in points, 0 = no border.
      Returns:
      The width of the border in points.
    • setStyle

      public void setStyle(String s)
      This will set the border style, see the STYLE_* constants for valid values.
      Parameters:
      s - the border style to use
    • getStyle

      public String getStyle()
      This will retrieve the border style, see the STYLE_* constants for valid values.
      Returns:
      the style of the border
    • setDashStyle

      public void setDashStyle(COSArray dashArray)
      This will set the dash style used for drawing the border.
      Parameters:
      dashArray - the dash style to use
    • getDashStyle

      public PDLineDashPattern getDashStyle()
      This will retrieve the dash style used for drawing the border.
      Returns:
      the dash style of the border