DOMTreeMap<T extends Object> class

Represents a mapping tree. Can be used to map a DOMNode to a generated node T, or a node T to a DOMNode.

Implemented types

Constructors

DOMTreeMap(DOMGenerator<T> domGenerator)

Properties

domGenerator → DOMGenerator<T>
final
hashCode → int
The hash code for this object.
no setterinherited
isDisposed → bool
no setter
purgeCount → int
no setter
rootDOMNode → DOMNode?
The root DOMNode of this tree.
no setter
rootElement → T?
The root element T of this tree.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

asMappedDOMNode(DOMNode? domNode) → DOMNode?
Returns domNode or recursively a domNode.parent that is mapped.
asMappedElement(T? element) → T?
Returns element or recursively a element.parent that is mapped.
cancelAllSubscriptions({bool elementsSubscriptions = true}) → void
Cancels all active subscriptions related to this component tree.
cancelSubscriptions(T node) → FutureOr<List<Object>>
Cancels and removes all subscriptions registered for node.
closeDOMElementsEventHandlers() → void
dispose({bool cancelSubscriptions = true, bool disposeEventHandlers = true, bool disposeDSXs = true}) → void
disposeDSX(DSX<Object> dsx) → bool
override
disposeManagedDSXs() → int
override
domElementsWithEventListener() → List<DOMElement>
Returns all mapped DOMElement that currently have event listeners.
duplicateByDOMNode(DOMNode? domNode) → DOMNodeMapping<T>?
Duplicates domNode in the parent children list. Also performs on mapped element.
duplicateByElement(T? element) → DOMNodeMapping<T>?
Duplicates element in the parent children list. Also performs on mapped DOMNode.
elementsWithSubscriptions() → List<T>
Returns elements from the subscriptions map that still have active subscriptions. See mapSubscriptions.
emptyByDOMNode(DOMNode? domNode) → bool
Empties domNode children nodes. Also performs on mapped element.
emptyByElement(T? element) → bool
Empties element children nodes. Also performs on mapped DOMNode.
equalsNodes(T? node1, T? node2) → bool
Returns true if node1 and node2 are the same instance.
generate(DOMGenerator<T> domGenerator, DOMNode root, {T? parent, DOMContext<T>? context, bool setTreeMapRoot = true}) → T?
Alias to DOMGenerator.generate.
getMappedDOMNode(T? element, {bool checkParents = false}) → DOMNode?
Returns the mapped DOMNode associated with element.
getMappedElement(DOMNode? domNode, {bool checkParents = false}) → T?
Returns the mapped element T associated with domNode.
getRuntimeNode(DOMNode? domNode) → DOMNodeRuntime<T>?
Returns a DOMNodeRuntime of domNode.
getSubscriptions(T node) → List<Object>
Returns the subscriptions registered for node, or an empty list if none exist.
isManagedDSX(DSX<Object> dsx) → bool
override
isMappedDOMNode(DOMNode? domNode) → bool
Returns true if domNode is mapped by this instance.
isMappedElement(T? element) → bool
Returns true if element is mapped by this instance.
manageDOMElementDSXs(DOMElement domNode) → void
manageDSX(DSX<Object> dsx) → bool
override
map(DOMNode domNode, T element, {DOMGenerator<T>? generator, DOMContext<T>? context, bool allowOverwrite = false}) → void
Maps in this instance the pair domNode and element.
mapSubscriptions(T node, List<Object> subscriptions) → void
Registers subscriptions associated with node for later cancellation. See cancelSubscriptions.
mapTree(DOMNode domRoot, T root, {DOMGenerator<T>? generator, DOMContext<T>? context}) → bool
Maps a DOM subtree starting at domRoot to the component tree rooted at root. Returns true if the mapping was created or updated.
matchesMapping(DOMNode domNode, T node) → bool
Returns true if the mapping for domNode matches node.
mergeNearNodes(DOMNode domNode1, DOMNode domNode2, {bool onlyCompatibles = false}) → DOMNodeMapping<T>?
mergeNearStringNodes(DOMNode domNode1, DOMNode domNode2, {bool onlyCompatibles = false}) → DOMNodeMapping<T>?
moveDownByDOMNode(DOMNode? domNode) → bool
Moves domNode down in the parent children list. Also performs on mapped element.
moveDownByElement(T? element) → bool
Moves element down in the parent children list. Also performs on mapped DOMNode.
moveUpByDOMNode(DOMNode? domNode) → bool
Moves domNode up in the parent children list. Also performs on mapped element.
moveUpByElement(T? element) → bool
Moves element up in the parent children list. Also performs on mapped DOMNode.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
purge() → void
queryElement(String query) → DOMNode?
queryElementAsHTML(String query, {DOMContext<Object>? domContext, bool buildTemplates = false, DSXResolution dsxResolution = DSXResolution.skipDSX}) → String?
removeByDOMNode(DOMNode? domNode) → DOMNodeMapping<T>?
Removes domNode from parent. Also performs on mapped element.
removeByElement(T? element) → DOMNodeMapping<T>?
Removes element from parent. Also performs on mapped DOMNode.
setRoot(DOMNode rootDOMNode, T? rootElement) → void
toString() → String
A string representation of this object.
override
unmap(DOMNode domNode, T element) → bool
Unmap from this instance the pair domNode and element.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

regexpTagClose → RegExp
final
regexpTagOpen → RegExp
final
regexpTagRef → RegExp
final

Static Methods

getElementDOMTreeMap<T extends Object>(T? element) → DOMTreeMap<T>?
Returns the DOMTreeMap of the element, if it's associated with some DOMElement.