Class RoleMappingResolverPdf2

java.lang.Object
com.itextpdf.kernel.pdf.tagutils.RoleMappingResolverPdf2
All Implemented Interfaces:
IRoleMappingResolver

class RoleMappingResolverPdf2 extends Object implements IRoleMappingResolver
  • Field Details

  • Constructor Details

  • Method Details

    • getRole

      public String getRole()
      Description copied from interface: IRoleMappingResolver
      Defines the current role of the resolver. On every successful resolving "step" the role returned by this method changes in order to reflect the mapping of the previous role.
      Specified by:
      getRole in interface IRoleMappingResolver
      Returns:
      the String which identifies current role of the resolver.
    • getNamespace

      public PdfNamespace getNamespace()
      Description copied from interface: IRoleMappingResolver
      Defines the namespace of the current role.
      Specified by:
      getNamespace in interface IRoleMappingResolver
      Returns:
      the PdfNamespace instance of the namespace dictionary wrapper. The role returned by the IRoleMappingResolver.getRole() method call is considered to belong to this namespace. Might be null, which means that role belongs to the default standard namespace.
    • currentRoleIsStandard

      public boolean currentRoleIsStandard()
      Description copied from interface: IRoleMappingResolver
      Checks if the current role belongs to one of the standard structure namespaces.
      Specified by:
      currentRoleIsStandard in interface IRoleMappingResolver
      Returns:
      true if the current namespace is a standard structure namespace and the current role is defined as standard role in it.
    • currentRoleShallBeMappedToStandard

      public boolean currentRoleShallBeMappedToStandard()
      Description copied from interface: IRoleMappingResolver
      Checks if the current role and namespace are specified to be obligatory mapped to the standard structure namespace in order to be a valid role in the Tagged PDF.
      Specified by:
      currentRoleShallBeMappedToStandard in interface IRoleMappingResolver
      Returns:
      true, if the current role in the current namespace either belongs to the standard structure roles or is in the domain specific namespace; otherwise false.
    • resolveNextMapping

      public boolean resolveNextMapping()
      Description copied from interface: IRoleMappingResolver
      Performs a mapping resolving "step". Essentially finds the role and it's namespace to which the current role is mapped to. After this method call IRoleMappingResolver.getRole() and IRoleMappingResolver.getNamespace() methods might change their return value.
      Specified by:
      resolveNextMapping in interface IRoleMappingResolver
      Returns:
      true if current role and/or namespace have changed their values; otherwise false which means that current role is not mapped.