Class PDBorderEffectDictionary

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

public class PDBorderEffectDictionary extends Object implements COSObjectable
This class represents a PDF /BE entry the border effect dictionary.
Author:
Paul King
  • Field Details

  • Constructor Details

    • PDBorderEffectDictionary

      public PDBorderEffectDictionary()
      Constructor.
    • PDBorderEffectDictionary

      public PDBorderEffectDictionary(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
    • setIntensity

      public void setIntensity(float i)
      This will set the intensity of the applied effect.
      Parameters:
      i - the intensity of the effect values 0 to 2
    • getIntensity

      public float getIntensity()
      This will retrieve the intensity of the applied effect.
      Returns:
      the intensity value 0 to 2
    • setStyle

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

      public String getStyle()
      This will retrieve the border effect, see the STYLE_* constants for valid values.
      Returns:
      the effect of the border or STYLE_SOLID if none is found.