Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(doc): EditorState

Browse Source
This commit is contained in:
Vincent Chan 2022-08-12 14:07:21 +08:00
parent 76a317a9fb
commit 7d6f872fed
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
frontend/app_flowy/packages/flowy_editor/lib/src/editor_state.dart
View File

@ -2,7 +2,6 @@ import 'dart:async';
import 'package:flowy_editor/src/service/service.dart';
import 'package:flutter/material.dart';
import 'package:flowy_editor/src/document/node.dart';
import 'package:flowy_editor/src/document/selection.dart';
import 'package:flowy_editor/src/document/state_tree.dart';
import 'package:flowy_editor/src/operation/operation.dart';
@ -35,6 +34,14 @@ enum CursorUpdateReason {
/// [EditorState] also includes the services of the editor:
/// - Selection service
/// - Scroll service
/// - Keyboard service
/// - Input service
/// - Toolbar service
///
/// In consideration of collaborative editing.
/// All the mutations should be applied through [Transaction].
///
/// Mutating the document with document's API is not recommended.
class EditorState {
final StateTree document;
@ -48,7 +55,6 @@ class EditorState {
return _cursorSelection;
}
/// add the set reason in the future, don't use setter
updateCursorSelection(Selection? cursorSelection,
[CursorUpdateReason reason = CursorUpdateReason.others]) {
// broadcast to other users here
@ -66,8 +72,13 @@ class EditorState {
undoManager.state = this;
}
/// Apply the transaction to the state.
///
/// The options can be used to determine whether the editor
/// should record the transaction in undo/redo stack.
apply(Transaction transaction,
[ApplyOptions options = const ApplyOptions()]) {
// TODO: validate the transation.
for (final op in transaction.operations) {
_applyOperation(op);
}

6
frontend/app_flowy/packages/flowy_editor/lib/src/undo_manager.dart
View File

@ -18,6 +18,11 @@ class HistoryItem extends LinkedListEntry<HistoryItem> {
HistoryItem();
/// Seal the history item.
/// When an item is sealed, no more operations can be added
/// to the item.
///
/// The caller should create a new [HistoryItem].
seal() {
_sealed = true;
}
@ -32,6 +37,7 @@ class HistoryItem extends LinkedListEntry<HistoryItem> {
operations.addAll(iterable);
}
/// Create a new [Transaction] by inverting the operations.
Transaction toTransaction(EditorState state) {
final builder = TransactionBuilder(state);
for (var i = operations.length - 1; i >= 0; i--) {