public interface

AnnotationManager

com.pspdfkit.ui.special_mode.manager.AnnotationManager
Known Indirect Subclasses

Class Overview

Interface for objects that manage a list of annotation listener instances.

Summary

Nested Classes
interface AnnotationManager.OnAnnotationCreationModeChangeListener Listener for annotation creation mode enter/exit. 
interface AnnotationManager.OnAnnotationCreationModeSettingsChangeListener Listener for annotation creation mode settings changes. 
interface AnnotationManager.OnAnnotationDeselectedListener Listener for annotation deselection. 
interface AnnotationManager.OnAnnotationEditingModeChangeListener Listener for annotation editing mode enter/exit. 
interface AnnotationManager.OnAnnotationSelectedListener Listener for annotation selection. 
Public Methods
abstract void addOnAnnotationCreationModeChangeListener(AnnotationManager.OnAnnotationCreationModeChangeListener listener)
Register a AnnotationManager.OnAnnotationCreationModeChangeListener to get notified when annotation creation mode gets updated.
abstract void addOnAnnotationCreationModeSettingsChangeListener(AnnotationManager.OnAnnotationCreationModeSettingsChangeListener listener)
Register a AnnotationManager.OnAnnotationCreationModeSettingsChangeListener to get notified when annotation creation settings get updated.
abstract void addOnAnnotationDeselectedListener(AnnotationManager.OnAnnotationDeselectedListener listener)
Register a AnnotationManager.OnAnnotationDeselectedListener to get notified when annotation gets deselected.
abstract void addOnAnnotationEditingModeChangeListener(AnnotationManager.OnAnnotationEditingModeChangeListener listener)
Register a AnnotationManager.OnAnnotationEditingModeChangeListener to get notified when annotation editing mode gets updated.
abstract void addOnAnnotationSelectedListener(AnnotationManager.OnAnnotationSelectedListener listener)
Register a AnnotationManager.OnAnnotationSelectedListener to get notified when annotation gets selected.
abstract void addOnAnnotationUpdatedListener(AnnotationProvider.OnAnnotationUpdatedListener listener)
Register a AnnotationProvider.OnAnnotationUpdatedListener to get notified when annotation gets updated.
abstract void removeOnAnnotationCreationModeChangeListener(AnnotationManager.OnAnnotationCreationModeChangeListener listener)
abstract void removeOnAnnotationCreationModeSettingsChangeListener(AnnotationManager.OnAnnotationCreationModeSettingsChangeListener listener)
abstract void removeOnAnnotationDeselectedListener(AnnotationManager.OnAnnotationDeselectedListener listener)
Remove a previously registered AnnotationManager.OnAnnotationDeselectedListener.
abstract void removeOnAnnotationEditingModeChangeListener(AnnotationManager.OnAnnotationEditingModeChangeListener listener)
abstract void removeOnAnnotationSelectedListener(AnnotationManager.OnAnnotationSelectedListener listener)
Remove a previously registered AnnotationManager.OnAnnotationSelectedListener.
abstract void removeOnAnnotationUpdatedListener(AnnotationProvider.OnAnnotationUpdatedListener listener)
Remove a previously registered AnnotationProvider.OnAnnotationUpdatedListener.

Public Methods

public abstract void addOnAnnotationCreationModeChangeListener (AnnotationManager.OnAnnotationCreationModeChangeListener listener)

Register a AnnotationManager.OnAnnotationCreationModeChangeListener to get notified when annotation creation mode gets updated. If the provider has been registered previously, this method will be a no-op.

Parameters
listener Listener to register. Must be non-null.

public abstract void addOnAnnotationCreationModeSettingsChangeListener (AnnotationManager.OnAnnotationCreationModeSettingsChangeListener listener)

Register a AnnotationManager.OnAnnotationCreationModeSettingsChangeListener to get notified when annotation creation settings get updated. If the provider has been registered previously, this method will be a no-op.

Parameters
listener Listener to register. Must be non-null.

public abstract void addOnAnnotationDeselectedListener (AnnotationManager.OnAnnotationDeselectedListener listener)

Register a AnnotationManager.OnAnnotationDeselectedListener to get notified when annotation gets deselected. If the provider has been registered previously, this method will be a no-op.

Parameters
listener Listener to register. Must be non-null.

public abstract void addOnAnnotationEditingModeChangeListener (AnnotationManager.OnAnnotationEditingModeChangeListener listener)

Register a AnnotationManager.OnAnnotationEditingModeChangeListener to get notified when annotation editing mode gets updated. If the provider has been registered previously, this method will be a no-op.

Parameters
listener Listener to register. Must be non-null.

public abstract void addOnAnnotationSelectedListener (AnnotationManager.OnAnnotationSelectedListener listener)

Register a AnnotationManager.OnAnnotationSelectedListener to get notified when annotation gets selected. If the provider has been registered previously, this method will be a no-op.

Parameters
listener Listener to register. Must be non-null.

public abstract void addOnAnnotationUpdatedListener (AnnotationProvider.OnAnnotationUpdatedListener listener)

Register a AnnotationProvider.OnAnnotationUpdatedListener to get notified when annotation gets updated. If the listener has been registered previously, this method will be a no-op.

Note: Listeners methods are dispatched on the main UI thread.

Parameters
listener Listener to register. Must be non-null.

public abstract void removeOnAnnotationCreationModeChangeListener (AnnotationManager.OnAnnotationCreationModeChangeListener listener)

Remove a previously registered AnnotationManager.OnAnnotationCreationModeChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.

public abstract void removeOnAnnotationCreationModeSettingsChangeListener (AnnotationManager.OnAnnotationCreationModeSettingsChangeListener listener)

Remove a previously registered AnnotationManager.OnAnnotationCreationModeSettingsChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.

public abstract void removeOnAnnotationDeselectedListener (AnnotationManager.OnAnnotationDeselectedListener listener)

Remove a previously registered AnnotationManager.OnAnnotationDeselectedListener. If the provider hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.

public abstract void removeOnAnnotationEditingModeChangeListener (AnnotationManager.OnAnnotationEditingModeChangeListener listener)

Remove a previously registered AnnotationManager.OnAnnotationEditingModeChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.

public abstract void removeOnAnnotationSelectedListener (AnnotationManager.OnAnnotationSelectedListener listener)

Remove a previously registered AnnotationManager.OnAnnotationSelectedListener. If the provider hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.

public abstract void removeOnAnnotationUpdatedListener (AnnotationProvider.OnAnnotationUpdatedListener listener)

Remove a previously registered AnnotationProvider.OnAnnotationUpdatedListener. If the listener hasn't been registered previously, this method will be a no-op.

Parameters
listener Listener to unregister. Must be non-null.