Package com.itextpdf.layout.tagging

Class TaggingHintKey

  • public final class TaggingHintKey
extends java.lang.Object
    TaggingHintKey instances are created in the scope of RootRenderer.addChild(IRenderer) to preserve logical order of layout elements from model elements.

    • Field Detail

      • isArtifact

        private boolean isArtifact

      • isFinished

        private boolean isFinished

      • overriddenRole

        private java.lang.String overriddenRole

      • elementBasedFinishingOnly

        private boolean elementBasedFinishingOnly

      • isAccessible

        private final boolean isAccessible

    • Constructor Detail

      • TaggingHintKey

        TaggingHintKey​(IAccessibleElement elem,
               boolean createdElementBased)
        Instantiate a new TaggingHintKey instance.
        Parameters:
        elem - element this hint key will be created for.
        createdElementBased - true if element implements IElement.

    • Method Detail

      • getAccessibleElement

        public IAccessibleElement getAccessibleElement()
        Get accessible element.
        Returns:
        the accessible element.

      • getTagPointer

        public TagTreePointer getTagPointer()
        Gets the TagTreePointer.
        Returns:
        the TagTreePointer or null if there is no associated one yet.

      • setTagPointer

        public void setTagPointer​(TagTreePointer tag)
        Sets the TagTreePointer.
        Parameters:
        tag - the TagTreePointer to set.

      • isFinished

        boolean isFinished()
        Retrieve hint key finished flag.
        Returns:
        true if hint key is finished, false otherwise.

      • setFinished

        void setFinished()
        Set finished flag for hint key instance.

      • isArtifact

        boolean isArtifact()
        Retrieve information whether this hint key is artifact or not.
        Returns:
        true if hint key corresponds to artifact, false otherwise.

      • setArtifact

        void setArtifact()
        Specify that hint key instance corresponds to artifact.

      • getOverriddenRole

        java.lang.String getOverriddenRole()
        Get overridden role.
        Returns:
        the overridden role.

      • setOverriddenRole

        void setOverriddenRole​(java.lang.String overriddenRole)
        Set the overridden role.
        Parameters:
        overriddenRole - overridden role.

      • isElementBasedFinishingOnly

        boolean isElementBasedFinishingOnly()
        Retrieve information whether the element backed by this hint key implements IElement.
        Returns:
        true if element implements IElement.

      • isAccessible

        boolean isAccessible()