AnnotationEditingController
implements FragmentSpecialModeController| com.pspdfkit.ui.special_mode.controller.AnnotationEditingController |
Class Overview
Default controller given when entering annotation editing mode. Used to control annotation editing mode actions.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract void |
bindAnnotationInspectorController(AnnotationInspectorController annotationInspectorController)
Binds to the annotation inspector controller for managing annotation inspector.
| ||||||||||
| abstract void |
deleteCurrentlySelectedAnnotation()
Deletes currently selected annotation from the document.
| ||||||||||
| abstract void |
enterAudioPlaybackMode()
Starts playback mode for the currently selected sound annotation.
| ||||||||||
| abstract void |
enterAudioRecordingMode()
Starts recording mode for the currently selected sound annotation.
| ||||||||||
| abstract AnnotationManager |
getAnnotationManager()
Returns an annotation manager which you can use to register listeners from the controller.
| ||||||||||
| abstract PdfConfiguration |
getConfiguration()
Returns an active configuration.
| ||||||||||
| abstract Annotation |
getCurrentlySelectedAnnotation()
Returns currently edited annotation (if any).
| ||||||||||
| abstract void |
recordAnnotationZIndexEdit(Annotation annotation, int oldZIndex, int newZIndex)
Records the z-index being changed on the specified annotation.
| ||||||||||
| abstract void |
saveCurrentlySelectedAnnotation()
Saves currently selected annotation to the document.
| ||||||||||
| abstract boolean |
shouldDisplayPicker()
Whether annotation inspector toolbar icon should be visible.
| ||||||||||
| abstract boolean |
shouldDisplayPlayAudioButton()
Whether play button should be displayed for the selected sound annotation.
| ||||||||||
| abstract boolean |
shouldDisplayRecordAudioButton()
Whether record button should be displayed for the selected sound annotation.
| ||||||||||
| abstract void |
showAnnotationEditor(Annotation annotation)
Shows annotation editor for the passed annotation.
| ||||||||||
| abstract void |
showEditedAnnotationPositionOnThePage(int pageIndex)
Temporarily hides the selected/edited annotation view and shows its relative position on the
page.
| ||||||||||
| abstract void |
startRecording()
Starts recording the edits.
| ||||||||||
| abstract void |
stopRecording()
Stops recording the edits, notifies the result and clears current record, so calling
startRecording() will start from clean state. | ||||||||||
| abstract void |
toggleAnnotationInspector()
Displays/hides an annotation inspector for the selected annotation.
| ||||||||||
| abstract void |
unbindAnnotationInspectorController()
Unbinds from previously bound annotation inspector controller.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.pspdfkit.ui.special_mode.controller.base.FragmentSpecialModeController
| |||||||||||
|
From interface
com.pspdfkit.ui.special_mode.controller.base.SpecialModeController
| |||||||||||
Public Methods
public abstract void bindAnnotationInspectorController (AnnotationInspectorController annotationInspectorController)
Binds to the annotation inspector controller for managing annotation inspector.
Parameters
| annotationInspectorController | Controller for managing annotation inspector. |
|---|
public abstract void deleteCurrentlySelectedAnnotation ()
Deletes currently selected annotation from the document.
public abstract void enterAudioPlaybackMode ()
Starts playback mode for the currently selected sound annotation.
public abstract void enterAudioRecordingMode ()
Starts recording mode for the currently selected sound annotation.
public abstract AnnotationManager getAnnotationManager ()
Returns an annotation manager which you can use to register listeners from the controller.
Returns
- Annotation manager managing the annotation editing listeners.
public abstract PdfConfiguration getConfiguration ()
Returns an active configuration.
Returns
- Current configuration.
public abstract Annotation getCurrentlySelectedAnnotation ()
Returns currently edited annotation (if any).
Returns
- Currently edited annotation,
nullif none currently edited.
public abstract void recordAnnotationZIndexEdit (Annotation annotation, int oldZIndex, int newZIndex)
Records the z-index being changed on the specified annotation.
Parameters
| annotation | Annotation being reordered. |
|---|---|
| oldZIndex | Old z-index of the annotation. |
| newZIndex | New z-index of the annotation. |
public abstract void saveCurrentlySelectedAnnotation ()
Saves currently selected annotation to the document.
public abstract boolean shouldDisplayPicker ()
Whether annotation inspector toolbar icon should be visible.
public abstract boolean shouldDisplayPlayAudioButton ()
Whether play button should be displayed for the selected sound annotation.
public abstract boolean shouldDisplayRecordAudioButton ()
Whether record button should be displayed for the selected sound annotation.
public abstract void showAnnotationEditor (Annotation annotation)
Shows annotation editor for the passed annotation.
Parameters
| annotation | Annotation for which to show the editor. |
|---|
public abstract void showEditedAnnotationPositionOnThePage (int pageIndex)
Temporarily hides the selected/edited annotation view and shows its relative position on the page.
Parameters
| pageIndex | A page on which to temporarily hide the selected annotation views. |
|---|
public abstract void startRecording ()
Starts recording the edits.
public abstract void stopRecording ()
Stops recording the edits, notifies the result and clears current record, so calling startRecording() will start from clean state.
public abstract void toggleAnnotationInspector ()
Displays/hides an annotation inspector for the selected annotation.
public abstract void unbindAnnotationInspectorController ()
Unbinds from previously bound annotation inspector controller.