Class PDAppearanceDictionary

  • All Implemented Interfaces:
    COSObjectable

    public class PDAppearanceDictionary
    extends java.lang.Object
    implements COSObjectable
    This class represents a PDF /AP entry the appearance dictionary.
    Version:
    $Revision: 1.4 $
    Author:
    Ben Litchfield
    • Constructor Detail

      • PDAppearanceDictionary

        public PDAppearanceDictionary()
        Constructor.
      • PDAppearanceDictionary

        public PDAppearanceDictionary​(COSDictionary dict)
        Constructor.
        Parameters:
        dict - The annotations dictionary.
    • Method Detail

      • getDictionary

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

        public java.util.Map<java.lang.String,​PDAppearanceStream> getNormalAppearance()
        This will return a list of appearances. In the case where there is only one appearance the map will contain one entry whose key is the string "default".
        Returns:
        A list of key(java.lang.String) value(PDAppearanceStream) pairs
      • setNormalAppearance

        public void setNormalAppearance​(java.util.Map<java.lang.String,​PDAppearanceStream> appearanceMap)
        This will set a list of appearances. If you would like to set the single appearance then you should use the key "default", and when the PDF is written back to the filesystem then there will only be one stream.
        Parameters:
        appearanceMap - The updated map with the appearance.
      • setNormalAppearance

        public void setNormalAppearance​(PDAppearanceStream ap)
        This will set the normal appearance when there is only one appearance to be shown.
        Parameters:
        ap - The appearance stream to show.
      • getRolloverAppearance

        public java.util.Map<java.lang.String,​PDAppearanceStream> getRolloverAppearance()
        This will return a list of appearances. In the case where there is only one appearance the map will contain one entry whose key is the string "default". If there is no rollover appearance then the normal appearance will be returned. Which means that this method will never return null.
        Returns:
        A list of key(java.lang.String) value(PDAppearanceStream) pairs
      • setRolloverAppearance

        public void setRolloverAppearance​(java.util.Map<java.lang.String,​PDAppearanceStream> appearanceMap)
        This will set a list of appearances. If you would like to set the single appearance then you should use the key "default", and when the PDF is written back to the filesystem then there will only be one stream.
        Parameters:
        appearanceMap - The updated map with the appearance.
      • setRolloverAppearance

        public void setRolloverAppearance​(PDAppearanceStream ap)
        This will set the rollover appearance when there is rollover appearance to be shown.
        Parameters:
        ap - The appearance stream to show.
      • getDownAppearance

        public java.util.Map<java.lang.String,​PDAppearanceStream> getDownAppearance()
        This will return a list of appearances. In the case where there is only one appearance the map will contain one entry whose key is the string "default". If there is no rollover appearance then the normal appearance will be returned. Which means that this method will never return null.
        Returns:
        A list of key(java.lang.String) value(PDAppearanceStream) pairs
      • setDownAppearance

        public void setDownAppearance​(java.util.Map<java.lang.String,​PDAppearanceStream> appearanceMap)
        This will set a list of appearances. If you would like to set the single appearance then you should use the key "default", and when the PDF is written back to the filesystem then there will only be one stream.
        Parameters:
        appearanceMap - The updated map with the appearance.
      • setDownAppearance

        public void setDownAppearance​(PDAppearanceStream ap)
        This will set the down appearance when there is down appearance to be shown.
        Parameters:
        ap - The appearance stream to show.