parchment library

Rich text document model for Fleather editor.

Classes

AlignmentAttributeBuilder
AutoExitBlockRule
Heuristic rule to exit current block when user inserts two consecutive newlines.
BackgroundColorAttributeBuilder
Builder for background color value. Color is interpreted from the lower 32 bits of an int.
BlockAttributeBuilder
Builder for block attribute styles (number/bullet lists, code and quote).
BlockEmbed
An object which occupies an entire line in a document and cannot co-exist inline with regular text.
BlockNode
A block represents a group of adjacent LineNodes with the same block style.
CatchAllDeleteRule
Fallback rule for delete operations which simply deletes specified text range without any special handling.
CatchAllInsertRule
Fallback rule which simply inserts text as-is without any special handling.
ColorParchmentAttributeBuilder
Builder for color-based style attributes.
ContainerNode<T extends Node>
Container node can accommodate other nodes.
DeleteRule
A heuristic rule for delete operations.
DirectionAttributeBuilder
EmbeddableObject
An object which can be embedded into a Parchment document.
EmbedNode
An embed node inside of a line in a Parchment document.
EnsureEmbedLineRule
Prevents user from merging a line containing a block embed with other lines.
EnsureLastLineBreakDeleteRule
ForceNewlineForInsertsAroundBlockEmbedRule
Forces text inserted on the same line with a block embed (before or after it) to be moved to a new line adjacent to the original line.
ForegroundColorAttributeBuilder
Builder for text color value. Color is interpreted from the lower 32 bits of an int.
FormatLinkAtCaretPositionRule
Allows updating link format with collapsed selection.
FormatRule
A heuristic rule for format (retain) operations.
HeadingAttributeBuilder
Builder for heading attribute styles.
IndentAttributeBuilder
InsertBlockEmbedsRule
Handles all format operations which manipulate block embeds.
InsertRule
A heuristic rule for insert operations.
LeafNode
A leaf node in Parchment document tree.
LineNode
A line of rich text in a Parchment document.
LinkAttributeBuilder
Builder for link attribute values.
LookupResult
Result of a child lookup in a ContainerNode.
Node
An abstract node in a document tree.
ParchmentAttribute<T>
Style attribute applicable to a segment of a Parchment document.
ParchmentAttributeBuilder<T>
Builder for style attributes.
ParchmentAttributeKey<T>
Interface for objects which provide access to an attribute key.
ParchmentChange
Represents a change in a ParchmentDocument.
ParchmentDocument
A rich text document.
ParchmentHeuristics
Registry for insert, format and delete heuristic rules used by ParchmentDocument documents.
ParchmentStyle
Collection of style attributes.
PreserveBlockStyleOnInsertRule
Preserves block style when user inserts text containing newlines.
PreserveInlineStylesRule
Preserves inline styles when user inserts text inside formatted segment.
PreserveLineFormatOnNewLineRule
Preserves line format when insert occurred at the end of a line (right before a newline).
PreserveLineStyleOnMergeRule
Preserves line format when user deletes the line's newline character effectively merging it with the next line.
PreserveLineStyleOnSplitRule
Preserves line format when user splits the line into two.
ResolveInlineFormatRule
Produces Delta with inline-level attributes applied too all characters except newlines.
ResolveLineFormatRule
Produces Delta with line-level attributes applied strictly to newline characters.
RootNode
Root node of document tree.
SpanEmbed
An object which can be embedded on the same line (inline) with regular text.
TextNode
A span of formatted text within a line in a Parchment document.

Enums

ChangeSource
Source of a ParchmentChange.
ParchmentAttributeScope
Scope of a style attribute, defines context in which an attribute can be applied.

Mixins

StyledNode
Mixin used by nodes that wish to implement StyledNode interface.