Package com.itextpdf.layout.tagging
Class TaggingHintKey
- java.lang.Object
-
- com.itextpdf.layout.tagging.TaggingHintKey
-
public final class TaggingHintKey extends java.lang.Object
TaggingHintKey instances are created in the scope ofRootRenderer.addChild(IRenderer)
to preserve logical order of layout elements from model elements.
-
-
Field Summary
Fields Modifier and Type Field Description private IAccessibleElement
elem
private boolean
elementBasedFinishingOnly
private boolean
isAccessible
private boolean
isArtifact
private boolean
isFinished
private java.lang.String
overriddenRole
private TagTreePointer
tagPointer
-
Constructor Summary
Constructors Constructor Description TaggingHintKey(IAccessibleElement elem, boolean createdElementBased)
Instantiate a newTaggingHintKey
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) AccessibilityProperties
getAccessibilityProperties()
IAccessibleElement
getAccessibleElement()
Get accessible element.(package private) java.lang.String
getOverriddenRole()
Get overridden role.TagTreePointer
getTagPointer()
Gets the TagTreePointer.(package private) boolean
isAccessible()
(package private) boolean
isArtifact()
Retrieve information whether this hint key is artifact or not.(package private) boolean
isElementBasedFinishingOnly()
Retrieve information whether the element backed by this hint key implementsIElement
.(package private) boolean
isFinished()
Retrieve hint key finished flag.(package private) void
setArtifact()
Specify that hint key instance corresponds to artifact.(package private) void
setFinished()
Set finished flag for hint key instance.(package private) void
setOverriddenRole(java.lang.String overriddenRole)
Set the overridden role.void
setTagPointer(TagTreePointer tag)
Sets the TagTreePointer.
-
-
-
Field Detail
-
elem
private IAccessibleElement elem
-
isArtifact
private boolean isArtifact
-
isFinished
private boolean isFinished
-
overriddenRole
private java.lang.String overriddenRole
-
elementBasedFinishingOnly
private boolean elementBasedFinishingOnly
-
tagPointer
private TagTreePointer tagPointer
-
isAccessible
private final boolean isAccessible
-
-
Constructor Detail
-
TaggingHintKey
TaggingHintKey(IAccessibleElement elem, boolean createdElementBased)
Instantiate a newTaggingHintKey
instance.- Parameters:
elem
- element this hint key will be created for.createdElementBased
-true
if element implementsIElement
.
-
-
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.
-
getAccessibilityProperties
AccessibilityProperties getAccessibilityProperties()
-
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 implementsIElement
.- Returns:
- true if element implements
IElement
.
-
isAccessible
boolean isAccessible()
-
-