Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.graphics.optionalcontent

Class PDOptionalContentProperties

java.lang.Object
org.sejda.sambox.pdmodel.common.PDDictionaryWrapper
org.sejda.sambox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
All Implemented Interfaces:
COSObjectable
public class PDOptionalContentProperties extends PDDictionaryWrapper
This class represents the optional content properties dictionary.
Since:
PDF 1.5

  • Constructor Details

    • 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 Details

    • getGroup

      public PDOptionalContentGroup getGroup(String name)
      Returns the 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 Collection<PDOptionalContentGroup> getOptionalContentGroups()
      Returns the collection of all optional content groups.
      Returns:
      the optional content groups

    • getBaseState

      public PDOptionalContentProperties.BaseState getBaseState()
      Returns the base state for optional content groups.
      Returns:
      the base state

    • setBaseState

      public void setBaseState(PDOptionalContentProperties.BaseState state)
      Sets the base state for optional content groups.
      Parameters:
      state - the base state

    • getGroupNames

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

    • hasGroup

      public boolean hasGroup(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(String groupName)
      Indicates whether an optional content group is enabled.
      Parameters:
      groupName - the group name
      Returns:
      true if the 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(String groupName, boolean enable)
      Enables or disables an optional content group.
      Parameters:
      groupName - the group name
      enable - true to enable, false to disable
      Returns:
      true if the group 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