Class PDBorderEffectDictionary

  • All Implemented Interfaces:
    COSObjectable

    public class PDBorderEffectDictionary
    extends java.lang.Object
    implements COSObjectable
    This class represents a PDF /BE entry the border effect dictionary.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private COSDictionary dictionary  
      static java.lang.String STYLE_CLOUDY
      Constant for the name of a cloudy effect.
      static java.lang.String STYLE_SOLID
      Constant for the name for no effect.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      COSDictionary getCOSObject()
      returns the dictionary.
      float getIntensity()
      This will retrieve the intensity of the applied effect.
      java.lang.String getStyle()
      This will retrieve the border effect, see the STYLE_* constants for valid values.
      void setIntensity​(float i)
      This will set the intensity of the applied effect.
      void setStyle​(java.lang.String s)
      This will set the border effect, see the STYLE_* constants for valid values.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • STYLE_SOLID

        public static final java.lang.String STYLE_SOLID
        Constant for the name for no effect.
        See Also:
        Constant Field Values
      • STYLE_CLOUDY

        public static final java.lang.String STYLE_CLOUDY
        Constant for the name of a cloudy effect.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PDBorderEffectDictionary

        public PDBorderEffectDictionary()
        Constructor.
      • PDBorderEffectDictionary

        public PDBorderEffectDictionary​(COSDictionary dict)
        Constructor.
        Parameters:
        dict - a border style dictionary.
    • Method Detail

      • 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​(java.lang.String s)
        This will set the border effect, see the STYLE_* constants for valid values.
        Parameters:
        s - the border effect to use
      • getStyle

        public java.lang.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.