Package com.itextpdf.layout.tagging
Class TaggingHintKey
java.lang.Object
com.itextpdf.layout.tagging.TaggingHintKey
TaggingHintKey instances are created in the scope of
RootRenderer.addChild(IRenderer)
to preserve logical order of layout elements from model elements.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate IAccessibleElement
private boolean
private boolean
private boolean
private String
private TagTreePointer
-
Constructor Summary
ConstructorsConstructorDescriptionTaggingHintKey
(IAccessibleElement elem, boolean createdElementBased) Instantiate a newTaggingHintKey
instance. -
Method Summary
Modifier and TypeMethodDescription(package private) AccessibilityProperties
Get accessible element.(package private) String
Get overridden role.Gets the TagTreePointer.(package private) boolean
Retrieve information whether this hint key is artifact or not.(package private) boolean
Retrieve information whether the element backed by this hint key implementsIElement
.(package private) boolean
Retrieve hint key finished flag.(package private) void
Specify that hint key instance corresponds to artifact.(package private) void
Set finished flag for hint key instance.(package private) void
setOverriddenRole
(String overriddenRole) Set the overridden role.void
Sets the TagTreePointer.
-
Field Details
-
elem
-
isArtifact
private boolean isArtifact -
isFinished
private boolean isFinished -
overriddenRole
-
elementBasedFinishingOnly
private boolean elementBasedFinishingOnly -
tagPointer
-
-
Constructor Details
-
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 Details
-
getAccessibleElement
Get accessible element.- Returns:
- the accessible element.
-
getTagPointer
Gets the TagTreePointer.- Returns:
- the
TagTreePointer
or null if there is no associated one yet.
-
setTagPointer
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
String getOverriddenRole()Get overridden role.- Returns:
- the overridden role.
-
setOverriddenRole
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
.
-