com.itextpdf.kernel.pdf.tagutils

Class WaitingTagsManager

java.lang.Object

com.itextpdf.kernel.pdf.tagutils.WaitingTagsManager

public class WaitingTagsManager
extends Object

This class is used to manage waiting tags state. Any tag in the structure tree could be marked as "waiting". This state indicates that tag is not yet finished and therefore should not be flushed or removed if page tags are flushed or removed or if parent tags are flushed.

Waiting state of tags is defined by the association with arbitrary objects instances.

Waiting state could also be perceived as a temporal association of the object to some particular tag.

Method Summary

Modifier and Type	Method and Description
Object	assignWaitingState(TagTreePointer pointerToTag, Object associatedObj) Assigns waiting state to the tag at which given TagTreePointer points, associating it with the given Object.
boolean	isObjectAssociatedWithWaitingTag(Object obj) Checks if there is waiting tag which state was assigned using given Object.
void	removeAllWaitingStates() Removes waiting state of all waiting tags by removing association with objects.
boolean	removeWaitingState(Object associatedObject) Removes waiting state of the tag which is associated with the given object.
boolean	tryMovePointerToWaitingTag(TagTreePointer tagPointer, Object associatedObject) Moves given TagTreePointer to the waiting tag which is associated with the given object.

Methods inherited from class java.lang.Object

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

Method Detail

assignWaitingState

public Object assignWaitingState(TagTreePointer pointerToTag,
                                 Object associatedObj)

Assigns waiting state to the tag at which given TagTreePointer points, associating it with the given Object. If current tag of the given TagTreePointer is already waiting, then after this method call it's associated object will change to the one passed as the argument and the old one will not longer be an associated object.

Parameters:

pointerToTag - a TagTreePointer pointing at a tag which is desired to be marked as waiting.

associatedObj - an object that is to be associated with the waiting tag. A null value is forbidden.

Returns:

the previous associated object with the tag if it has already had waiting state, or null if it was not waiting tag.

isObjectAssociatedWithWaitingTag

public boolean isObjectAssociatedWithWaitingTag(Object obj)

Checks if there is waiting tag which state was assigned using given Object.

Parameters:

obj - an Object which is to be checked if it is associated with any waiting tag. A null value is forbidden.

Returns:

true if object is currently associated with some waiting tag.

tryMovePointerToWaitingTag

public boolean tryMovePointerToWaitingTag(TagTreePointer tagPointer,
                                          Object associatedObject)

Moves given TagTreePointer to the waiting tag which is associated with the given object. If the passed object is not associated with any waiting tag, TagTreePointer position won't change.

Parameters:

tagPointer - a TagTreePointer which position in the tree is to be changed to the waiting tag in case of the successful call.

associatedObject - an object which is associated with the waiting tag to which TagTreePointer is to be moved.

Returns:

true if given object is actually associated with the waiting tag and TagTreePointer was moved in order to point at it.

removeWaitingState

public boolean removeWaitingState(Object associatedObject)

Removes waiting state of the tag which is associated with the given object.

NOTE: if parent of the waiting tag is already flushed, the tag and it's children (unless they are waiting tags on their own) will be also immediately flushed right after the waiting state removal.

Parameters:

associatedObject - an object which association with the waiting tag is to be removed.

Returns:

true if object was actually associated with some tag and it's association was removed.

removeAllWaitingStates

public void removeAllWaitingStates()

Removes waiting state of all waiting tags by removing association with objects.

NOTE: if parent of the waiting tag is already flushed, the tag and it's children will be also immediately flushed right after the waiting state removal.