Package com.itextpdf.kernel.pdf.tagutils
Class RoleMappingResolver
- java.lang.Object
-
- com.itextpdf.kernel.pdf.tagutils.RoleMappingResolver
-
- All Implemented Interfaces:
IRoleMappingResolver
class RoleMappingResolver extends java.lang.Object implements IRoleMappingResolver
-
-
Field Summary
Fields Modifier and Type Field Description private PdfName
currRole
private PdfDictionary
roleMap
-
Constructor Summary
Constructors Constructor Description RoleMappingResolver(java.lang.String role, PdfDocument document)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
currentRoleIsStandard()
Checks if the current role belongs to one of the standard structure namespaces.boolean
currentRoleShallBeMappedToStandard()
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.PdfNamespace
getNamespace()
Defines the namespace of the current role.java.lang.String
getRole()
Defines the current role of the resolver.boolean
resolveNextMapping()
Performs a mapping resolving "step".
-
-
-
Field Detail
-
currRole
private PdfName currRole
-
roleMap
private PdfDictionary roleMap
-
-
Constructor Detail
-
RoleMappingResolver
RoleMappingResolver(java.lang.String role, PdfDocument document)
-
-
Method Detail
-
getRole
public java.lang.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 interfaceIRoleMappingResolver
- 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 interfaceIRoleMappingResolver
- Returns:
- the
PdfNamespace
instance of the namespace dictionary wrapper. The role returned by theIRoleMappingResolver.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 interfaceIRoleMappingResolver
- 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 interfaceIRoleMappingResolver
- 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 callIRoleMappingResolver.getRole()
andIRoleMappingResolver.getNamespace()
methods might change their return value.- Specified by:
resolveNextMapping
in interfaceIRoleMappingResolver
- Returns:
- true if current role and/or namespace have changed their values; otherwise false which means that current role is not mapped.
-
-