java.lang.Object
org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
All Implemented Interfaces:
COSObjectable

public class PDBoxStyle extends Object implements COSObjectable
The Box Style specifies visual characteristics for displaying box areas.
  • Field Details

  • Constructor Details

    • PDBoxStyle

      public PDBoxStyle()
      Default Constructor.
    • PDBoxStyle

      public PDBoxStyle(COSDictionary dic)
      Constructor for an existing BoxStyle element.
      Parameters:
      dic - The existing dictionary.
  • Method Details

    • getCOSObject

      public COSDictionary getCOSObject()
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos object that matches this Java object.
    • getGuidelineColor

      public PDColor getGuidelineColor()
      Get the RGB color to be used for the guidelines. This is guaranteed to not return null. The default color is [0,0,0].
      Returns:
      The guideline color.
    • setGuideLineColor

      public void setGuideLineColor(PDColor color)
      Set the color space instance for this box style. This must be a PDDeviceRGB!
      Parameters:
      color - The new colorspace value.
    • getGuidelineWidth

      public float getGuidelineWidth()
      Get the width of the of the guideline in default user space units. The default is 1.
      Returns:
      The width of the guideline.
    • setGuidelineWidth

      public void setGuidelineWidth(float width)
      Set the guideline width.
      Parameters:
      width - The width in default user space units.
    • getGuidelineStyle

      public String getGuidelineStyle()
      Get the style for the guideline. The default is "S" for solid.
      Returns:
      The guideline style.
      See Also:
    • setGuidelineStyle

      public void setGuidelineStyle(String style)
      Set the style for the box.
      Parameters:
      style - The style for the box line.
      See Also:
    • getLineDashPattern

      public PDLineDashPattern getLineDashPattern()
      Get the line dash pattern for this box style. This is guaranteed to not return null. The default is [3],0.
      Returns:
      The line dash pattern.
    • setLineDashPattern

      public void setLineDashPattern(COSArray dashArray)
      Set the line dash pattern associated with this box style.
      Parameters:
      dashArray - The patter for this box style.