public class WaitingTagsManager extends Object
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 |
---|---|
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.
|
public Object assignWaitingState(TagTreePointer pointerToTag, Object associatedObj)
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.
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.
public boolean isObjectAssociatedWithWaitingTag(Object obj)
Object
.
obj
- an Object
which is to be checked if it is associated with any waiting tag. A null value is forbidden.
public boolean tryMovePointerToWaitingTag(TagTreePointer tagPointer, Object associatedObject)
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.
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.
TagTreePointer
was 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–2023 iText Group NV. All rights reserved.