Package com.itextpdf.layout.tagging
Class TaggingDummyElement
- java.lang.Object
-
- com.itextpdf.layout.tagging.TaggingDummyElement
-
- All Implemented Interfaces:
IPropertyContainer
,IAccessibleElement
public class TaggingDummyElement extends java.lang.Object implements IAccessibleElement, IPropertyContainer
Instances of the class are used forTaggingHintKey
which don't have model element e.g. TR or THEAD in the table. Nobody will callLayoutTaggingHelper.finishTaggingHint(IPropertyContainer)
for them, it is why they should be handled separately.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Object
id
private DefaultAccessibilityProperties
properties
-
Constructor Summary
Constructors Constructor Description TaggingDummyElement(java.lang.String role)
Instantiate a newTaggingDummyElement
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
deleteOwnProperty(int property)
Deletes the own property of this entity.AccessibilityProperties
getAccessibilityProperties()
Gets theaccessibility properties
.<T1> T1
getDefaultProperty(int property)
Gets the default property from this entity.<T1> T1
getOwnProperty(int property)
Gets own property from this entity.<T1> T1
getProperty(int property)
Gets the property from this entity.boolean
hasOwnProperty(int property)
Checks if this entity has the specified property, i.e.boolean
hasProperty(int property)
Checks if this entity has the specified property.void
setProperty(int property, java.lang.Object value)
Sets a property for this entity.
-
-
-
Field Detail
-
properties
private DefaultAccessibilityProperties properties
-
id
private java.lang.Object id
-
-
Constructor Detail
-
TaggingDummyElement
public TaggingDummyElement(java.lang.String role)
Instantiate a newTaggingDummyElement
instance.- Parameters:
role
- the role.
-
-
Method Detail
-
getAccessibilityProperties
public AccessibilityProperties getAccessibilityProperties()
Gets theaccessibility properties
. See alsoIAccessibleElement
.- Specified by:
getAccessibilityProperties
in interfaceIAccessibleElement
- Returns:
- an interface that allows to specify properties of a tagged element in Tagged PDF.
-
getProperty
public <T1> T1 getProperty(int property)
Gets the property from this entity. Compared toIPropertyContainer.getOwnProperty(int)
, this method can check parent's properties, styles, etc, depending on the origin of the instance- Specified by:
getProperty
in interfaceIPropertyContainer
- Type Parameters:
T1
- the return type associated with the property- Parameters:
property
- the property to be retrieved- Returns:
- the value of the given property.
null
will be returned if the property value was not found
-
setProperty
public void setProperty(int property, java.lang.Object value)
Sets a property for this entity.- Specified by:
setProperty
in interfaceIPropertyContainer
- Parameters:
property
- the property to be setvalue
- the value of the property
-
hasProperty
public boolean hasProperty(int property)
Checks if this entity has the specified property. Compared toIPropertyContainer.hasOwnProperty(int)
, this method can check parent's properties, styles, etc, depending on the origin of the instance- Specified by:
hasProperty
in interfaceIPropertyContainer
- Parameters:
property
- the property to be checked- Returns:
true
if this instance has given property,false
otherwise
-
hasOwnProperty
public boolean hasOwnProperty(int property)
Checks if this entity has the specified property, i.e. if it was set to this very element earlier- Specified by:
hasOwnProperty
in interfaceIPropertyContainer
- Parameters:
property
- the property to be checked- Returns:
true
if this instance has given own property,false
otherwise
-
getOwnProperty
public <T1> T1 getOwnProperty(int property)
Gets own property from this entity. The property must have been set earlier to this entity. If the property is not found,null
will be returned.- Specified by:
getOwnProperty
in interfaceIPropertyContainer
- Type Parameters:
T1
- the return type associated with the property- Parameters:
property
- the property to be retrieved- Returns:
- the value of the given own property.
null
will be returned if the property value was not found
-
getDefaultProperty
public <T1> T1 getDefaultProperty(int property)
Gets the default property from this entity.- Specified by:
getDefaultProperty
in interfaceIPropertyContainer
- Type Parameters:
T1
- the return type associated with the property- Parameters:
property
- the property to be retrieved- Returns:
- the default property value. If the default property is not defined,
null
will be returned
-
deleteOwnProperty
public void deleteOwnProperty(int property)
Deletes the own property of this entity.- Specified by:
deleteOwnProperty
in interfaceIPropertyContainer
- Parameters:
property
- the property to be deleted
-
-