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.
|Modifier and Type||Method and Description|
Checks if there is waiting tag which state was assigned using given
Removes waiting state of all waiting tags by removing association with objects.
Removes waiting state of the tag which is associated with the given object.
public Object assignWaitingState(TagTreePointer pointerToTag, Object associatedObj)
TagTreePointerpoints, associating it with the given
Object. If current tag of the given
TagTreePointeris 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.
TagTreePointerpointing 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.
public boolean isObjectAssociatedWithWaitingTag(Object obj)
Objectwhich is to be checked if it is associated with any waiting tag. A null value is forbidden.
public boolean tryMovePointerToWaitingTag(TagTreePointer tagPointer, Object associatedObject)
TagTreePointerto the waiting tag which is associated with the given object. If the passed object is not associated with any waiting tag,
TagTreePointerposition won't change.
TagTreePointerwhich 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
TagTreePointeris to be moved.
TagTreePointerwas moved in order to point at it.
public boolean removeWaitingState(Object associatedObject)
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.
associatedObject- an object which association with the waiting tag is to be removed.
public void removeAllWaitingStates()
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.
Copyright © 1998–2018 iText Group NV. All rights reserved.