FluentEditorPlugin class abstract

Implementers

Constructors

FluentEditorPlugin()

Properties

apiVersion → int
no setter
commands → List<FluentCommand>
no setter
dependencies → List<FluentPluginDependency>
no setter
formats → List<FluentFormatContribution>
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasSidebar → bool
Returns true if this plugin contributes to the document sidebar.
no setter
id → String
no setter
isSuggestionMode → bool
Returns true if this plugin is currently operating in suggestion/review mode.
no setter
nodes → List<FluentNodeDefinition<FNode>>
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
styleHook → RenderStyleHook?
no setter
ui → List<FluentUiContribution>
no setter
version → String
no setter

Methods

attach(FluentPluginContext context) → void
buildSidebarItems(BuildContext context, FluentDocument document) → List<FluentSidebarItem>
Returns sidebar item entries (cards) contributed by this plugin. Libraries define how their cards appear by returning FluentSidebarItems.
detach(FluentPluginContext context) → void
isColumnResized(FluentDocument document, FluentTable table, int colIdx) → bool
Returns true if the column at colIdx in table has a pending resize suggestion.
isFormattingDisabled(FluentDocument document) → bool
Returns true if style formatting actions (bold, italic, color, font size, etc.) should be disabled on document.
isRowResized(FluentDocument document, FluentTable table, FluentRow row) → bool
Returns true if the row row in table has a pending resize suggestion.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onBackspace(FluentDocument document, {bool ctrl = false, bool lineStart = false}) → bool
Intercepts Backspace key. Return true if handled.
onColumnResize(FluentDocument document, FluentTable table, int colIdx, double oldWidth, double newWidth) → bool
Called when a table column is resized. Return true if handled.
onCommitSaveState(FluentDocument document, {SaveStateResult result = SaveStateResult.created}) → void
Called when a saveState operation is committed for the document.
onDecreaseTableColspan(FluentDocument document, FluentTable table, FluentCell cell) → bool
Intercepts decreasing table cell colspan. Return true if handled.
onDecreaseTableRowspan(FluentDocument document, FluentTable table, FluentCell cell) → bool
Intercepts decreasing table cell rowspan. Return true if handled.
onDelete(FluentDocument document, {bool ctrl = false}) → bool
Intercepts Delete key. Return true if handled.
onDeleteNode(FluentDocument document, FNode node) → bool
Intercepts deleting a node (e.g. image, HR, table). Return true if handled.
onDeleteTableColumn(FluentDocument document, FluentTable table, int index) → bool
Intercepts deleting a table column. Return true if handled.
onDeleteTableRow(FluentDocument document, FluentTable table, int index) → bool
Intercepts deleting a table row. Return true if handled.
onEnter(FluentDocument document) → bool
Intercepts Enter key (line/item split). Return true if handled.
onImeCompositionCommit(String text, FluentDocument document) → bool
Intercepts committing IME composition/preedit text. Return true if handled.
onIncreaseTableColspan(FluentDocument document, FluentTable table, FluentCell cell) → bool
Intercepts increasing table cell colspan. Return true if handled.
onIncreaseTableRowspan(FluentDocument document, FluentTable table, FluentCell cell) → bool
Intercepts increasing table cell rowspan. Return true if handled.
onInsertCharacter(String character, FluentDocument document) → bool
Intercepts character insertion. Return true if handled.
onInsertNode(FluentDocument document, String nodeType, Map<String, dynamic> options) → bool
Intercepts inserting a node (e.g. hr, image, list, table). Return true if handled.
onInsertTableColumn(FluentDocument document, FluentTable table, int index) → bool
Intercepts inserting a table column. Return true if handled.
onInsertTableRow(FluentDocument document, FluentTable table, int index) → bool
Intercepts inserting a table row. Return true if handled.
onInsertText(String text, FluentDocument document) → bool
Intercepts inserting text (single character or multi-character string from IME/paste). Return true if handled.
onLeavesStyleMutation(FluentDocument document, List<Fragment> leaves, void mutator(Fragment)) → List<Fragment>?
Intercepts an inline style mutation on a list of fragments. Return the modified/new fragments if handled, null otherwise.
onParagraphMutation(FluentDocument document, Paragraph paragraph, void mutator(Paragraph)) → bool
Intercepts a paragraph mutation. Return true if handled, false otherwise.
onRedo(FluentDocument document) → void
Called after a redo operation restores the document state.
onReplaceSelection(String character, FluentDocument document) → bool
Intercepts replacing active selection with text. Return true if handled.
onRowResize(FluentDocument document, FluentTable table, FluentRow row, double oldHeight, double newHeight) → bool
Called when a table row is resized. Return true if handled.
onSaveState(FluentDocument document, String description) → void
Called when a saveState operation begins for the document.
onStyleMutation(FluentDocument document, Fragment leaf, void mutator(Fragment)) → Fragment?
Intercepts an inline style mutation on a fragment. Return the modified/new fragment if handled, null otherwise.
onTab(FluentDocument document, {required bool isShiftPressed}) → bool
Intercepts Tab/Shift+Tab keys (indent/outdent). Return true if handled.
onTextMutation(String paragraphId, int fromOffset, int delta) → void
Called whenever document text is mutated.
onUndo(FluentDocument document) → void
Called after an undo operation restores the document state.
toString() → String
A string representation of this object.
inherited

Operators

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