ListItemNode class - super_editor library

Constructors

ListItemNode({required String id, required ListItemType itemType, required AttributedText text, Map<String, dynamic>? metadata, int indent = 0})
ListItemNode.ordered({required String id, required AttributedText text, Map<String, dynamic>? metadata, int indent = 0})
ListItemNode.unordered({required String id, required AttributedText text, Map<String, dynamic>? metadata, int indent = 0})

Properties

asListItem → ListItemNode: Available on DocumentNode, provided by the ListItemNodeType extension

no setter
asTask → TaskNode: Available on DocumentNode, provided by the TaskNodeType extension

no setter
asTextNode → TextNode: Available on DocumentNode, provided by the TextNodeExtensions extension

no setter
beginningPosition → TextNodePosition: Returns the NodePosition that corresponds to the beginning of content in this node.
no setterinherited
endPosition → TextNodePosition: Returns the NodePosition that corresponds to the end of the content in this node.
no setterinherited
hashCode → int: The hash code for this object.
no setteroverride
id → String: ID that is unique within a Document.
finalinherited
indent → int: final
isDeletable → bool: no setterinherited
metadata → Map<String, dynamic>: Returns all metadata attached to this DocumentNode.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
text → AttributedText: The content text within this TextNode.
finalinherited
type → ListItemType: final

Methods

computeSelection({required NodePosition base, required NodePosition extent}) → TextNodeSelection: Returns a node-specific representation of a selection from base to extent.
inherited
containsPosition(Object position) → bool: Returns true if this DocumentNode contains the given position, or false if the position doesn't sit within this node, or if the position type doesn't apply to this DocumentNode.
inherited
copy() → ListItemNode: override
copyAndReplaceMetadata(Map<String, dynamic> newMetadata) → ListItemNode: Returns a copy of this DocumentNode, replacing its existing metadata with newMetadata.
override
copyContent(dynamic selection) → String: Returns a plain-text version of the content in this node within selection, or null if the given selection does not make sense as plain-text.
inherited
copyListItemWith({String? id, ListItemType? itemType, AttributedText? text, int? indent, Map<String, dynamic>? metadata}) → ListItemNode
copyMetadata() → Map<String, dynamic>: Returns a copy of this node's metadata.
inherited
copyTextNodeWith({String? id, AttributedText? text, Map<String, dynamic>? metadata}) → ListItemNode: override
copyWithAddedMetadata(Map<String, dynamic> newProperties) → ListItemNode: Returns a copy of this DocumentNode with newProperties added to the node's metadata.
override
getAffinityBetween({required NodePosition base, required NodePosition extent}) → TextAffinity: Available on DocumentNode, provided by the InspectNodeAffinity extension
Returns the affinity direction implied by the given base and extent.
getMetadataValue(String key) → dynamic: Returns this node's metadata value for the given key.
inherited
hasEquivalentContent(DocumentNode other) → bool: Returns true if the other node is the same type as this node, and contains the same content.
override
hasMetadataValue(String key) → bool: Returns true if this node has a non-null metadata value for the given metadata key, and returns false, otherwise.
inherited
initAddToMetadata(Map<String, dynamic> addedMetadata) → void: Adds addedMetadata to this nodes metadata.
inherited
isPositionCloserToEnd(NodePosition position) → bool: Returns true if the given position is closer to the end of this node's content than it is to the end.
inherited
isPositionCloserToStart(NodePosition position) → bool: Returns true if the given position is closer to the start of this node's content than it is to the end.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
positionAt(int index) → DocumentPosition: Returns a DocumentPosition within this TextNode at the given text index.
inherited
rangeBetween(int startIndex, int endIndex) → DocumentRange: Returns a DocumentRange within this TextNode between startIndex and endIndex.
inherited
selectDownstreamPosition(NodePosition position1, NodePosition position2) → NodePosition: Inspects position1 and position2 and returns the one that's positioned further downstream in this DocumentNode.
inherited
selectionAt(int collapsedIndex) → DocumentSelection: Returns a collapsed DocumentSelection, positioned within this TextNode at the given collapsedIndex.
inherited
selectionBetween(int startIndex, int endIndex) → DocumentSelection: Returns a DocumentSelection within this TextNode from startIndex to endIndex.
inherited
selectUpstreamPosition(NodePosition position1, NodePosition position2) → NodePosition: Inspects position1 and position2 and returns the one that's positioned further upstream in this DocumentNode.
inherited
toHtml(Document document, InlineHtmlSerializerChain inlineSerializers, {int? start, int? end}) → String: Available on ListItemNode, provided by the ListItemNodeToHtml extension
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
override