Embed class
An embed node inside of a line in a Quill document.
Embed node is a leaf node similar to Text. It represents an arbitrary piece of non-textual content embedded into a document, such as, image, horizontal rule, video, or any other object with defined structure, like a tweet, for instance.
Embed node's length is always 1
character and it is represented with
unicode object replacement character in the document text.
Any inline style can be applied to an embed, however this does not necessarily mean the embed will look according to that style. For instance, applying "bold" style to an image gives no effect, while adding a "link" to an image actually makes the image react to user's action.
- Inheritance
-
- Object
- LinkedListEntry<
Node> - Node
- Leaf
- Embed
Constructors
- Embed(Embeddable data)
Properties
- documentOffset → int
-
Offset in characters of this node in the document.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- isFirst → bool
-
Returns
true
if this node is the first node in the parent list.no setterinherited - isLast → bool
-
Returns
true
if this node is the last node in the parent list.no setterinherited - length → int
-
Length of this node in characters.
no setterinherited
-
list
→ LinkedList<
Node> ? -
The linked list containing this element.
no setterinherited
- next → Node?
-
The successor of this element in its linked list.
no setterinherited
- offset → int
-
Offset in characters of this node relative to parent node.
no setterinherited
- parent ↔ Line?
-
Current parent of this node. May be null if this node is not mounted.
getter/setter pairinherited
- previous → Node?
-
The predecessor of this element in its linked list.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- style → Style
-
no setterinherited
- value → Embeddable
-
Contents of this node, either a String if this is a Text or an
Embed if this is an BlockEmbed.
no setteroverride
Methods
-
adjust(
) → void -
Adjust this text node by merging it with adjacent nodes if they share
the same style.
inherited
-
applyAttribute(
Attribute attribute) → void -
inherited
-
applyStyle(
Style value) → void -
inherited
-
clearStyle(
) → void -
inherited
-
clone(
) → Node -
inherited
-
containsOffset(
int offset) → bool -
Returns
true
if this node contains character at specifiedoffset
in the document.inherited -
cutAt(
int index) → Leaf? -
Cuts a leaf from
index
to the end of this node and returns new node in detached state (e.g.mounted
returnsfalse
).inherited -
delete(
int index, int? len) → void -
inherited
-
format(
Style? style) → void -
Formats this node and optimizes it with adjacent leaf nodes if needed.
inherited
-
insert(
int index, Object data, Style? style) → void -
inherited
-
insertAfter(
Node entry) → void -
Insert an element after this element in this element's linked list.
inherited
-
insertBefore(
Node entry) → void -
Insert an element before this element in this element's linked list.
inherited
-
newInstance(
) → Node -
abstract methods begin
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retain(
int index, int? len, Style? style) → void -
inherited
-
splitAt(
int index) → Leaf? -
Splits this leaf node at
index
and returns new node.inherited -
toDelta(
) → Delta -
inherited
-
toPlainText(
) → String -
override
-
toString(
) → String -
A string representation of this object.
override
-
unlink(
) → void -
Unlink the element from its linked list.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- kObjectReplacementCharacter → const String
- kObjectReplacementInt → const int