com.itextpdf.layout.tagging

Class TaggingDummyElement

java.lang.Object

com.itextpdf.layout.tagging.TaggingDummyElement

All Implemented Interfaces:

IPropertyContainer, IAccessibleElement

public class TaggingDummyElement
extends Object
implements IAccessibleElement, IPropertyContainer

Instances of the class are used for TaggingHintKey which don't have model element e.g. TR or THEAD in the table. Nobody will call LayoutTaggingHelper.finishTaggingHint(IPropertyContainer) for them, it is why they should be handled separately.

Constructor Summary

Constructors

Constructor and Description
TaggingDummyElement(String role) Instantiate a new TaggingDummyElement instance.

Method Summary

Modifier and Type	Method and Description
void	deleteOwnProperty(int property) Deletes the own property of this entity.
AccessibilityProperties	getAccessibilityProperties() Gets the accessibility 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, Object value) Sets a property for this entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaggingDummyElement

public TaggingDummyElement(String role)

Instantiate a new TaggingDummyElement instance.

Parameters:

role - the role.

Method Detail

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Gets the accessibility properties. See also IAccessibleElement.

Specified by:

getAccessibilityProperties in interface IAccessibleElement

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 to IPropertyContainer.getOwnProperty(int), this method can check parent's properties, styles, etc, depending on the origin of the instance

Specified by:

getProperty in interface IPropertyContainer

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,
                        Object value)

Sets a property for this entity.

Specified by:

setProperty in interface IPropertyContainer

Parameters:

property - the property to be set

value - the value of the property

hasProperty

public boolean hasProperty(int property)

Checks if this entity has the specified property. Compared to IPropertyContainer.hasOwnProperty(int), this method can check parent's properties, styles, etc, depending on the origin of the instance

Specified by:

hasProperty in interface IPropertyContainer

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 interface IPropertyContainer

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 interface IPropertyContainer

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 interface IPropertyContainer

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 interface IPropertyContainer

Parameters:

property - the property to be deleted