Guides

Content Editor

The ComPDF Flutter SDK supports content editor callbacks and listener events for style panels and editable content selection.

Available Callbacks and Events

Type	Name	Trigger Timing	Payload
Reader callback	onContentEditorStyleDialogDismissedCallback	Content editor style dialog is dismissed	CPDFEditAreaType type
Listener event	CPDFEvent.editorSelectionSelected	Editable content is selected	CPDFEditArea
Listener event	CPDFEvent.editorSelectionDeselected	Editable content is deselected	CPDFEditArea?

Example Usage

late CPDFReaderWidgetController readerController;

void onEditorSelectionSelected(dynamic editArea) {
  debugPrint('Content editor selected: $editArea');
}

void onEditorSelectionDeselected(dynamic editArea) {
  debugPrint('Content editor deselected: $editArea');
}

CPDFReaderWidget(
  document: documentPath,
  configuration: configuration,
  onCreated: (controller) {
    readerController = controller;
    readerController.addEventListener(
      CPDFEvent.editorSelectionSelected,
      onEditorSelectionSelected,
    );
    readerController.addEventListener(
      CPDFEvent.editorSelectionDeselected,
      onEditorSelectionDeselected,
    );
  },
  onContentEditorStyleDialogDismissedCallback: (CPDFEditAreaType type) {
    debugPrint('Content editor style dialog dismissed: ${type.name}');
  },
);

CPDFEvent.editorSelectionSelected returns CPDFEditArea and its subclasses, such as CPDFEditTextArea, CPDFEditImageArea, and CPDFEditPathArea. CPDFEvent.editorSelectionDeselected may return null.

Remove Event Listeners

readerController.removeEventListener(
  CPDFEvent.editorSelectionSelected,
  onEditorSelectionSelected,
);