Class PDAppearanceCharacteristicsDictionary

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

public class PDAppearanceCharacteristicsDictionary extends Object implements COSObjectable
This class represents an appearance characteristics dictionary.
Version:
$Revision: 1.0 $
  • Constructor Details

    • PDAppearanceCharacteristicsDictionary

      public PDAppearanceCharacteristicsDictionary(COSDictionary dict)
      Constructor.
      Parameters:
      dict - dictionary
  • Method Details

    • getDictionary

      public COSDictionary getDictionary()
      returns the dictionary.
      Returns:
      the dictionary
    • getCOSObject

      public COSBase 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.
    • getRotation

      public int getRotation()
      This will retrieve the rotation of the annotation widget. It must be a multiple of 90. Default is 0
      Returns:
      the rotation
    • setRotation

      public void setRotation(int rotation)
      This will set the rotation.
      Parameters:
      rotation - the rotation as a multiple of 90
    • getBorderColour

      public PDGamma getBorderColour()
      This will retrieve the border color.
      Returns:
      the border color.
    • setBorderColour

      public void setBorderColour(PDGamma c)
      This will set the border color.
      Parameters:
      c - the border color
    • getBackground

      public PDGamma getBackground()
      This will retrieve the background color.
      Returns:
      the background color.
    • setBackground

      public void setBackground(PDGamma c)
      This will set the background color.
      Parameters:
      c - the background color
    • getNormalCaption

      public String getNormalCaption()
      This will retrieve the normal caption.
      Returns:
      the normal caption.
    • setNormalCaption

      public void setNormalCaption(String caption)
      This will set the normal caption.
      Parameters:
      caption - the normal caption
    • getRolloverCaption

      public String getRolloverCaption()
      This will retrieve the rollover caption.
      Returns:
      the rollover caption.
    • setRolloverCaption

      public void setRolloverCaption(String caption)
      This will set the rollover caption.
      Parameters:
      caption - the rollover caption
    • getAlternateCaption

      public String getAlternateCaption()
      This will retrieve the alternate caption.
      Returns:
      the alternate caption.
    • setAlternateCaption

      public void setAlternateCaption(String caption)
      This will set the alternate caption.
      Parameters:
      caption - the alternate caption
    • getNormalIcon

      public PDXObjectForm getNormalIcon()
      This will retrieve the normal icon.
      Returns:
      the normal icon.
    • getRolloverIcon

      public PDXObjectForm getRolloverIcon()
      This will retrieve the rollover icon.
      Returns:
      the rollover icon
    • getAlternateIcon

      public PDXObjectForm getAlternateIcon()
      This will retrieve the alternate icon.
      Returns:
      the alternate icon.