Class PDOptionalContentProperties

  • All Implemented Interfaces:
    COSObjectable

    public class PDOptionalContentProperties
    extends java.lang.Object
    implements COSObjectable
    This class represents the optional content properties dictionary.
    Since:
    PDF 1.5
    • Constructor Detail

      • PDOptionalContentProperties

        public PDOptionalContentProperties()
        Creates a new optional content properties dictionary.
      • PDOptionalContentProperties

        public PDOptionalContentProperties​(COSDictionary props)
        Creates a new instance based on a given COSDictionary.
        Parameters:
        props - the dictionary
    • Method Detail

      • 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.
      • getGroup

        public PDOptionalContentGroup getGroup​(java.lang.String name)
        Returns the first optional content group of the given name.
        Parameters:
        name - the group name
        Returns:
        the optional content group or null, if there is no such group
      • addGroup

        public void addGroup​(PDOptionalContentGroup ocg)
        Adds an optional content group (OCG).
        Parameters:
        ocg - the optional content group
      • getOptionalContentGroups

        public java.util.Collection<PDOptionalContentGroup> getOptionalContentGroups()
        Returns the collection of all optional content groups.
        Returns:
        the optional content groups
      • getGroupNames

        public java.lang.String[] getGroupNames()
        Lists all optional content group names.
        Returns:
        an array of all names
      • hasGroup

        public boolean hasGroup​(java.lang.String groupName)
        Indicates whether a particular optional content group is found in the PDF file.
        Parameters:
        groupName - the group name
        Returns:
        true if the group exists, false otherwise
      • isGroupEnabled

        public boolean isGroupEnabled​(java.lang.String groupName)
        Indicates whether at least one optional content group with this name is enabled. There may be disabled optional content groups with this name even if this function returns true.
        Parameters:
        groupName - the group name
        Returns:
        true if at least one group is enabled
      • isGroupEnabled

        public boolean isGroupEnabled​(PDOptionalContentGroup group)
        Indicates whether an optional content group is enabled.
        Parameters:
        group - the group object
        Returns:
        true if the group is enabled
      • setGroupEnabled

        public boolean setGroupEnabled​(java.lang.String groupName,
                                       boolean enable)
        Enables or disables all optional content groups with the given name.
        Parameters:
        groupName - the group name
        enable - true to enable, false to disable
        Returns:
        true if at least one group with this name already had an on or off setting, false otherwise
      • setGroupEnabled

        public boolean setGroupEnabled​(PDOptionalContentGroup group,
                                       boolean enable)
        Enables or disables an optional content group.
        Parameters:
        group - the group object
        enable - true to enable, false to disable
        Returns:
        true if the group already had an on or off setting, false otherwise