Package com.itextpdf.kernel.pdf.tagutils

Class RoleMappingResolverPdf2

java.lang.Object

com.itextpdf.kernel.pdf.tagutils.RoleMappingResolverPdf2

All Implemented Interfaces:

IRoleMappingResolver

class RoleMappingResolverPdf2
extends java.lang.Object
implements IRoleMappingResolver

Field Summary

Fields

Modifier and Type	Field	Description
private PdfNamespace	currNamespace
private PdfName	currRole
private PdfNamespace	defaultNamespace

Constructor Summary

Constructors

Constructor	Description
RoleMappingResolverPdf2(java.lang.String role, PdfNamespace namespace, PdfDocument document)

Method Summary

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".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currRole

private PdfName currRole

currNamespace

private PdfNamespace currNamespace

defaultNamespace

private PdfNamespace defaultNamespace

Constructor Detail

RoleMappingResolverPdf2

RoleMappingResolverPdf2(java.lang.String role,
                        PdfNamespace namespace,
                        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 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, false otherwise

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 neither belongs to the standard structure roles, nor 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 its 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